Package software.amazon.awscdk.services.codedeploy

Interface EcsDeploymentGroupProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
EcsDeploymentGroupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-17T14:40:47.658Z") @Stability(Stable) public interface EcsDeploymentGroupProps extends software.amazon.jsii.JsiiSerializable
Construction properties for EcsDeploymentGroup.

Example: 

 EcsApplication myApplication;
 Cluster cluster;
 FargateTaskDefinition taskDefinition;
 ITargetGroup blueTargetGroup;
 ITargetGroup greenTargetGroup;
 IApplicationListener listener;
 FargateService service = FargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .deploymentController(DeploymentController.builder()
                 .type(DeploymentControllerType.CODE_DEPLOY)
                 .build())
         .build();
 EcsDeploymentGroup.Builder.create(this, "BlueGreenDG")
         .service(service)
         .blueGreenDeploymentConfig(EcsBlueGreenDeploymentConfig.builder()
                 .blueTargetGroup(blueTargetGroup)
                 .greenTargetGroup(greenTargetGroup)
                 .listener(listener)
                 .build())
         .deploymentConfig(EcsDeploymentConfig.CANARY_10PERCENT_5MINUTES)
         .build();

  • Method Details

    • getBlueGreenDeploymentConfig

      @Stability(Stable) @NotNull EcsBlueGreenDeploymentConfig getBlueGreenDeploymentConfig()
      The configuration options for blue-green ECS deployments.

    • getService

      @Stability(Stable) @NotNull IBaseService getService()
      The ECS service to deploy with this Deployment Group.

    • getAlarms

      @Stability(Stable) @Nullable default List<IAlarm> getAlarms()
      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: []

      See Also:

    • getApplication

      @Stability(Stable) @Nullable default IEcsApplication getApplication()
      The reference to the CodeDeploy ECS Application that this Deployment Group belongs to.

      Default: One will be created for you.

    • getAutoRollback

      @Stability(Stable) @Nullable default AutoRollbackConfig getAutoRollback()
      The auto-rollback configuration for this Deployment Group.

      Default: - default AutoRollbackConfig.

    • getDeploymentConfig

      @Stability(Stable) @Nullable default IEcsDeploymentConfig getDeploymentConfig()
      The Deployment Configuration this Deployment Group uses.

      Default: EcsDeploymentConfig.ALL_AT_ONCE

    • getDeploymentGroupName

      @Stability(Stable) @Nullable default String getDeploymentGroupName()
      The physical, human-readable name of the CodeDeploy Deployment Group.

      Default: An auto-generated name will be used.

    • getIgnoreAlarmConfiguration

      @Stability(Stable) @Nullable default Boolean getIgnoreAlarmConfiguration()
      Whether to skip the step of checking CloudWatch alarms during the deployment process.

      Default: - false

    • getIgnorePollAlarmsFailure

      @Stability(Stable) @Nullable default Boolean getIgnorePollAlarmsFailure()
      Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

      Default: false

    • getRole

      @Stability(Stable) @Nullable default IRole getRole()
      The service Role of this Deployment Group.

      Default: - A new Role will be created.

    • builder

      @Stability(Stable) static EcsDeploymentGroupProps.Builder builder()
      Returns:
      a EcsDeploymentGroupProps.Builder of EcsDeploymentGroupProps