See: Description
Interface | Description |
---|---|
AutoRollbackConfig |
The configuration for automatically rolling back deployments in a given Deployment Group.
|
CfnApplicationProps |
Properties for defining a `CfnApplication`.
|
CfnDeploymentConfig.MinimumHealthyHostsProperty |
`MinimumHealthyHosts` is a property of the [DeploymentConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentconfig.html) resource that defines how many instances must remain healthy during an AWS CodeDeploy deployment.
|
CfnDeploymentConfig.TimeBasedCanaryProperty |
A configuration that shifts traffic from one version of a Lambda function or Amazon ECS task set to another in two increments.
|
CfnDeploymentConfig.TimeBasedLinearProperty |
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.
|
CfnDeploymentConfig.TrafficRoutingConfigProperty |
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.
|
CfnDeploymentConfigProps |
Properties for defining a `CfnDeploymentConfig`.
|
CfnDeploymentGroup.AlarmConfigurationProperty |
The `AlarmConfiguration` property type configures CloudWatch alarms for an AWS CodeDeploy deployment group.
|
CfnDeploymentGroup.AlarmProperty |
The `Alarm` property type specifies a CloudWatch alarm to use for an AWS CodeDeploy deployment group.
|
CfnDeploymentGroup.AutoRollbackConfigurationProperty |
The `AutoRollbackConfiguration` property type configures automatic rollback for an AWS CodeDeploy deployment group when a deployment is not completed successfully.
|
CfnDeploymentGroup.BlueGreenDeploymentConfigurationProperty |
Information about blue/green deployment options for a deployment group.
|
CfnDeploymentGroup.BlueInstanceTerminationOptionProperty |
Information about whether instances in the original environment are terminated when a blue/green deployment is successful.
|
CfnDeploymentGroup.DeploymentProperty |
`Deployment` is a property of the [DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource that specifies an AWS CodeDeploy application revision to be deployed to instances in the deployment group.
|
CfnDeploymentGroup.DeploymentReadyOptionProperty |
Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.
|
CfnDeploymentGroup.DeploymentStyleProperty |
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.
|
CfnDeploymentGroup.EC2TagFilterProperty |
Information about an Amazon EC2 tag filter.
|
CfnDeploymentGroup.EC2TagSetListObjectProperty |
The `EC2TagSet` property type specifies information about groups of tags applied to Amazon EC2 instances.
|
CfnDeploymentGroup.EC2TagSetProperty |
The `EC2TagSet` property type specifies information about groups of tags applied to Amazon EC2 instances.
|
CfnDeploymentGroup.ECSServiceProperty |
Contains the service and cluster names used to identify an Amazon ECS deployment's target.
|
CfnDeploymentGroup.ELBInfoProperty |
The `ELBInfo` property type specifies information about the Elastic Load Balancing load balancer used for an CodeDeploy deployment group.
|
CfnDeploymentGroup.GitHubLocationProperty |
`GitHubLocation` is a property of the [CodeDeploy DeploymentGroup Revision](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html) property that specifies the location of an application revision that is stored in GitHub.
|
CfnDeploymentGroup.GreenFleetProvisioningOptionProperty |
Information about the instances that belong to the replacement environment in a blue/green deployment.
|
CfnDeploymentGroup.LoadBalancerInfoProperty |
The `LoadBalancerInfo` property type specifies information about the load balancer or target group used for an AWS CodeDeploy deployment group.
|
CfnDeploymentGroup.OnPremisesTagSetListObjectProperty |
The `OnPremisesTagSetListObject` property type specifies lists of on-premises instance tag groups.
|
CfnDeploymentGroup.OnPremisesTagSetProperty |
The `OnPremisesTagSet` property type specifies a list containing other lists of on-premises instance tag groups.
|
CfnDeploymentGroup.RevisionLocationProperty |
`RevisionLocation` is a property that defines the location of the CodeDeploy application revision to deploy.
|
CfnDeploymentGroup.S3LocationProperty |
`S3Location` is a property of the [CodeDeploy DeploymentGroup Revision](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-deployment-revision.html) property that specifies the location of an application revision that is stored in Amazon Simple Storage Service ( Amazon S3 ).
|
CfnDeploymentGroup.TagFilterProperty |
`TagFilter` is a property type of the [AWS::CodeDeploy::DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource that specifies which on-premises instances to associate with the deployment group.
|
CfnDeploymentGroup.TargetGroupInfoProperty |
The `TargetGroupInfo` property type specifies information about a target group in Elastic Load Balancing to use in a deployment.
|
CfnDeploymentGroup.TargetGroupPairInfoProperty |
Information about two target groups and how traffic is routed during an Amazon ECS deployment.
|
CfnDeploymentGroup.TrafficRouteProperty |
Information about a listener.
|
CfnDeploymentGroup.TriggerConfigProperty |
Information about notification triggers for the deployment group.
|
CfnDeploymentGroupProps |
Properties for defining a `CfnDeploymentGroup`.
|
CustomLambdaDeploymentConfigProps |
Properties of a reference to a CodeDeploy Lambda Deployment Configuration.
|
EcsApplicationProps |
Construction properties for
EcsApplication . |
EcsDeploymentGroupAttributes |
Properties of a reference to a CodeDeploy ECS Deployment Group.
|
IEcsApplication |
Represents a reference to a CodeDeploy Application deploying to Amazon ECS.
|
IEcsApplication.Jsii$Default |
Internal default implementation for
IEcsApplication . |
IEcsDeploymentConfig |
The Deployment Configuration of an ECS Deployment Group.
|
IEcsDeploymentConfig.Jsii$Default |
Internal default implementation for
IEcsDeploymentConfig . |
IEcsDeploymentGroup |
Interface for an ECS deployment group.
|
IEcsDeploymentGroup.Jsii$Default |
Internal default implementation for
IEcsDeploymentGroup . |
ILambdaApplication |
Represents a reference to a CodeDeploy Application deploying to AWS Lambda.
|
ILambdaApplication.Jsii$Default |
Internal default implementation for
ILambdaApplication . |
ILambdaDeploymentConfig |
The Deployment Configuration of a Lambda Deployment Group.
|
ILambdaDeploymentConfig.Jsii$Default |
Internal default implementation for
ILambdaDeploymentConfig . |
ILambdaDeploymentGroup |
Interface for a Lambda deployment groups.
|
ILambdaDeploymentGroup.Jsii$Default |
Internal default implementation for
ILambdaDeploymentGroup . |
IServerApplication |
Represents a reference to a CodeDeploy Application deploying to EC2/on-premise instances.
|
IServerApplication.Jsii$Default |
Internal default implementation for
IServerApplication . |
IServerDeploymentConfig |
The Deployment Configuration of an EC2/on-premise Deployment Group.
|
IServerDeploymentConfig.Jsii$Default |
Internal default implementation for
IServerDeploymentConfig . |
IServerDeploymentGroup | |
IServerDeploymentGroup.Jsii$Default |
Internal default implementation for
IServerDeploymentGroup . |
LambdaApplicationProps |
Construction properties for
LambdaApplication . |
LambdaDeploymentConfigImportProps |
Properties of a reference to a CodeDeploy Lambda Deployment Configuration.
|
LambdaDeploymentGroupAttributes |
Properties of a reference to a CodeDeploy Lambda Deployment Group.
|
LambdaDeploymentGroupProps |
Construction properties for
LambdaDeploymentGroup . |
ServerApplicationProps |
Construction properties for
ServerApplication . |
ServerDeploymentConfigProps |
Construction properties of
ServerDeploymentConfig . |
ServerDeploymentGroupAttributes |
Properties of a reference to a CodeDeploy EC2/on-premise Deployment Group.
|
ServerDeploymentGroupProps |
Construction properties for
ServerDeploymentGroup . |
Enum | Description |
---|---|
CustomLambdaDeploymentConfigType |
Lambda Deployment config type.
|
LoadBalancerGeneration |
The generations of AWS load balancing solutions.
|
---
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 and AWS Lambda 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");
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) // auto-rollback configuration .autoRollback(AutoRollbackConfig.builder() .failedDeployment(true) // default: true .stoppedDeployment(true) // default: false .deploymentInAlarm(true) .build()) .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());
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:
import software.amazon.awscdk.services.elasticloadbalancingv2.*; 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();
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");
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");
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:
const version = func.currentVersion
.
CodeDeploy for Lambda comes with built-in configurations for traffic shifting. If you want to specify your own strategy, you can do so with the CustomLambdaDeploymentConfig construct, letting you specify precisely how fast a new function version is deployed.
LambdaApplication application; Alias alias; CustomLambdaDeploymentConfig config = CustomLambdaDeploymentConfig.Builder.create(this, "CustomConfig") .type(CustomLambdaDeploymentConfigType.CANARY) .interval(Duration.minutes(1)) .percentage(5) .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.
CustomLambdaDeploymentConfig config = CustomLambdaDeploymentConfig.Builder.create(this, "CustomConfig") .type(CustomLambdaDeploymentConfigType.CANARY) .interval(Duration.minutes(1)) .percentage(5) .deploymentConfigName("MyDeploymentConfig") .build();
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());
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);
To import an already existing Deployment Group:
LambdaApplication application; ILambdaDeploymentGroup deploymentGroup = LambdaDeploymentGroup.fromLambdaDeploymentGroupAttributes(this, "ExistingCodeDeployDeploymentGroup", LambdaDeploymentGroupAttributes.builder() .application(application) .deploymentGroupName("MyExistingDeploymentGroup") .build());