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

Interface CfnServicePropsMixin.ThresholdConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServicePropsMixin.ThresholdConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnServicePropsMixin

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

Defines the failure threshold that the deployment circuit breaker uses to monitor a deployment.

The type and value together determine the number of task failures that are tolerated before the circuit breaker triggers. By default, the threshold configuration uses a type of BOUNDED_PERCENT with a value of 50.

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.*;
 ThresholdConfigurationProperty thresholdConfigurationProperty = ThresholdConfigurationProperty.builder()
         .type("type")
         .value(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnServicePropsMixin.ThresholdConfigurationProperty.Builder	builder()
default String	getType()	Determines how Amazon ECS uses value to calculate the failure threshold.
default Number	getValue()	Specifies the integer that Amazon ECS uses to calculate the failure threshold.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@Nullable
default String getType()

Determines how Amazon ECS uses value to calculate the failure threshold.

For the percentage types (BOUNDED_PERCENT and UNBOUNDED_PERCENT), Amazon ECS multiplies value by the latest service desired count. For COUNT, Amazon ECS uses value directly as the threshold. The default is BOUNDED_PERCENT.

See Also:

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

getValue

@Stability(Stable)
@Nullable
default Number getValue()

Specifies the integer that Amazon ECS uses to calculate the failure threshold.

When type is COUNT, this value is the failure threshold itself. When type is a percentage type, Amazon ECS multiplies this value by the latest service desired count to produce the failure threshold. The default is 50.

See Also:

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

builder

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

Returns:

a CfnServicePropsMixin.ThresholdConfigurationProperty.Builder of CfnServicePropsMixin.ThresholdConfigurationProperty