Package software.amazon.awscdk.services.ecs

Interface CfnService.CanaryConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.CanaryConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

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

Configuration for a canary deployment strategy that shifts a fixed percentage of traffic to the new service revision, waits for a specified bake time, then shifts the remaining traffic.

The following validation applies only to Canary deployments created through AWS CloudFormation . AWS CloudFormation operations time out after 36 hours. Canary deployments can approach this limit because of their extended duration. This can cause AWS CloudFormation to roll back the deployment. To prevent timeout-related rollbacks, AWS CloudFormation rejects deployments when the calculated deployment time exceeds 33 hours based on your template configuration:

BakeTimeInMinutes + CanaryBakeTimeInMinutes

Additional backend processes (such as task scaling and running lifecycle hooks) can extend deployment time beyond these calculations. Even deployments under the 33-hour threshold might still time out if these processes cause the total duration to exceed 36 hours.

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.*;
 CanaryConfigurationProperty canaryConfigurationProperty = CanaryConfigurationProperty.builder()
         .canaryBakeTimeInMinutes(123)
         .canaryPercent(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.CanaryConfigurationProperty.Builder	builder()
default Number	getCanaryBakeTimeInMinutes()	The amount of time in minutes to wait during the canary phase before shifting the remaining production traffic to the new service revision.
default Number	getCanaryPercent()	The percentage of production traffic to shift to the new service revision during the canary phase.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCanaryBakeTimeInMinutes

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

The amount of time in minutes to wait during the canary phase before shifting the remaining production traffic to the new service revision.

Valid values are 0 to 1440 minutes (24 hours). The default value is 10.

See Also:

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

getCanaryPercent

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

The percentage of production traffic to shift to the new service revision during the canary phase.

Valid values are multiples of 0.1 from 0.1 to 100.0. The default value is 5.0.

See Also:

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

builder

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

Returns:

a CfnService.CanaryConfigurationProperty.Builder of CfnService.CanaryConfigurationProperty