Package software.amazon.awscdk.services.codedeploy

Class EcsDeploymentGroup.Builder

java.lang.Object
software.amazon.awscdk.services.codedeploy.EcsDeploymentGroup.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<EcsDeploymentGroup>
Enclosing class:
EcsDeploymentGroup
@Stability(Stable) public static final class EcsDeploymentGroup.Builder extends Object implements software.amazon.jsii.Builder<EcsDeploymentGroup>
A fluent builder for EcsDeploymentGroup.

  • Method Details

    • create

      @Stability(Stable) public static EcsDeploymentGroup.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of EcsDeploymentGroup.Builder.

    • blueGreenDeploymentConfig

      @Stability(Stable) public EcsDeploymentGroup.Builder blueGreenDeploymentConfig(EcsBlueGreenDeploymentConfig blueGreenDeploymentConfig)
      The configuration options for blue-green ECS deployments.

      Parameters:
      blueGreenDeploymentConfig - The configuration options for blue-green ECS deployments. This parameter is required.
      Returns:
      this

    • service

      @Stability(Stable) public EcsDeploymentGroup.Builder service(IBaseService service)
      The ECS service to deploy with this Deployment Group.

      Parameters:
      service - The ECS service to deploy with this Deployment Group. This parameter is required.
      Returns:
      this

    • alarms

      @Stability(Stable) public EcsDeploymentGroup.Builder alarms(List<? extends IAlarm> alarms)
      The CloudWatch alarms associated with this Deployment Group.

      CodeDeploy will stop (and optionally roll back) a deployment if during it any of the alarms trigger.

      Alarms can also be added after the Deployment Group is created using the #addAlarm method.

      Default: []

      Parameters:
      alarms - The CloudWatch alarms associated with this Deployment Group. This parameter is required.
      Returns:
      this
      See Also:

    • application

      @Stability(Stable) public EcsDeploymentGroup.Builder application(IEcsApplication application)
      The reference to the CodeDeploy ECS Application that this Deployment Group belongs to.

      Default: One will be created for you.

      Parameters:
      application - The reference to the CodeDeploy ECS Application that this Deployment Group belongs to. This parameter is required.
      Returns:
      this

    • autoRollback

      @Stability(Stable) public EcsDeploymentGroup.Builder autoRollback(AutoRollbackConfig autoRollback)
      The auto-rollback configuration for this Deployment Group.

      Default: - default AutoRollbackConfig.

      Parameters:
      autoRollback - The auto-rollback configuration for this Deployment Group. This parameter is required.
      Returns:
      this

    • deploymentConfig

      @Stability(Stable) public EcsDeploymentGroup.Builder deploymentConfig(IEcsDeploymentConfig deploymentConfig)
      The Deployment Configuration this Deployment Group uses.

      Default: EcsDeploymentConfig.ALL_AT_ONCE

      Parameters:
      deploymentConfig - The Deployment Configuration this Deployment Group uses. This parameter is required.
      Returns:
      this

    • deploymentGroupName

      @Stability(Stable) public EcsDeploymentGroup.Builder deploymentGroupName(String deploymentGroupName)
      The physical, human-readable name of the CodeDeploy Deployment Group.

      Default: An auto-generated name will be used.

      Parameters:
      deploymentGroupName - The physical, human-readable name of the CodeDeploy Deployment Group. This parameter is required.
      Returns:
      this

    • ignoreAlarmConfiguration

      @Stability(Stable) public EcsDeploymentGroup.Builder ignoreAlarmConfiguration(Boolean ignoreAlarmConfiguration)
      Whether to skip the step of checking CloudWatch alarms during the deployment process.

      Default: - false

      Parameters:
      ignoreAlarmConfiguration - Whether to skip the step of checking CloudWatch alarms during the deployment process. This parameter is required.
      Returns:
      this

    • ignorePollAlarmsFailure

      @Stability(Stable) public EcsDeploymentGroup.Builder ignorePollAlarmsFailure(Boolean ignorePollAlarmsFailure)
      Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

      Default: false

      Parameters:
      ignorePollAlarmsFailure - Whether to continue a deployment even if fetching the alarm status from CloudWatch failed. This parameter is required.
      Returns:
      this

    • role

      @Stability(Stable) public EcsDeploymentGroup.Builder role(IRole role)
      The service Role of this Deployment Group.

      Default: - A new Role will be created.

      Parameters:
      role - The service Role of this Deployment Group. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public EcsDeploymentGroup build()
      Specified by:
      build in interface software.amazon.jsii.Builder<EcsDeploymentGroup>
      Returns:
      a newly built instance of EcsDeploymentGroup.