Package software.amazon.awscdk.services.stepfunctions

Interface CfnStateMachineAliasProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStateMachineAliasProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:27.705Z")
@Stability(Stable)
public interface CfnStateMachineAliasProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStateMachineAlias.

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.stepfunctions.*;
 CfnStateMachineAliasProps cfnStateMachineAliasProps = CfnStateMachineAliasProps.builder()
         .deploymentPreference(DeploymentPreferenceProperty.builder()
                 .stateMachineVersionArn("stateMachineVersionArn")
                 .type("type")
                 // the properties below are optional
                 .alarms(List.of("alarms"))
                 .interval(123)
                 .percentage(123)
                 .build())
         .description("description")
         .name("name")
         .routingConfiguration(List.of(RoutingConfigurationVersionProperty.builder()
                 .stateMachineVersionArn("stateMachineVersionArn")
                 .weight(123)
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachinealias.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnStateMachineAliasProps.Builder	builder()
default Object	getDeploymentPreference()	The settings that enable gradual state machine deployments.
default String	getDescription()	An optional description of the state machine alias.
default String	getName()	The name of the state machine alias.
default Object	getRoutingConfiguration()	The routing configuration of an alias.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeploymentPreference

@Stability(Stable)
@Nullable
default Object getDeploymentPreference()

The settings that enable gradual state machine deployments.

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.

RoutingConfiguration and DeploymentPreference 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:

• LINEAR - Shifts traffic to the new version in equal increments with an equal number of minutes between each increment.

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.

• ALL_AT_ONCE - Shifts 100 percent of traffic to the new version immediately. CloudFormation monitors the new version and rolls it back automatically to the previous version if any CloudWatch alarms are triggered.
• CANARY - Shifts traffic in two increments.

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 Also:

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

getDescription

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

An optional description of the state machine alias.

See Also:

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

getName

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

The name of the state machine alias.

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

See Also:

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

getRoutingConfiguration

@Stability(Stable)
@Nullable
default Object getRoutingConfiguration()

The routing configuration of an alias.

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.

RoutingConfiguration and DeploymentPreference are mutually exclusive properties. You must define only one of these properties.

See Also:

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

builder

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

Returns:

a CfnStateMachineAliasProps.Builder of CfnStateMachineAliasProps