Interface ILambdaDeploymentGroupProps

Construction properties for LambdaDeploymentGroup.

Namespace: Amazon.CDK.AWS.CodeDeploy

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ILambdaDeploymentGroupProps

Syntax (vb)

Public Interface ILambdaDeploymentGroupProps

Remarks

ExampleMetadata: infused

Examples

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
            });

Synopsis

Properties

Alarms	The CloudWatch alarms associated with this Deployment Group.
Alias	Lambda Alias to shift traffic. Updating the version of the alias will trigger a CodeDeploy deployment.
Application	The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.
AutoRollback	The auto-rollback configuration for this Deployment Group.
DeploymentConfig	The Deployment Configuration this Deployment Group uses.
DeploymentGroupName	The physical, human-readable name of the CodeDeploy Deployment Group.
IgnoreAlarmConfiguration	Whether to skip the step of checking CloudWatch alarms during the deployment process.
IgnorePollAlarmsFailure	Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.
PostHook	The Lambda function to run after traffic routing starts.
PreHook	The Lambda function to run before traffic routing starts.
Role	The service Role of this Deployment Group.

Properties

Alarms

The CloudWatch alarms associated with this Deployment Group.

IAlarmRef[]? Alarms { get; }

Property Value

IAlarmRef[]

Remarks

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: https://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-create-alarms.html

Alias

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

Alias Alias { get; }

Property Value

Alias

Remarks

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

Application

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

ILambdaApplication? Application { get; }

Property Value

ILambdaApplication

Remarks

Default: - One will be created for you.

AutoRollback

The auto-rollback configuration for this Deployment Group.

IAutoRollbackConfig? AutoRollback { get; }

Property Value

IAutoRollbackConfig

Remarks

Default: - default AutoRollbackConfig.

DeploymentConfig

The Deployment Configuration this Deployment Group uses.

ILambdaDeploymentConfig? DeploymentConfig { get; }

Property Value

ILambdaDeploymentConfig

Remarks

Default: LambdaDeploymentConfig.CANARY_10PERCENT_5MINUTES

DeploymentGroupName

The physical, human-readable name of the CodeDeploy Deployment Group.

string? DeploymentGroupName { get; }

Property Value

string

Remarks

Default: - An auto-generated name will be used.

IgnoreAlarmConfiguration

Whether to skip the step of checking CloudWatch alarms during the deployment process.

bool? IgnoreAlarmConfiguration { get; }

Property Value

bool?

Remarks

Default: - false

IgnorePollAlarmsFailure

Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.

bool? IgnorePollAlarmsFailure { get; }

Property Value

bool?

Remarks

Default: false

PostHook

The Lambda function to run after traffic routing starts.

IFunction? PostHook { get; }

Property Value

IFunction

Remarks

Default: - None.

PreHook

The Lambda function to run before traffic routing starts.

IFunction? PreHook { get; }

Property Value

IFunction

Remarks

Default: - None.

Role

The service Role of this Deployment Group.

IRole? Role { get; }

Property Value

IRole

Remarks

Default: - A new Role will be created.