Package software.amazon.awscdk.services.ecs

Interface ForceNewDeployment

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ForceNewDeployment.Jsii$Proxy

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-06-16T16:14:24.179Z")
@Stability(Stable)
public interface ForceNewDeployment
extends software.amazon.jsii.JsiiSerializable

Configuration for forcing a new deployment of the service.

Example:

 Cluster cluster;
 TaskDefinition taskDefinition;
 // Force a new deployment on every `cdk deploy` by using a time-based nonce
 FargateService service = FargateService.Builder.create(this, "Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .forceNewDeployment(ForceNewDeployment.builder()
                 .enabled(true)
                 .nonce(Date.now().toString())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ForceNewDeployment.Builder	builder()
Boolean	getEnabled()	Whether to enable the force-new-deployment mechanism for the service.
default String	getNonce()	A unique nonce value that signals Amazon ECS to start a new deployment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@NotNull
Boolean getEnabled()

Whether to enable the force-new-deployment mechanism for the service.

Setting this to true enables the mechanism, but on its own it does not force a new deployment on every cdk deploy: CloudFormation only starts a new deployment when it detects a change in the template, and the signal for that is the nonce value changing between deployments. If nonce is not provided or its value stays the same across deployments, no new deployment is forced. When set to false, the ForceNewDeployment property is rendered with EnableForceNewDeployment: false.

To force a new deployment on every cdk deploy, provide a nonce with a unique, time-varying value such as a timestamp, random string, or sequence number (e.g. Date.now().toString()).

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-properties-ecs-service-forcenewdeployment.html

getNonce

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

A unique nonce value that signals Amazon ECS to start a new deployment.

When you change this value, it triggers a new deployment even though no other service parameters have changed. Use a stable, time-varying value like a commit hash, image digest, or version string.

If not provided and enabled is true, only EnableForceNewDeployment is set without a nonce.

Must be between 1 and 255 characters.

Default: - no nonce

builder

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

Returns:

a ForceNewDeployment.Builder of ForceNewDeployment