Package software.amazon.awscdk.services.codedeploy
AWS CodeDeploy Construct Library
Table of Contents
- Introduction
- Deploying to Amazon EC2 and on-premise instances
- Deploying to AWS Lambda functions
- Deploying to Amazon ECS services
Introduction
AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances, serverless Lambda functions, or Amazon ECS services.
The CDK currently supports Amazon EC2, on-premise, AWS Lambda, and Amazon ECS applications.
EC2/on-premise Applications
To create a new CodeDeploy Application that deploys to EC2/on-premise instances:
ServerApplication application = ServerApplication.Builder.create(this, "CodeDeployApplication") .applicationName("MyApplication") .build();
To import an already existing Application:
IServerApplication application = ServerApplication.fromServerApplicationName(this, "ExistingCodeDeployApplication", "MyExistingApplication");
EC2/on-premise Deployment Groups
To create a new CodeDeploy Deployment Group that deploys to EC2/on-premise instances:
import software.amazon.awscdk.services.autoscaling.*; import software.amazon.awscdk.services.cloudwatch.*; ServerApplication application; AutoScalingGroup asg; Alarm alarm; ServerDeploymentGroup deploymentGroup = ServerDeploymentGroup.Builder.create(this, "CodeDeployDeploymentGroup") .application(application) .deploymentGroupName("MyDeploymentGroup") .autoScalingGroups(List.of(asg)) // adds User Data that installs the CodeDeploy agent on your auto-scaling groups hosts // default: true .installAgent(true) // adds EC2 instances matching tags .ec2InstanceTags(new InstanceTagSet(Map.of( // any instance with tags satisfying // key1=v1 or key1=v2 or key2 (any value) or value v3 (any key) // will match this group "key1", List.of("v1", "v2"), "key2", List.of(), "", List.of("v3")))) // adds on-premise instances matching tags .onPremiseInstanceTags(new InstanceTagSet(Map.of( "key1", List.of("v1", "v2")), Map.of( "key2", List.of("v3")))) // CloudWatch alarms .alarms(List.of(alarm)) // whether to ignore failure to fetch the status of alarms from CloudWatch // default: false .ignorePollAlarmsFailure(false) // whether to skip the step of checking CloudWatch alarms during the deployment process // default: false .ignoreAlarmConfiguration(false) // auto-rollback configuration .autoRollback(AutoRollbackConfig.builder() .failedDeployment(true) // default: true .stoppedDeployment(true) // default: false .deploymentInAlarm(true) .build()) // whether the deployment group was configured to have CodeDeploy install a termination hook into an Auto Scaling group // default: false .terminationHook(true) .build();
All properties are optional - if you don't provide an Application, one will be automatically created.
To import an already existing Deployment Group:
ServerApplication application; IServerDeploymentGroup deploymentGroup = ServerDeploymentGroup.fromServerDeploymentGroupAttributes(this, "ExistingCodeDeployDeploymentGroup", ServerDeploymentGroupAttributes.builder() .application(application) .deploymentGroupName("MyExistingDeploymentGroup") .build());
Load balancers
You can specify a load balancer
with the loadBalancer
property when creating a Deployment Group.
LoadBalancer
is an abstract class with static factory methods that allow you to create instances of it from various sources.
With Classic Elastic Load Balancer, you provide it directly:
import software.amazon.awscdk.services.elasticloadbalancing.*; LoadBalancer lb; lb.addListener(LoadBalancerListener.builder() .externalPort(80) .build()); ServerDeploymentGroup deploymentGroup = ServerDeploymentGroup.Builder.create(this, "DeploymentGroup") .loadBalancer(LoadBalancer.classic(lb)) .build();
With Application Load Balancer or Network Load Balancer, you provide a Target Group as the load balancer:
ApplicationLoadBalancer alb; ApplicationListener listener = alb.addListener("Listener", BaseApplicationListenerProps.builder().port(80).build()); ApplicationTargetGroup targetGroup = listener.addTargets("Fleet", AddApplicationTargetsProps.builder().port(80).build()); ServerDeploymentGroup deploymentGroup = ServerDeploymentGroup.Builder.create(this, "DeploymentGroup") .loadBalancer(LoadBalancer.application(targetGroup)) .build();
The loadBalancer
property has been deprecated. To provide multiple Elastic Load Balancers as target groups use the loadBalancers
parameter:
import software.amazon.awscdk.services.elasticloadbalancing.*; import software.amazon.awscdk.services.elasticloadbalancingv2.*; LoadBalancer clb; ApplicationLoadBalancer alb; NetworkLoadBalancer nlb; ApplicationListener albListener = alb.addListener("ALBListener", BaseApplicationListenerProps.builder().port(80).build()); ApplicationTargetGroup albTargetGroup = albListener.addTargets("ALBFleet", AddApplicationTargetsProps.builder().port(80).build()); NetworkListener nlbListener = nlb.addListener("NLBListener", BaseNetworkListenerProps.builder().port(80).build()); NetworkTargetGroup nlbTargetGroup = nlbListener.addTargets("NLBFleet", AddNetworkTargetsProps.builder().port(80).build()); ServerDeploymentGroup deploymentGroup = ServerDeploymentGroup.Builder.create(this, "DeploymentGroup") .loadBalancers(List.of(LoadBalancer.classic(clb), LoadBalancer.application(albTargetGroup), LoadBalancer.network(nlbTargetGroup))) .build();
EC2/on-premise Deployment Configurations
You can also pass a Deployment Configuration when creating the Deployment Group:
ServerDeploymentGroup deploymentGroup = ServerDeploymentGroup.Builder.create(this, "CodeDeployDeploymentGroup") .deploymentConfig(ServerDeploymentConfig.ALL_AT_ONCE) .build();
The default Deployment Configuration is ServerDeploymentConfig.ONE_AT_A_TIME
.
You can also create a custom Deployment Configuration:
ServerDeploymentConfig deploymentConfig = ServerDeploymentConfig.Builder.create(this, "DeploymentConfiguration") .deploymentConfigName("MyDeploymentConfiguration") // optional property // one of these is required, but both cannot be specified at the same time .minimumHealthyHosts(MinimumHealthyHosts.count(2)) .build();
Or import an existing one:
IServerDeploymentConfig deploymentConfig = ServerDeploymentConfig.fromServerDeploymentConfigName(this, "ExistingDeploymentConfiguration", "MyExistingDeploymentConfiguration");
Zonal Configuration
CodeDeploy can deploy your application to one Availability Zone at a time, within an AWS Region by configuring zonal configuration.
To create a new deployment configuration with zonal configuration:
ServerDeploymentConfig deploymentConfig = ServerDeploymentConfig.Builder.create(this, "DeploymentConfiguration") .minimumHealthyHosts(MinimumHealthyHosts.count(2)) .zonalConfig(ZonalConfig.builder() .monitorDuration(Duration.minutes(30)) .firstZoneMonitorDuration(Duration.minutes(60)) .minimumHealthyHostsPerZone(MinimumHealthyHostsPerZone.count(1)) .build()) .build();
Note: Zonal configuration is only configurable for EC2/on-premise deployments.
Lambda Applications
To create a new CodeDeploy Application that deploys to a Lambda function:
LambdaApplication application = LambdaApplication.Builder.create(this, "CodeDeployApplication") .applicationName("MyApplication") .build();
To import an already existing Application:
ILambdaApplication application = LambdaApplication.fromLambdaApplicationName(this, "ExistingCodeDeployApplication", "MyExistingApplication");
Lambda Deployment Groups
To enable traffic shifting deployments for Lambda functions, CodeDeploy uses Lambda Aliases, which can balance incoming traffic between two different versions of your function. Before deployment, the alias sends 100% of invokes to the version used in production. When you publish a new version of the function to your stack, CodeDeploy will send a small percentage of traffic to the new version, monitor, and validate before shifting 100% of traffic to the new version.
To create a new CodeDeploy Deployment Group that deploys to a Lambda function:
LambdaApplication myApplication; Function func; Version version = func.getCurrentVersion(); Alias version1Alias = Alias.Builder.create(this, "alias") .aliasName("prod") .version(version) .build(); LambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.Builder.create(this, "BlueGreenDeployment") .application(myApplication) // optional property: one will be created for you if not provided .alias(version1Alias) .deploymentConfig(LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE) .build();
In order to deploy a new version of this function:
- Reference the version with the latest changes
const version = func.currentVersion
. - Re-deploy the stack (this will trigger a deployment).
- Monitor the CodeDeploy deployment as traffic shifts between the versions.
Lambda Deployment Rollbacks and Alarms
CodeDeploy will roll back if the deployment fails. You can optionally trigger a rollback when one or more alarms are in a failed state:
import software.amazon.awscdk.services.cloudwatch.*; Alias alias; // or add alarms to an existing group Alias blueGreenAlias; Alarm alarm = Alarm.Builder.create(this, "Errors") .comparisonOperator(ComparisonOperator.GREATER_THAN_THRESHOLD) .threshold(1) .evaluationPeriods(1) .metric(alias.metricErrors()) .build(); LambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.Builder.create(this, "BlueGreenDeployment") .alias(alias) .deploymentConfig(LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE) .alarms(List.of(alarm)) .build(); deploymentGroup.addAlarm(Alarm.Builder.create(this, "BlueGreenErrors") .comparisonOperator(ComparisonOperator.GREATER_THAN_THRESHOLD) .threshold(1) .evaluationPeriods(1) .metric(blueGreenAlias.metricErrors()) .build());
Pre and Post Hooks
CodeDeploy allows you to run an arbitrary Lambda function before traffic shifting actually starts (PreTraffic Hook) and after it completes (PostTraffic Hook). With either hook, you have the opportunity to run logic that determines whether the deployment must succeed or fail. For example, with PreTraffic hook you could run integration tests against the newly created Lambda version (but not serving traffic). With PostTraffic hook, you could run end-to-end validation checks.
Function warmUpUserCache; Function endToEndValidation; Alias alias; // pass a hook whe creating the deployment group LambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.Builder.create(this, "BlueGreenDeployment") .alias(alias) .deploymentConfig(LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE) .preHook(warmUpUserCache) .build(); // or configure one on an existing deployment group deploymentGroup.addPostHook(endToEndValidation);
Import an existing Lambda Deployment Group
To import an already existing Deployment Group:
LambdaApplication application; ILambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.fromLambdaDeploymentGroupAttributes(this, "ExistingCodeDeployDeploymentGroup", LambdaDeploymentGroupAttributes.builder() .application(application) .deploymentGroupName("MyExistingDeploymentGroup") .build());
Lambda Deployment Configurations
CodeDeploy for Lambda comes with predefined configurations for traffic shifting. The predefined configurations are available as LambdaDeploymentConfig constants.
LambdaApplication application; Alias alias; ILambdaDeploymentConfig config = LambdaDeploymentConfig.CANARY_10PERCENT_30MINUTES; LambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.Builder.create(this, "BlueGreenDeployment") .application(application) .alias(alias) .deploymentConfig(config) .build();
If you want to specify your own strategy, you can do so with the LambdaDeploymentConfig construct, letting you specify precisely how fast a new function version is deployed.
LambdaApplication application; Alias alias; LambdaDeploymentConfig config = LambdaDeploymentConfig.Builder.create(this, "CustomConfig") .trafficRouting(TimeBasedCanaryTrafficRouting.Builder.create() .interval(Duration.minutes(15)) .percentage(5) .build()) .build(); LambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.Builder.create(this, "BlueGreenDeployment") .application(application) .alias(alias) .deploymentConfig(config) .build();
You can specify a custom name for your deployment config, but if you do you will not be able to update the interval/percentage through CDK.
LambdaDeploymentConfig config = LambdaDeploymentConfig.Builder.create(this, "CustomConfig") .trafficRouting(TimeBasedCanaryTrafficRouting.Builder.create() .interval(Duration.minutes(15)) .percentage(5) .build()) .deploymentConfigName("MyDeploymentConfig") .build();
To import an already existing Deployment Config:
ILambdaDeploymentConfig deploymentConfig = LambdaDeploymentConfig.fromLambdaDeploymentConfigName(this, "ExistingDeploymentConfiguration", "MyExistingDeploymentConfiguration");
ECS Applications
To create a new CodeDeploy Application that deploys an ECS service:
EcsApplication application = EcsApplication.Builder.create(this, "CodeDeployApplication") .applicationName("MyApplication") .build();
To import an already existing Application:
IEcsApplication application = EcsApplication.fromEcsApplicationName(this, "ExistingCodeDeployApplication", "MyExistingApplication");
ECS Deployment Groups
CodeDeploy can be used to deploy to load-balanced ECS services. CodeDeploy performs ECS blue-green deployments by managing ECS task sets and load balancer target groups. During a blue-green deployment, one task set and target group runs the original version of your ECS task definition ('blue') and another task set and target group runs the new version of your ECS task definition ('green').
CodeDeploy orchestrates traffic shifting during ECS blue-green deployments by using a load balancer listener to balance incoming traffic between the 'blue' and 'green' task sets/target groups running two different versions of your ECS task definition. Before deployment, the load balancer listener sends 100% of requests to the 'blue' target group. When you publish a new version of the task definition and start a CodeDeploy deployment, CodeDeploy can send a small percentage of traffic to the new 'green' task set behind the 'green' target group, monitor, and validate before shifting 100% of traffic to the new version.
To create a new CodeDeploy Deployment Group that deploys to an ECS service:
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();
In order to deploy a new task definition version to the ECS service,
deploy the changes directly through CodeDeploy using the CodeDeploy APIs or console.
When the CODE_DEPLOY
deployment controller is used, the ECS service cannot be
deployed with a new task definition version through CloudFormation.
For more information on the behavior of CodeDeploy blue-green deployments for ECS, see What happens during an Amazon ECS deployment in the CodeDeploy user guide.
Note: If you wish to deploy updates to your ECS service through CDK and CloudFormation instead of directly through CodeDeploy,
using the CfnCodeDeployBlueGreenHook
construct is the recommended approach instead of using the EcsDeploymentGroup
construct. For a comparison
of ECS blue-green deployments through CodeDeploy (using EcsDeploymentGroup
) and through CloudFormation (using CfnCodeDeployBlueGreenHook
),
see Create an Amazon ECS blue/green deployment through AWS CloudFormation
in the CloudFormation user guide.
ECS Deployment Rollbacks and Alarms
CodeDeploy will automatically roll back if a deployment fails. You can optionally trigger an automatic rollback when one or more alarms are in a failed state during a deployment, or if the deployment stops.
In this example, CodeDeploy will monitor and roll back on alarms set for the number of unhealthy ECS tasks in each of the blue and green target groups, as well as alarms set for the number HTTP 5xx responses seen in each of the blue and green target groups.
import software.amazon.awscdk.services.cloudwatch.*; FargateService service; ApplicationTargetGroup blueTargetGroup; ApplicationTargetGroup greenTargetGroup; IApplicationListener listener; // Alarm on the number of unhealthy ECS tasks in each target group Alarm blueUnhealthyHosts = Alarm.Builder.create(this, "BlueUnhealthyHosts") .alarmName(Stack.of(this).getStackName() + "-Unhealthy-Hosts-Blue") .metric(blueTargetGroup.metricUnhealthyHostCount()) .threshold(1) .evaluationPeriods(2) .build(); Alarm greenUnhealthyHosts = Alarm.Builder.create(this, "GreenUnhealthyHosts") .alarmName(Stack.of(this).getStackName() + "-Unhealthy-Hosts-Green") .metric(greenTargetGroup.metricUnhealthyHostCount()) .threshold(1) .evaluationPeriods(2) .build(); // Alarm on the number of HTTP 5xx responses returned by each target group Alarm blueApiFailure = Alarm.Builder.create(this, "Blue5xx") .alarmName(Stack.of(this).getStackName() + "-Http-5xx-Blue") .metric(blueTargetGroup.metricHttpCodeTarget(HttpCodeTarget.TARGET_5XX_COUNT, MetricOptions.builder().period(Duration.minutes(1)).build())) .threshold(1) .evaluationPeriods(1) .build(); Alarm greenApiFailure = Alarm.Builder.create(this, "Green5xx") .alarmName(Stack.of(this).getStackName() + "-Http-5xx-Green") .metric(greenTargetGroup.metricHttpCodeTarget(HttpCodeTarget.TARGET_5XX_COUNT, MetricOptions.builder().period(Duration.minutes(1)).build())) .threshold(1) .evaluationPeriods(1) .build(); EcsDeploymentGroup.Builder.create(this, "BlueGreenDG") // CodeDeploy will monitor these alarms during a deployment and automatically roll back .alarms(List.of(blueUnhealthyHosts, greenUnhealthyHosts, blueApiFailure, greenApiFailure)) .autoRollback(AutoRollbackConfig.builder() // CodeDeploy will automatically roll back if a deployment is stopped .stoppedDeployment(true) .build()) .service(service) .blueGreenDeploymentConfig(EcsBlueGreenDeploymentConfig.builder() .blueTargetGroup(blueTargetGroup) .greenTargetGroup(greenTargetGroup) .listener(listener) .build()) .deploymentConfig(EcsDeploymentConfig.CANARY_10PERCENT_5MINUTES) .build();
Deployment validation and manual deployment approval
CodeDeploy blue-green deployments provide an opportunity to validate the new task definition version running on the 'green' ECS task set prior to shifting any production traffic to the new version. A second 'test' listener serving traffic on a different port be added to the load balancer. For example, the test listener can serve test traffic on port 9001 while the main listener serves production traffic on port 443. During a blue-green deployment, CodeDeploy can then shift 100% of test traffic over to the 'green' task set/target group prior to shifting any production traffic during the deployment.
EcsApplication myApplication; FargateService service; ITargetGroup blueTargetGroup; ITargetGroup greenTargetGroup; IApplicationListener listener; IApplicationListener testListener; EcsDeploymentGroup.Builder.create(this, "BlueGreenDG") .service(service) .blueGreenDeploymentConfig(EcsBlueGreenDeploymentConfig.builder() .blueTargetGroup(blueTargetGroup) .greenTargetGroup(greenTargetGroup) .listener(listener) .testListener(testListener) .build()) .deploymentConfig(EcsDeploymentConfig.CANARY_10PERCENT_5MINUTES) .build();
Automated validation steps can run during the CodeDeploy deployment after shifting test traffic and before
shifting production traffic. CodeDeploy supports registering Lambda functions as lifecycle hooks for
an ECS deployment. These Lambda functions can run automated validation steps against the test traffic
port, for example in response to the AfterAllowTestTraffic
lifecycle hook. For more information about
how to specify the Lambda functions to run for each CodeDeploy lifecycle hook in an ECS deployment, see the
AppSpec 'hooks' for an Amazon ECS deployment
section in the CodeDeploy user guide.
After provisioning the 'green' ECS task set and re-routing test traffic during a blue-green deployment, CodeDeploy can wait for approval before continuing the deployment and re-routing production traffic. During this approval wait time, you can complete additional validation steps prior to exposing the new 'green' task set to production traffic, such as manual testing through the test listener port or running automated integration test suites.
To approve the deployment, validation steps use the CodeDeploy [ContinueDeployment API(https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ContinueDeployment.html). If the ContinueDeployment API is not called within the approval wait time period, CodeDeploy will stop the deployment and can automatically roll back the deployment.
FargateService service; ITargetGroup blueTargetGroup; ITargetGroup greenTargetGroup; IApplicationListener listener; IApplicationListener testListener; EcsDeploymentGroup.Builder.create(this, "BlueGreenDG") .autoRollback(AutoRollbackConfig.builder() // CodeDeploy will automatically roll back if the 8-hour approval period times out and the deployment stops .stoppedDeployment(true) .build()) .service(service) .blueGreenDeploymentConfig(EcsBlueGreenDeploymentConfig.builder() // The deployment will wait for approval for up to 8 hours before stopping the deployment .deploymentApprovalWaitTime(Duration.hours(8)) .blueTargetGroup(blueTargetGroup) .greenTargetGroup(greenTargetGroup) .listener(listener) .testListener(testListener) .build()) .deploymentConfig(EcsDeploymentConfig.CANARY_10PERCENT_5MINUTES) .build();
Deployment bake time
You can specify how long CodeDeploy waits before it terminates the original 'blue' ECS task set when a blue-green deployment is complete in order to let the deployment "bake" a while. During this bake time, CodeDeploy will continue to monitor any CloudWatch alarms specified for the deployment group and will automatically roll back if those alarms go into a failed state.
import software.amazon.awscdk.services.cloudwatch.*; FargateService service; ITargetGroup blueTargetGroup; ITargetGroup greenTargetGroup; IApplicationListener listener; Alarm blueUnhealthyHosts; Alarm greenUnhealthyHosts; Alarm blueApiFailure; Alarm greenApiFailure; EcsDeploymentGroup.Builder.create(this, "BlueGreenDG") .service(service) .blueGreenDeploymentConfig(EcsBlueGreenDeploymentConfig.builder() .blueTargetGroup(blueTargetGroup) .greenTargetGroup(greenTargetGroup) .listener(listener) // CodeDeploy will wait for 30 minutes after completing the blue-green deployment before it terminates the blue tasks .terminationWaitTime(Duration.minutes(30)) .build()) // CodeDeploy will continue to monitor these alarms during the 30-minute bake time and will automatically // roll back if they go into a failed state at any point during the deployment. .alarms(List.of(blueUnhealthyHosts, greenUnhealthyHosts, blueApiFailure, greenApiFailure)) .deploymentConfig(EcsDeploymentConfig.CANARY_10PERCENT_5MINUTES) .build();
Import an existing ECS Deployment Group
To import an already existing Deployment Group:
EcsApplication application; IEcsDeploymentGroup deploymentGroup = EcsDeploymentGroup.fromEcsDeploymentGroupAttributes(this, "ExistingCodeDeployDeploymentGroup", EcsDeploymentGroupAttributes.builder() .application(application) .deploymentGroupName("MyExistingDeploymentGroup") .build());
ECS Deployment Configurations
CodeDeploy for ECS comes with predefined configurations for traffic shifting. The predefined configurations are available as LambdaDeploymentConfig constants.
IEcsDeploymentConfig config = EcsDeploymentConfig.CANARY_10PERCENT_5MINUTES;
If you want to specify your own strategy, you can do so with the EcsDeploymentConfig construct, letting you specify precisely how fast an ECS service is deployed.
EcsDeploymentConfig.Builder.create(this, "CustomConfig") .trafficRouting(TimeBasedCanaryTrafficRouting.Builder.create() .interval(Duration.minutes(15)) .percentage(5) .build()) .build();
You can specify a custom name for your deployment config, but if you do you will not be able to update the interval/percentage through CDK.
EcsDeploymentConfig config = EcsDeploymentConfig.Builder.create(this, "CustomConfig") .trafficRouting(TimeBasedCanaryTrafficRouting.Builder.create() .interval(Duration.minutes(15)) .percentage(5) .build()) .deploymentConfigName("MyDeploymentConfig") .build();
Or import an existing one:
IEcsDeploymentConfig deploymentConfig = EcsDeploymentConfig.fromEcsDeploymentConfigName(this, "ExistingDeploymentConfiguration", "MyExistingDeploymentConfiguration");
ECS Deployments
An experimental construct is available on the Construct Hub called @cdklabs/cdk-ecs-codedeploy that manages ECS CodeDeploy deployments.
IEcsDeploymentGroup deploymentGroup; ITaskDefinition taskDefinition; new EcsDeployment(Map.of( "deploymentGroup", deploymentGroup, "targetService", Map.of( "taskDefinition", taskDefinition, "containerName", "mycontainer", "containerPort", 80)));
The deployment will use the AutoRollbackConfig for the EcsDeploymentGroup unless it is overridden in the deployment:
IEcsDeploymentGroup deploymentGroup; ITaskDefinition taskDefinition; new EcsDeployment(Map.of( "deploymentGroup", deploymentGroup, "targetService", Map.of( "taskDefinition", taskDefinition, "containerName", "mycontainer", "containerPort", 80), "autoRollback", Map.of( "failedDeployment", true, "deploymentInAlarm", true, "stoppedDeployment", false)));
By default, the CodeDeploy Deployment will timeout after 30 minutes. The timeout value can be overridden:
IEcsDeploymentGroup deploymentGroup; ITaskDefinition taskDefinition; new EcsDeployment(Map.of( "deploymentGroup", deploymentGroup, "targetService", Map.of( "taskDefinition", taskDefinition, "containerName", "mycontainer", "containerPort", 80), "timeout", Duration.minutes(60)));
-
ClassDescriptionDefine a traffic routing config of type 'AllAtOnce'.The configuration for automatically rolling back deployments in a given Deployment Group.A builder for
AutoRollbackConfig
An implementation forAutoRollbackConfig
The base class for ServerDeploymentConfig, EcsDeploymentConfig, and LambdaDeploymentConfig deployment configurations.Construction properties ofBaseDeploymentConfig
.A builder forBaseDeploymentConfigOptions
An implementation forBaseDeploymentConfigOptions
Complete base deployment config properties that are required to be supplied by the implementation of the BaseDeploymentConfig class.A builder forBaseDeploymentConfigProps
An implementation forBaseDeploymentConfigProps
Common properties of traffic shifting routing configurations.A builder forBaseTrafficShiftingConfigProps
An implementation forBaseTrafficShiftingConfigProps
Represents the configuration specific to canary traffic shifting.A builder forCanaryTrafficRoutingConfig
An implementation forCanaryTrafficRoutingConfig
TheAWS::CodeDeploy::Application
resource creates an AWS CodeDeploy application.A fluent builder forCfnApplication
.Properties for defining aCfnApplication
.A builder forCfnApplicationProps
An implementation forCfnApplicationProps
TheAWS::CodeDeploy::DeploymentConfig
resource creates a set of deployment rules, deployment success conditions, and deployment failure conditions that AWS CodeDeploy uses during a deployment.A fluent builder forCfnDeploymentConfig
.Information about the minimum number of healthy instances per Availability Zone.A builder forCfnDeploymentConfig.MinimumHealthyHostsPerZoneProperty
An implementation forCfnDeploymentConfig.MinimumHealthyHostsPerZoneProperty
MinimumHealthyHosts
is a property of the DeploymentConfig resource that defines how many instances must remain healthy during an AWS CodeDeploy deployment.A builder forCfnDeploymentConfig.MinimumHealthyHostsProperty
An implementation forCfnDeploymentConfig.MinimumHealthyHostsProperty
A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments.A builder forCfnDeploymentConfig.TimeBasedCanaryProperty
An implementation forCfnDeploymentConfig.TimeBasedCanaryProperty
A configuration that shifts traffic from one version of a Lambda function or ECS task set to another in equal increments, with an equal number of minutes between each increment.A builder forCfnDeploymentConfig.TimeBasedLinearProperty
An implementation forCfnDeploymentConfig.TimeBasedLinearProperty
The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an AWS Lambda deployment, or from one Amazon ECS task set to another during an Amazon ECS deployment.A builder forCfnDeploymentConfig.TrafficRoutingConfigProperty
An implementation forCfnDeploymentConfig.TrafficRoutingConfigProperty
Configure theZonalConfig
object if you want AWS CodeDeploy to deploy your application to one Availability Zone at a time, within an AWS Region.A builder forCfnDeploymentConfig.ZonalConfigProperty
An implementation forCfnDeploymentConfig.ZonalConfigProperty
Properties for defining aCfnDeploymentConfig
.A builder forCfnDeploymentConfigProps
An implementation forCfnDeploymentConfigProps
TheAWS::CodeDeploy::DeploymentGroup
resource creates an AWS CodeDeploy deployment group that specifies which instances your application revisions are deployed to, along with other deployment options.TheAlarmConfiguration
property type configures CloudWatch alarms for an AWS CodeDeploy deployment group.A builder forCfnDeploymentGroup.AlarmConfigurationProperty
An implementation forCfnDeploymentGroup.AlarmConfigurationProperty
TheAlarm
property type specifies a CloudWatch alarm to use for an AWS CodeDeploy deployment group.A builder forCfnDeploymentGroup.AlarmProperty
An implementation forCfnDeploymentGroup.AlarmProperty
TheAutoRollbackConfiguration
property type configures automatic rollback for an AWS CodeDeploy deployment group when a deployment is not completed successfully.A builder forCfnDeploymentGroup.AutoRollbackConfigurationProperty
An implementation forCfnDeploymentGroup.AutoRollbackConfigurationProperty
Information about blue/green deployment options for a deployment group.An implementation forCfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty
Information about whether instances in the original environment are terminated when a blue/green deployment is successful.A builder forCfnDeploymentGroup.BlueInstanceTerminationOptionProperty
An implementation forCfnDeploymentGroup.BlueInstanceTerminationOptionProperty
A fluent builder forCfnDeploymentGroup
.Deployment
is a property of the DeploymentGroup resource that specifies an AWS CodeDeploy application revision to be deployed to instances in the deployment group.A builder forCfnDeploymentGroup.DeploymentProperty
An implementation forCfnDeploymentGroup.DeploymentProperty
Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.A builder forCfnDeploymentGroup.DeploymentReadyOptionProperty
An implementation forCfnDeploymentGroup.DeploymentReadyOptionProperty
Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.A builder forCfnDeploymentGroup.DeploymentStyleProperty
An implementation forCfnDeploymentGroup.DeploymentStyleProperty
Information about an Amazon EC2 tag filter.A builder forCfnDeploymentGroup.EC2TagFilterProperty
An implementation forCfnDeploymentGroup.EC2TagFilterProperty
TheEC2TagSet
property type specifies information about groups of tags applied to Amazon EC2 instances.A builder forCfnDeploymentGroup.EC2TagSetListObjectProperty
An implementation forCfnDeploymentGroup.EC2TagSetListObjectProperty
TheEC2TagSet
property type specifies information about groups of tags applied to Amazon EC2 instances.A builder forCfnDeploymentGroup.EC2TagSetProperty
An implementation forCfnDeploymentGroup.EC2TagSetProperty
Contains the service and cluster names used to identify an Amazon ECS deployment's target.A builder forCfnDeploymentGroup.ECSServiceProperty
An implementation forCfnDeploymentGroup.ECSServiceProperty
TheELBInfo
property type specifies information about the Elastic Load Balancing load balancer used for an CodeDeploy deployment group.A builder forCfnDeploymentGroup.ELBInfoProperty
An implementation forCfnDeploymentGroup.ELBInfoProperty
GitHubLocation
is a property of the CodeDeploy DeploymentGroup Revision property that specifies the location of an application revision that is stored in GitHub.A builder forCfnDeploymentGroup.GitHubLocationProperty
An implementation forCfnDeploymentGroup.GitHubLocationProperty
Information about the instances that belong to the replacement environment in a blue/green deployment.A builder forCfnDeploymentGroup.GreenFleetProvisioningOptionProperty
An implementation forCfnDeploymentGroup.GreenFleetProvisioningOptionProperty
TheLoadBalancerInfo
property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group.A builder forCfnDeploymentGroup.LoadBalancerInfoProperty
An implementation forCfnDeploymentGroup.LoadBalancerInfoProperty
TheOnPremisesTagSetListObject
property type specifies lists of on-premises instance tag groups.A builder forCfnDeploymentGroup.OnPremisesTagSetListObjectProperty
An implementation forCfnDeploymentGroup.OnPremisesTagSetListObjectProperty
TheOnPremisesTagSet
property type specifies a list containing other lists of on-premises instance tag groups.A builder forCfnDeploymentGroup.OnPremisesTagSetProperty
An implementation forCfnDeploymentGroup.OnPremisesTagSetProperty
RevisionLocation
is a property that defines the location of the CodeDeploy application revision to deploy.A builder forCfnDeploymentGroup.RevisionLocationProperty
An implementation forCfnDeploymentGroup.RevisionLocationProperty
S3Location
is a property of the CodeDeploy DeploymentGroup Revision property that specifies the location of an application revision that is stored in Amazon Simple Storage Service ( Amazon S3 ).A builder forCfnDeploymentGroup.S3LocationProperty
An implementation forCfnDeploymentGroup.S3LocationProperty
TagFilter
is a property type of the AWS::CodeDeploy::DeploymentGroup resource that specifies which on-premises instances to associate with the deployment group.A builder forCfnDeploymentGroup.TagFilterProperty
An implementation forCfnDeploymentGroup.TagFilterProperty
TheTargetGroupInfo
property type specifies information about a target group in Elastic Load Balancing to use in a deployment.A builder forCfnDeploymentGroup.TargetGroupInfoProperty
An implementation forCfnDeploymentGroup.TargetGroupInfoProperty
Information about two target groups and how traffic is routed during an Amazon ECS deployment.A builder forCfnDeploymentGroup.TargetGroupPairInfoProperty
An implementation forCfnDeploymentGroup.TargetGroupPairInfoProperty
Information about a listener.A builder forCfnDeploymentGroup.TrafficRouteProperty
An implementation forCfnDeploymentGroup.TrafficRouteProperty
Information about notification triggers for the deployment group.A builder forCfnDeploymentGroup.TriggerConfigProperty
An implementation forCfnDeploymentGroup.TriggerConfigProperty
Properties for defining aCfnDeploymentGroup
.A builder forCfnDeploymentGroupProps
An implementation forCfnDeploymentGroupProps
The compute platform of a deployment configuration.Deprecated.CloudFormation now supports Lambda deployment configurations without custom resources.Deprecated.Deprecated.UseLambdaDeploymentConfig
Deprecated.Deprecated.Deprecated.UseLambdaDeploymentConfig
A CodeDeploy Application that deploys to an Amazon ECS service.A fluent builder forEcsApplication
.Construction properties forEcsApplication
.A builder forEcsApplicationProps
An implementation forEcsApplicationProps
Specify how the deployment behaves and how traffic is routed to the ECS service during a blue-green ECS deployment.A builder forEcsBlueGreenDeploymentConfig
An implementation forEcsBlueGreenDeploymentConfig
A custom Deployment Configuration for an ECS Deployment Group.A fluent builder forEcsDeploymentConfig
.Construction properties ofEcsDeploymentConfig
.A builder forEcsDeploymentConfigProps
An implementation forEcsDeploymentConfigProps
A CodeDeploy deployment group that orchestrates ECS blue-green deployments.A fluent builder forEcsDeploymentGroup
.Properties of a reference to a CodeDeploy ECS Deployment Group.A builder forEcsDeploymentGroupAttributes
An implementation forEcsDeploymentGroupAttributes
Construction properties forEcsDeploymentGroup
.A builder forEcsDeploymentGroupProps
An implementation forEcsDeploymentGroupProps
The base class for ServerDeploymentConfig, EcsDeploymentConfig, and LambdaDeploymentConfig deployment configurations.Internal default implementation forIBaseDeploymentConfig
.A proxy class which represents a concrete javascript instance of this type.Represents a reference to a CodeDeploy Application deploying to Amazon ECS.Internal default implementation forIEcsApplication
.A proxy class which represents a concrete javascript instance of this type.The Deployment Configuration of an ECS Deployment Group.Internal default implementation forIEcsDeploymentConfig
.A proxy class which represents a concrete javascript instance of this type.Interface for an ECS deployment group.Internal default implementation forIEcsDeploymentGroup
.A proxy class which represents a concrete javascript instance of this type.Represents a reference to a CodeDeploy Application deploying to AWS Lambda.Internal default implementation forILambdaApplication
.A proxy class which represents a concrete javascript instance of this type.The Deployment Configuration of a Lambda Deployment Group.Internal default implementation forILambdaDeploymentConfig
.A proxy class which represents a concrete javascript instance of this type.Interface for a Lambda deployment groups.Internal default implementation forILambdaDeploymentGroup
.A proxy class which represents a concrete javascript instance of this type.Represents a set of instance tag groups.Represents a reference to a CodeDeploy Application deploying to EC2/on-premise instances.Internal default implementation forIServerApplication
.A proxy class which represents a concrete javascript instance of this type.The Deployment Configuration of an EC2/on-premise Deployment Group.Internal default implementation forIServerDeploymentConfig
.A proxy class which represents a concrete javascript instance of this type.Internal default implementation forIServerDeploymentGroup
.A proxy class which represents a concrete javascript instance of this type.A CodeDeploy Application that deploys to an AWS Lambda function.A fluent builder forLambdaApplication
.Construction properties forLambdaApplication
.A builder forLambdaApplicationProps
An implementation forLambdaApplicationProps
A custom Deployment Configuration for a Lambda Deployment Group.A fluent builder forLambdaDeploymentConfig
.Properties of a reference to a CodeDeploy Lambda Deployment Configuration.A builder forLambdaDeploymentConfigImportProps
An implementation forLambdaDeploymentConfigImportProps
Construction properties ofLambdaDeploymentConfig
.A builder forLambdaDeploymentConfigProps
An implementation forLambdaDeploymentConfigProps
Example:A fluent builder forLambdaDeploymentGroup
.Properties of a reference to a CodeDeploy Lambda Deployment Group.A builder forLambdaDeploymentGroupAttributes
An implementation forLambdaDeploymentGroupAttributes
Construction properties forLambdaDeploymentGroup
.A builder forLambdaDeploymentGroupProps
An implementation forLambdaDeploymentGroupProps
Represents the configuration specific to linear traffic shifting.A builder forLinearTrafficRoutingConfig
An implementation forLinearTrafficRoutingConfig
An interface of an abstract load balancer, as needed by CodeDeploy.The generations of AWS load balancing solutions.Minimum number of healthy hosts for a server deployment.Minimum number of healthy hosts per availability zone for a server deployment.A CodeDeploy Application that deploys to EC2/on-premise instances.A fluent builder forServerApplication
.Construction properties forServerApplication
.A builder forServerApplicationProps
An implementation forServerApplicationProps
A custom Deployment Configuration for an EC2/on-premise Deployment Group.A fluent builder forServerDeploymentConfig
.Construction properties ofServerDeploymentConfig
.A builder forServerDeploymentConfigProps
An implementation forServerDeploymentConfigProps
A CodeDeploy Deployment Group that deploys to EC2/on-premise instances.A fluent builder forServerDeploymentGroup
.Properties of a reference to a CodeDeploy EC2/on-premise Deployment Group.A builder forServerDeploymentGroupAttributes
An implementation forServerDeploymentGroupAttributes
Construction properties forServerDeploymentGroup
.A builder forServerDeploymentGroupProps
An implementation forServerDeploymentGroupProps
Define a traffic routing config of type 'TimeBasedCanary'.A fluent builder forTimeBasedCanaryTrafficRouting
.Construction properties forTimeBasedCanaryTrafficRouting
.A builder forTimeBasedCanaryTrafficRoutingProps
An implementation forTimeBasedCanaryTrafficRoutingProps
Define a traffic routing config of type 'TimeBasedLinear'.A fluent builder forTimeBasedLinearTrafficRouting
.Construction properties forTimeBasedLinearTrafficRouting
.A builder forTimeBasedLinearTrafficRoutingProps
An implementation forTimeBasedLinearTrafficRoutingProps
Represents how traffic is shifted during a CodeDeploy deployment.Represents the structure to pass into the underlying CfnDeploymentConfig class.A builder forTrafficRoutingConfig
An implementation forTrafficRoutingConfig
Configuration for CodeDeploy to deploy your application to one Availability Zone at a time within an AWS Region.A builder forZonalConfig
An implementation forZonalConfig