Interface ICfnStateMachineAliasProps

Properties for defining a CfnStateMachineAlias.

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnStateMachineAliasProps

Syntax (vb)

Public Interface ICfnStateMachineAliasProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.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 cfnStateMachineAliasProps = new CfnStateMachineAliasProps {
                 DeploymentPreference = new DeploymentPreferenceProperty {
                     StateMachineVersionArn = "stateMachineVersionArn",
                     Type = "type",

                     // the properties below are optional
                     Alarms = new [] { "alarms" },
                     Interval = 123,
                     Percentage = 123
                 },
                 Description = "description",
                 Name = "name",
                 RoutingConfiguration = new [] { new RoutingConfigurationVersionProperty {
                     StateMachineVersionArn = "stateMachineVersionArn",
                     Weight = 123
                 } }
             };

Synopsis

Properties

DeploymentPreference	The settings that enable gradual state machine deployments.
Description	An optional description of the state machine alias.
Name	The name of the state machine alias.
RoutingConfiguration	The routing configuration of an alias.

Properties

DeploymentPreference

The settings that enable gradual state machine deployments.

object? DeploymentPreference { get; }

Property Value

object

Remarks

These settings include Alarms , Interval , Percentage , StateMachineVersionArn , and Type .

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

<code>RoutingConfiguration</code> and <code>DeploymentPreference</code> are mutually exclusive properties. You must define only one of these properties.

Based on the type of deployment you want to perform, you can specify one of the following settings:

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 Amazon 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.

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

Description

An optional description of the state machine alias.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-description

Name

The name of the state machine alias.

string? Name { get; }

Property Value

string

Remarks

If you don't provide a name, it uses an automatically generated name based on the logical ID.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-name

RoutingConfiguration

The routing configuration of an alias.

object? RoutingConfiguration { get; }

Property Value

object

Remarks

Routing configuration splits StartExecution requests between one or two versions of the same state machine.

Use RoutingConfiguration if you want to explicitly set the alias weights . Weight is the percentage of traffic you want to route to a state machine version.

<code>RoutingConfiguration</code> and <code>DeploymentPreference</code> are mutually exclusive properties. You must define only one of these properties.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html#cfn-stepfunctions-statemachinealias-routingconfiguration