EcsDeploymentGroup
A CodeDeploy deployment group that orchestrates ECS blue-green deployments.
Import
import { EcsDeploymentGroup } from 'aws-cdk-lib/aws-codedeploy';Or use the module namespace:
import * as codedeploy from 'aws-cdk-lib/aws-codedeploy';
// codedeploy.EcsDeploymentGroupProperties
Configuration passed to the constructor as EcsDeploymentGroupProps.
blueGreenDeploymentConfigRequiredEcsBlueGreenDeploymentConfigThe configuration options for blue-green ECS deployments.
serviceRequiredIBaseServiceThe ECS service to deploy with this Deployment Group.
alarmsOptionalIAlarmRef[]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: []
applicationOptionalIApplicationRefThe reference to the CodeDeploy ECS Application that this Deployment Group belongs to.
Default: One will be created for you.
autoRollbackOptionalAutoRollbackConfigThe auto-rollback configuration for this Deployment Group.
Default: - default AutoRollbackConfig.
deploymentConfigOptionalIDeploymentConfigRefThe Deployment Configuration this Deployment Group uses.
Default: EcsDeploymentConfig.ALL_AT_ONCE
deploymentGroupNameOptionalstringThe physical, human-readable name of the CodeDeploy Deployment Group.
Default: An auto-generated name will be used.
ignoreAlarmConfigurationOptionalbooleanWhether to skip the step of checking CloudWatch alarms during the deployment process.
Default: - false
ignorePollAlarmsFailureOptionalbooleanWhether to continue a deployment even if fetching the alarm status from CloudWatch failed.
Default: false
roleOptionalIRoleThe service Role of this Deployment Group.
Default: - A new Role will be created.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-codedeploy