EcsDeploymentGroupProps

class aws_cdk.aws_codedeploy.EcsDeploymentGroupProps(*, blue_green_deployment_config, service, alarms=None, application=None, auto_rollback=None, deployment_config=None, deployment_group_name=None, ignore_alarm_configuration=None, ignore_poll_alarms_failure=None, role=None)

Bases: object

Construction properties for EcsDeploymentGroup.

Parameters:

blue_green_deployment_config (Union[EcsBlueGreenDeploymentConfig, Dict[str, Any]]) – The configuration options for blue-green ECS deployments.
service (IBaseService) – The ECS service to deploy with this Deployment Group.
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[IEcsApplication]) – The reference to the CodeDeploy ECS 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[IEcsDeploymentConfig]) – The Deployment Configuration this Deployment Group uses. Default: EcsDeploymentConfig.ALL_AT_ONCE
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
role (Optional[IRole]) – The service Role of this Deployment Group. Default: - A new Role will be created.

ExampleMetadata:

infused

Example:

# my_application: codedeploy.EcsApplication
# cluster: ecs.Cluster
# task_definition: ecs.FargateTaskDefinition
# blue_target_group: elbv2.ITargetGroup
# green_target_group: elbv2.ITargetGroup
# listener: elbv2.IApplicationListener


service = ecs.FargateService(self, "Service",
    cluster=cluster,
    task_definition=task_definition,
    deployment_controller=ecs.DeploymentController(
        type=ecs.DeploymentControllerType.CODE_DEPLOY
    )
)

codedeploy.EcsDeploymentGroup(self, "BlueGreenDG",
    service=service,
    blue_green_deployment_config=codedeploy.EcsBlueGreenDeploymentConfig(
        blue_target_group=blue_target_group,
        green_target_group=green_target_group,
        listener=listener
    ),
    deployment_config=codedeploy.EcsDeploymentConfig.CANARY_10PERCENT_5MINUTES
)

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

application

The reference to the CodeDeploy ECS 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.

blue_green_deployment_config: The configuration options for blue-green ECS deployments.

deployment_config

The Deployment Configuration this Deployment Group uses.

Default:: EcsDeploymentConfig.ALL_AT_ONCE

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

role

The service Role of this Deployment Group.

Default:

A new Role will be created.

service: The ECS service to deploy with this Deployment Group.