Class CfnServicePropsMixin.CanaryConfigurationProperty

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.

Inheritance

object

CfnServicePropsMixin.CanaryConfigurationProperty

Implements

CfnServicePropsMixin.ICanaryConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.ECS.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnServicePropsMixin.CanaryConfigurationProperty : CfnServicePropsMixin.ICanaryConfigurationProperty

Syntax (vb)

Public Class CfnServicePropsMixin.CanaryConfigurationProperty Implements CfnServicePropsMixin.ICanaryConfigurationProperty

Remarks

The following validation applies only to Canary deployments created through CloudFormation . CloudFormation operations time out after 36 hours. Canary deployments can approach this limit because of their extended duration. This can cause CloudFormation to roll back the deployment. To prevent timeout-related rollbacks, 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.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.ECS.Mixins;

             var canaryConfigurationProperty = new CanaryConfigurationProperty {
                 CanaryBakeTimeInMinutes = 123,
                 CanaryPercent = 123
             };

Synopsis

Constructors

CanaryConfigurationProperty()

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.

Properties

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

Constructors

CanaryConfigurationProperty()

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.

public CanaryConfigurationProperty()

Remarks

The following validation applies only to Canary deployments created through CloudFormation . CloudFormation operations time out after 36 hours. Canary deployments can approach this limit because of their extended duration. This can cause CloudFormation to roll back the deployment. To prevent timeout-related rollbacks, 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.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.ECS.Mixins;

             var canaryConfigurationProperty = new CanaryConfigurationProperty {
                 CanaryBakeTimeInMinutes = 123,
                 CanaryPercent = 123
             };

Properties

CanaryBakeTimeInMinutes

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

public double? CanaryBakeTimeInMinutes { get; set; }

Property Value

double?

Remarks

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

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

CanaryPercent

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

public double? CanaryPercent { get; set; }

Property Value

double?

Remarks

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

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

Implements

CfnServicePropsMixin.ICanaryConfigurationProperty