Package software.amazon.awscdk.services.ecs

Interface DeploymentCircuitBreaker

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DeploymentCircuitBreaker.Jsii$Proxy

@Generated(value="jsii-pacmak/1.130.0 (build 048a5ee)",
           date="2026-05-21T17:27:35.856Z")
@Stability(Stable)
public interface DeploymentCircuitBreaker
extends software.amazon.jsii.JsiiSerializable

The deployment circuit breaker to use for the service.

Example:

 Cluster cluster;
 ApplicationLoadBalancedFargateService service = ApplicationLoadBalancedFargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .desiredCount(1)
         .cpu(512)
         .taskImageOptions(ApplicationLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("amazon/amazon-ecs-sample"))
                 .build())
         .minHealthyPercent(100)
         .circuitBreaker(DeploymentCircuitBreaker.builder().rollback(true).build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DeploymentCircuitBreaker.Builder	builder()
default Boolean	getEnable()	Whether to enable the deployment circuit breaker logic.
default Boolean	getRollback()	Whether to enable rollback on deployment failure.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnable

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

Whether to enable the deployment circuit breaker logic.

Default: true

getRollback

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

Whether to enable rollback on deployment failure.

Default: false

builder

@Stability(Stable)
static DeploymentCircuitBreaker.Builder builder()

Returns:

a DeploymentCircuitBreaker.Builder of DeploymentCircuitBreaker