LambdaDeploymentGroupProps

class aws_cdk.aws_codedeploy.LambdaDeploymentGroupProps(*, alias, alarms=None, application=None, auto_rollback=None, deployment_config=None, deployment_group_name=None, ignore_alarm_configuration=None, ignore_poll_alarms_failure=None, post_hook=None, pre_hook=None, role=None)

Bases: object

Construction properties for LambdaDeploymentGroup.

Parameters:

  • alias (Alias) – 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

  • alarms (Optional[Sequence[IAlarm]]) – 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: []

  • application (Optional[ILambdaApplication]) – The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to. Default: - One will be created for you.

  • auto_rollback (Union[AutoRollbackConfig, Dict[str, Any], None]) – The auto-rollback configuration for this Deployment Group. Default: - default AutoRollbackConfig.

  • deployment_config (Optional[ILambdaDeploymentConfig]) – The Deployment Configuration this Deployment Group uses. Default: LambdaDeploymentConfig.CANARY_10PERCENT_5MINUTES

  • deployment_group_name (Optional[str]) – The physical, human-readable name of the CodeDeploy Deployment Group. Default: - An auto-generated name will be used.

  • ignore_alarm_configuration (Optional[bool]) – Whether to skip the step of checking CloudWatch alarms during the deployment process. Default: - false

  • ignore_poll_alarms_failure (Optional[bool]) – Whether to continue a deployment even if fetching the alarm status from CloudWatch failed. Default: false

  • post_hook (Optional[IFunction]) – The Lambda function to run after traffic routing starts. Default: - None.

  • pre_hook (Optional[IFunction]) – The Lambda function to run before traffic routing starts. Default: - None.

  • role (Optional[IRole]) – The service Role of this Deployment Group. Default: - A new Role will be created.

ExampleMetadata:

infused

Example:

# 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
)

Attributes

alarms

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:

[]

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.

[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.

Default:

  • One will be created for you.

auto_rollback

The auto-rollback configuration for this Deployment Group.

Default:

  • default AutoRollbackConfig.

deployment_config

The Deployment Configuration this Deployment Group uses.

Default:

LambdaDeploymentConfig.CANARY_10PERCENT_5MINUTES

deployment_group_name

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

Default:

  • An auto-generated name will be used.

ignore_alarm_configuration

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

Default:

  • false

ignore_poll_alarms_failure

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

Default:

false

post_hook

The Lambda function to run after traffic routing starts.

Default:

  • None.

pre_hook

The Lambda function to run before traffic routing starts.

Default:

  • None.

role

The service Role of this Deployment Group.

Default:

  • A new Role will be created.