Interface EcsDeploymentGroupProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
EcsDeploymentGroupProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:12.134Z")
@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();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forEcsDeploymentGroupProps
static final class
An implementation forEcsDeploymentGroupProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The CloudWatch alarms associated with this Deployment Group.default IEcsApplication
The reference to the CodeDeploy ECS Application that this Deployment Group belongs to.default AutoRollbackConfig
The auto-rollback configuration for this Deployment Group.The configuration options for blue-green ECS deployments.default IEcsDeploymentConfig
The Deployment Configuration this Deployment Group uses.default String
The physical, human-readable name of the CodeDeploy Deployment Group.default Boolean
Whether to skip the step of checking CloudWatch alarms during the deployment process.default Boolean
Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.default IRole
getRole()
The service Role of this Deployment Group.The ECS service to deploy with this Deployment Group.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBlueGreenDeploymentConfig
The configuration options for blue-green ECS deployments. -
getService
The ECS service to deploy with this Deployment Group. -
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
The reference to the CodeDeploy ECS Application that this Deployment Group belongs to.Default: One will be created for you.
-
getAutoRollback
The auto-rollback configuration for this Deployment Group.Default: - default AutoRollbackConfig.
-
getDeploymentConfig
The Deployment Configuration this Deployment Group uses.Default: EcsDeploymentConfig.ALL_AT_ONCE
-
getDeploymentGroupName
The physical, human-readable name of the CodeDeploy Deployment Group.Default: An auto-generated name will be used.
-
getIgnoreAlarmConfiguration
Whether to skip the step of checking CloudWatch alarms during the deployment process.Default: - false
-
getIgnorePollAlarmsFailure
Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.Default: false
-
getRole
The service Role of this Deployment Group.Default: - A new Role will be created.
-
builder
- Returns:
- a
EcsDeploymentGroupProps.Builder
ofEcsDeploymentGroupProps
-