LambdaDeploymentGroupProps¶
-
class
aws_cdk.aws_codedeploy.
LambdaDeploymentGroupProps
(*, alias, alarms=None, application=None, auto_rollback=None, deployment_config=None, deployment_group_name=None, ignore_poll_alarms_failure=None, post_hook=None, pre_hook=None, role=None)¶ Bases:
object
Construction properties for {@link 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 policyalarms (
Optional
[List
[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 {@link #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 (
Optional
[AutoRollbackConfig
]) – 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_5MINUTESdeployment_group_name (
Optional
[str
]) – The physical, human-readable name of the CodeDeploy Deployment Group. Default: - An auto-generated name will be used.ignore_poll_alarms_failure (
Optional
[bool
]) – Whether to continue a deployment even if fetching the alarm status from CloudWatch failed. Default: falsepost_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.
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 {@link #addAlarm} method.
- Default
[]
- See
https://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-create-alarms.html
- Return type
Optional
[List
[IAlarm
]]
-
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
- Return type
-
application
¶ The reference to the CodeDeploy Lambda Application that this Deployment Group belongs to.
- Default
One will be created for you.
- Return type
Optional
[ILambdaApplication
]
-
auto_rollback
¶ The auto-rollback configuration for this Deployment Group.
- Default
default AutoRollbackConfig.
- Return type
Optional
[AutoRollbackConfig
]
-
deployment_config
¶ The Deployment Configuration this Deployment Group uses.
- Default
LambdaDeploymentConfig.CANARY_10PERCENT_5MINUTES
- Return type
Optional
[ILambdaDeploymentConfig
]
-
deployment_group_name
¶ The physical, human-readable name of the CodeDeploy Deployment Group.
- Default
An auto-generated name will be used.
- Return type
Optional
[str
]
-
ignore_poll_alarms_failure
¶ Whether to continue a deployment even if fetching the alarm status from CloudWatch failed.
- Default
false
- Return type
Optional
[bool
]
-
post_hook
¶ The Lambda function to run after traffic routing starts.
- Default
None.
- Return type
Optional
[IFunction
]