Interface IEcsDeploymentGroupProps

Construction properties for EcsDeploymentGroup.

Namespace: Amazon.CDK.AWS.CodeDeploy
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IEcsDeploymentGroupProps
Syntax (vb)
Public Interface IEcsDeploymentGroupProps
Remarks

ExampleMetadata: infused

Examples
EcsApplication myApplication;
Cluster cluster;
FargateTaskDefinition taskDefinition;
ITargetGroup blueTargetGroup;
ITargetGroup greenTargetGroup;
IApplicationListener listener;


var service = new FargateService(this, "Service", new FargateServiceProps {
    Cluster = cluster,
    TaskDefinition = taskDefinition,
    DeploymentController = new DeploymentController {
        Type = DeploymentControllerType.CODE_DEPLOY
    }
});

new EcsDeploymentGroup(this, "BlueGreenDG", new EcsDeploymentGroupProps {
    Service = service,
    BlueGreenDeploymentConfig = new EcsBlueGreenDeploymentConfig {
        BlueTargetGroup = blueTargetGroup,
        GreenTargetGroup = greenTargetGroup,
        Listener = listener
    },
    DeploymentConfig = EcsDeploymentConfig.CANARY_10PERCENT_5MINUTES
});

Synopsis

Properties

Alarms

The CloudWatch alarms associated with this Deployment Group.
Application

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

The auto-rollback configuration for this Deployment Group.
BlueGreenDeploymentConfig

The configuration options for blue-green ECS deployments.
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.
Role

The service Role of this Deployment Group.
Service

The ECS service to deploy with this Deployment Group.

Properties

Alarms

The CloudWatch alarms associated with this Deployment Group.

virtual IAlarm[] Alarms { get; }
Property Value

IAlarm[]

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

Application

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

virtual IEcsApplication Application { get; }
Property Value

IEcsApplication

Remarks

Default: One will be created for you.

AutoRollback

The auto-rollback configuration for this Deployment Group.

virtual IAutoRollbackConfig AutoRollback { get; }
Property Value

IAutoRollbackConfig

Remarks

Default: - default AutoRollbackConfig.

BlueGreenDeploymentConfig

The configuration options for blue-green ECS deployments.

IEcsBlueGreenDeploymentConfig BlueGreenDeploymentConfig { get; }
Property Value

IEcsBlueGreenDeploymentConfig

DeploymentConfig

The Deployment Configuration this Deployment Group uses.

virtual IEcsDeploymentConfig DeploymentConfig { get; }
Property Value

IEcsDeploymentConfig

Remarks

Default: EcsDeploymentConfig.ALL_AT_ONCE

DeploymentGroupName

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

virtual string DeploymentGroupName { get; }
Property Value

System.String

Remarks

Default: An auto-generated name will be used.

IgnoreAlarmConfiguration

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

virtual Nullable<bool> IgnoreAlarmConfiguration { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: - false

IgnorePollAlarmsFailure

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

virtual Nullable<bool> IgnorePollAlarmsFailure { get; }
Property Value

System.Nullable<System.Boolean>

Remarks

Default: false

Role

The service Role of this Deployment Group.

virtual IRole Role { get; }
Property Value

IRole

Remarks

Default: - A new Role will be created.

Service

The ECS service to deploy with this Deployment Group.

IBaseService Service { get; }
Property Value

IBaseService