Package software.amazon.awscdk.services.ecs

Interface CfnService.DeploymentCircuitBreakerProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.DeploymentCircuitBreakerProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.DeploymentCircuitBreakerProperty
extends software.amazon.jsii.JsiiSerializable

The deployment circuit breaker can only be used for services using the rolling update ( ECS ) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .

For more information about API failure reasons, see API failure reasons 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.services.ecs.*;
 DeploymentCircuitBreakerProperty deploymentCircuitBreakerProperty = DeploymentCircuitBreakerProperty.builder()
         .enable(false)
         .rollback(false)
         // the properties below are optional
         .resetOnHealthyTask(false)
         .thresholdConfiguration(ThresholdConfigurationProperty.builder()
                 .type("type")
                 .value(123)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.DeploymentCircuitBreakerProperty.Builder	builder()
Object	getEnable()	Determines whether to use the deployment circuit breaker logic for the service.
default Object	getResetOnHealthyTask()	Specifies whether the deployment circuit breaker resets its failure count when a task reaches a healthy state.
Object	getRollback()	Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
default Object	getThresholdConfiguration()	Defines the failure threshold that the deployment circuit breaker uses to monitor a deployment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnable

@Stability(Stable)
@NotNull
Object getEnable()

Determines whether to use the deployment circuit breaker logic for the service.

Returns union: either Boolean or IResolvable

See Also:

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

getRollback

@Stability(Stable)
@NotNull
Object getRollback()

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

If rollback is on, 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-deploymentcircuitbreaker.html#cfn-ecs-service-deploymentcircuitbreaker-rollback

getResetOnHealthyTask

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

Specifies whether the deployment circuit breaker resets its failure count when a task reaches a healthy state.

When set to true, a task that reaches a healthy state resets the failure count to 0. When set to false, Amazon ECS does not reset the failure count. The default is true.

Returns union: either Boolean or IResolvable

See Also:

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

getThresholdConfiguration

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

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.

Returns union: either IResolvable or CfnService.ThresholdConfigurationProperty

See Also:

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

builder

@Stability(Stable)
static CfnService.DeploymentCircuitBreakerProperty.Builder builder()

Returns:

a CfnService.DeploymentCircuitBreakerProperty.Builder of CfnService.DeploymentCircuitBreakerProperty