Interface CfnStateMachineAlias.IDeploymentPreferenceProperty

Enables gradual state machine deployments.

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnStateMachineAlias.IDeploymentPreferenceProperty

Syntax (vb)

Public Interface CfnStateMachineAlias.IDeploymentPreferenceProperty

Remarks

CloudFormation automatically shifts traffic from the version the alias currently points to, to a new state machine version that you specify.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.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.AWS.StepFunctions;

             var deploymentPreferenceProperty = new DeploymentPreferenceProperty {
                 StateMachineVersionArn = "stateMachineVersionArn",
                 Type = "type",

                 // the properties below are optional
                 Alarms = new [] { "alarms" },
                 Interval = 123,
                 Percentage = 123
             };

Synopsis

Properties

Alarms	A list of Amazon CloudWatch alarm names to be monitored during the deployment.
Interval	The time in minutes between each traffic shifting increment.
Percentage	The percentage of traffic to shift to the new version in each increment.
StateMachineVersionArn	The Amazon Resource Name (ARN) of the `AWS::StepFunctions::StateMachineVersion` resource that will be the final version to which the alias points to when the traffic shifting is complete.
Type	The type of deployment you want to perform. You can specify one of the following types:.

Properties

Alarms

A list of Amazon CloudWatch alarm names to be monitored during the deployment.

string[]? Alarms { get; }

Property Value

string[]

Remarks

The deployment fails and rolls back if any of these alarms go into the ALARM state.

Amazon CloudWatch considers nonexistent alarms to have an <code>OK</code> state. If you provide an invalid alarm name or provide the ARN of an alarm instead of its name, your deployment may not roll back correctly.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-alarms

Interval

The time in minutes between each traffic shifting increment.

double? Interval { get; }

Property Value

double?

Remarks

Percentage

The percentage of traffic to shift to the new version in each increment.

double? Percentage { get; }

Property Value

double?

Remarks

StateMachineVersionArn

The Amazon Resource Name (ARN) of the AWS::StepFunctions::StateMachineVersion resource that will be the final version to which the alias points to when the traffic shifting is complete.

string StateMachineVersionArn { get; }

Property Value

string

Remarks

While performing gradual deployments, you can only provide a single state machine version ARN. To explicitly set version weights in a CloudFormation template, use RoutingConfiguration instead.

Type

The type of deployment you want to perform. You can specify one of the following types:.

string Type { get; }

Property Value

string

Remarks

For example, if you specify the increment percent as 20 with an interval of 600 minutes, this deployment increases traffic by 20 percent every 600 minutes until the new version receives 100 percent of the traffic. This deployment immediately rolls back the new version if any CloudWatch alarms are triggered.

In the first increment, a small percentage of traffic, for example, 10 percent is shifted to the new version. In the second increment, before a specified time interval in seconds gets over, the remaining traffic is shifted to the new version. The shift to the new version for the remaining traffic takes place only if no CloudWatch alarms are triggered during the specified time interval.