Package software.amazon.awscdk.cfnpropertymixins.services.ecs

Interface CfnServicePropsMixin.DeploymentAlarmsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServicePropsMixin.DeploymentAlarmsProperty.Jsii$Proxy

Enclosing class:

CfnServicePropsMixin

@Stability(Stable)
public static interface CfnServicePropsMixin.DeploymentAlarmsProperty
extends software.amazon.jsii.JsiiSerializable

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.

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 .

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ecs.*;
 DeploymentAlarmsProperty deploymentAlarmsProperty = DeploymentAlarmsProperty.builder()
         .alarmNames(List.of("alarmNames"))
         .enable(false)
         .rollback(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnServicePropsMixin.DeploymentAlarmsProperty.Builder	A builder for CfnServicePropsMixin.DeploymentAlarmsProperty
static final class	CfnServicePropsMixin.DeploymentAlarmsProperty.Jsii$Proxy	An implementation for CfnServicePropsMixin.DeploymentAlarmsProperty

Method Summary

Modifier and Type	Method	Description
static CfnServicePropsMixin.DeploymentAlarmsProperty.Builder	builder()
default List<Object>	getAlarmNames()	One or more CloudWatch alarm names.
default Object	getEnable()	Determines whether to use the CloudWatch alarm option in the service deployment process.
default Object	getRollback()	Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarmNames

@Stability(Stable)
@Nullable
default List<Object> getAlarmNames()

One or more CloudWatch alarm names.

Use a "," to separate the alarms.

Returns union: Listinvalid input: '<'either String or IAlarmRef>

See Also:

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

getEnable

@Stability(Stable)
@Nullable
default Object getEnable()

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

Returns union: either Boolean or IResolvable

See Also:

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

getRollback

@Stability(Stable)
@Nullable
default Object getRollback()

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

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

Returns union: either Boolean or IResolvable

See Also:

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

builder

@Stability(Stable)
static CfnServicePropsMixin.DeploymentAlarmsProperty.Builder builder()

Returns:

a CfnServicePropsMixin.DeploymentAlarmsProperty.Builder of CfnServicePropsMixin.DeploymentAlarmsProperty