Interface CfnService.IDeploymentAlarmsProperty

One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDeploymentAlarmsProperty

Syntax (vb)

Public Interface IDeploymentAlarmsProperty

Remarks

When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.

You can only use the DeploymentAlarms method to detect failures when the DeploymentController is set to ECS (rolling update).

For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;

var deploymentAlarmsProperty = new DeploymentAlarmsProperty {
    AlarmNames = new [] { "alarmNames" },
    Enable = false,
    Rollback = false
};

Synopsis

Properties

AlarmNames	One or more CloudWatch alarm names.
Enable	Determines whether to use the CloudWatch alarm option in the service deployment process.
Rollback	Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.

Properties

AlarmNames

One or more CloudWatch alarm names.

string[] AlarmNames { get; }

Property Value

System.String[]

Remarks

Use a "," to separate the alarms.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html#cfn-ecs-service-deploymentalarms-alarmnames

Enable

Determines whether to use the CloudWatch alarm option in the service deployment process.

object Enable { get; }

Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html#cfn-ecs-service-deploymentalarms-enable

Rollback

Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.

object Rollback { get; }

Property Value

System.Object

Remarks

If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-deploymentalarms.html#cfn-ecs-service-deploymentalarms-rollback