Class EcsDeploymentGroupProps

Construction properties for EcsDeploymentGroup.

Inheritance

object

EcsDeploymentGroupProps

Implements

IEcsDeploymentGroupProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.CodeDeploy

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EcsDeploymentGroupProps : IEcsDeploymentGroupProps

Syntax (vb)

Public Class EcsDeploymentGroupProps Implements 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

Constructors

EcsDeploymentGroupProps()

Construction properties for EcsDeploymentGroup.

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.

Constructors

EcsDeploymentGroupProps()

Construction properties for EcsDeploymentGroup.

public EcsDeploymentGroupProps()

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

Properties

Alarms

The CloudWatch alarms associated with this Deployment Group.

public IAlarmRef[]? Alarms { get; set; }

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

Application

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

public IApplicationRef? Application { get; set; }

Property Value

IApplicationRef

Remarks

Default: One will be created for you.

AutoRollback

The auto-rollback configuration for this Deployment Group.

public IAutoRollbackConfig? AutoRollback { get; set; }

Property Value

IAutoRollbackConfig

Remarks

Default: - default AutoRollbackConfig.

BlueGreenDeploymentConfig

The configuration options for blue-green ECS deployments.

public IEcsBlueGreenDeploymentConfig BlueGreenDeploymentConfig { get; set; }

Property Value

IEcsBlueGreenDeploymentConfig

Remarks

ExampleMetadata: infused

DeploymentConfig

The Deployment Configuration this Deployment Group uses.

public IDeploymentConfigRef? DeploymentConfig { get; set; }

Property Value

IDeploymentConfigRef

Remarks

Default: EcsDeploymentConfig.ALL_AT_ONCE

DeploymentGroupName

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

public string? DeploymentGroupName { get; set; }

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.

public bool? IgnoreAlarmConfiguration { get; set; }

Property Value

bool?

Remarks

Default: - false

IgnorePollAlarmsFailure

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

public bool? IgnorePollAlarmsFailure { get; set; }

Property Value

bool?

Remarks

Default: false

Role

The service Role of this Deployment Group.

public IRole? Role { get; set; }

Property Value

IRole

Remarks

Default: - A new Role will be created.

Service

The ECS service to deploy with this Deployment Group.

public IBaseService Service { get; set; }

Property Value

IBaseService

Remarks

ExampleMetadata: infused

Implements

IEcsDeploymentGroupProps