Skip to content
v2.277.0

LambdaDeploymentGroupProps Struct ​

Construction properties for LambdaDeploymentGroup.

Example ​

ts
declare const myApplication: codedeploy.LambdaApplication;
declare const func: lambda.Function;
const version = func.currentVersion;
const version1Alias = new lambda.Alias(this, 'alias', {
  aliasName: 'prod',
  version,
});

const deploymentGroup = new codedeploy.LambdaDeploymentGroup(this, 'BlueGreenDeployment', {
  application: myApplication, // optional property: one will be created for you if not provided
  alias: version1Alias,
  deploymentConfig: codedeploy.LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE,
});
python
# my_application: codedeploy.LambdaApplication
# func: lambda.Function

version = func.current_version
version1_alias = lambda_.Alias(self, "alias",
    alias_name="prod",
    version=version
)

deployment_group = codedeploy.LambdaDeploymentGroup(self, "BlueGreenDeployment",
    application=my_application,  # optional property: one will be created for you if not provided
    alias=version1_alias,
    deployment_config=codedeploy.LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE
)
java
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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
LambdaApplication myApplication;
Function func;

var version = func.CurrentVersion;
var version1Alias = new Alias(this, "alias", new AliasProps {
    AliasName = "prod",
    Version = version
});

var deploymentGroup = new LambdaDeploymentGroup(this, "BlueGreenDeployment", new LambdaDeploymentGroupProps {
    Application = myApplication,  // optional property: one will be created for you if not provided
    Alias = version1Alias,
    DeploymentConfig = LambdaDeploymentConfig.LINEAR_10PERCENT_EVERY_1MINUTE
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var myApplication LambdaApplication
var func Function

version := func.currentVersion
version1Alias := lambda.NewAlias(this, jsii.String("alias"), &AliasProps{
	AliasName: jsii.String("prod"),
	Version: Version,
})

deploymentGroup := codedeploy.NewLambdaDeploymentGroup(this, jsii.String("BlueGreenDeployment"), &LambdaDeploymentGroupProps{
	Application: myApplication,
	 // optional property: one will be created for you if not provided
	Alias: version1Alias,
	DeploymentConfig: codedeploy.LambdaDeploymentConfig_LINEAR_10PERCENT_EVERY_1MINUTE(),
})

Properties ​

alarmsoptionalIAlarmRef[]alarmsoptionaltyping.List[IAlarmRef]alarmsoptionalList<IAlarmRef>AlarmsoptionalIAlarmRef[]Alarmsoptional*[]IAlarmRef = [] #
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.

aliasAliasaliasAliasaliasAliasAliasAliasAliasAlias required #
Lambda Alias to shift traffic. Updating the version of the alias will trigger a CodeDeploy deployment.

[disable-awslint:ref-via-interface] since we need to modify the alias CFN resource update policy

applicationoptionalILambdaApplicationapplicationoptionalILambdaApplicationapplicationoptionalILambdaApplicationApplicationoptionalILambdaApplicationApplicationoptionalILambdaApplication #
The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.

Default: One will be created for you.

autoRollbackoptionalAutoRollbackConfigauto_rollbackoptionalAutoRollbackConfigautoRollbackoptionalAutoRollbackConfigAutoRollbackoptionalAutoRollbackConfigAutoRollbackoptionalAutoRollbackConfig #
The auto-rollback configuration for this Deployment Group.

Default: default AutoRollbackConfig.

deploymentConfigoptionalILambdaDeploymentConfigdeployment_configoptionalILambdaDeploymentConfigdeploymentConfigoptionalILambdaDeploymentConfigDeploymentConfigoptionalILambdaDeploymentConfigDeploymentConfigoptionalILambdaDeploymentConfig #
The Deployment Configuration this Deployment Group uses.

Default: LambdaDeploymentConfig.CANARY_10PERCENT_5MINUTES

deploymentGroupNameoptionalstringdeployment_group_nameoptionalstrdeploymentGroupNameoptionalStringDeploymentGroupNameoptionalstringDeploymentGroupNameoptional*string #
The physical, human-readable name of the CodeDeploy Deployment Group.

Default: An auto-generated name will be used.

ignoreAlarmConfigurationoptionalbooleanignore_alarm_configurationoptionalboolignoreAlarmConfigurationoptionalBooleanIgnoreAlarmConfigurationoptionalboolIgnoreAlarmConfigurationoptional*bool = false #
Whether to skip the step of checking CloudWatch alarms during the deployment process.
ignorePollAlarmsFailureoptionalbooleanignore_poll_alarms_failureoptionalboolignorePollAlarmsFailureoptionalBooleanIgnorePollAlarmsFailureoptionalboolIgnorePollAlarmsFailureoptional*bool = false #
Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.
postHookoptionalIFunctionpost_hookoptionalIFunctionpostHookoptionalIFunctionPostHookoptionalIFunctionPostHookoptionalIFunction = None. #
The Lambda function to run after traffic routing starts.
preHookoptionalIFunctionpre_hookoptionalIFunctionpreHookoptionalIFunctionPreHookoptionalIFunctionPreHookoptionalIFunction = None. #
The Lambda function to run before traffic routing starts.
roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole #
The service Role of this Deployment Group.

Default: A new Role will be created.