Package software.amazon.awscdk.services.stepfunctions

Class CfnStateMachineAlias.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.CfnStateMachineAlias.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStateMachineAlias>

Enclosing class:

CfnStateMachineAlias

@Stability(Stable)
public static final class CfnStateMachineAlias.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStateMachineAlias>

A fluent builder for CfnStateMachineAlias.

Method Summary

Modifier and Type	Method	Description
CfnStateMachineAlias	build()
static CfnStateMachineAlias.Builder	create(software.constructs.Construct scope, String id)
CfnStateMachineAlias.Builder	deploymentPreference(IResolvable deploymentPreference)	The settings that enable gradual state machine deployments.
CfnStateMachineAlias.Builder	deploymentPreference(CfnStateMachineAlias.DeploymentPreferenceProperty deploymentPreference)	The settings that enable gradual state machine deployments.
CfnStateMachineAlias.Builder	description(String description)	An optional description of the state machine alias.
CfnStateMachineAlias.Builder	name(String name)	The name of the state machine alias.
CfnStateMachineAlias.Builder	routingConfiguration(List<? extends Object> routingConfiguration)	The routing configuration of an alias.
CfnStateMachineAlias.Builder	routingConfiguration(IResolvable routingConfiguration)	The routing configuration of an alias.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnStateMachineAlias.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnStateMachineAlias.Builder.

deploymentPreference

@Stability(Stable)
public CfnStateMachineAlias.Builder deploymentPreference(IResolvable deploymentPreference)

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.

Parameters:

deploymentPreference - The settings that enable gradual state machine deployments. This parameter is required.

Returns:

this

See Also:

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

deploymentPreference

@Stability(Stable)
public CfnStateMachineAlias.Builder deploymentPreference(CfnStateMachineAlias.DeploymentPreferenceProperty deploymentPreference)

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.

Parameters:

deploymentPreference - The settings that enable gradual state machine deployments. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnStateMachineAlias.Builder description(String description)

An optional description of the state machine alias.

Parameters:

description - An optional description of the state machine alias. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnStateMachineAlias.Builder name(String name)

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.

Parameters:

name - The name of the state machine alias. This parameter is required.

Returns:

this

See Also:

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

routingConfiguration

@Stability(Stable)
public CfnStateMachineAlias.Builder routingConfiguration(IResolvable routingConfiguration)

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.

Parameters:

routingConfiguration - The routing configuration of an alias. This parameter is required.

Returns:

this

See Also:

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

routingConfiguration

@Stability(Stable)
public CfnStateMachineAlias.Builder routingConfiguration(List<? extends Object> routingConfiguration)

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.

Parameters:

routingConfiguration - The routing configuration of an alias. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnStateMachineAlias build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnStateMachineAlias>

Returns:

a newly built instance of CfnStateMachineAlias.