Package software.amazon.awscdk.services.stepfunctions

Interface CfnStateMachineAlias.DeploymentPreferenceProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStateMachineAlias.DeploymentPreferenceProperty.Jsii$Proxy

Enclosing class:

CfnStateMachineAlias

@Stability(Stable)
public static interface CfnStateMachineAlias.DeploymentPreferenceProperty
extends software.amazon.jsii.JsiiSerializable

Enables gradual state machine deployments.

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

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.*;
 DeploymentPreferenceProperty deploymentPreferenceProperty = DeploymentPreferenceProperty.builder()
         .stateMachineVersionArn("stateMachineVersionArn")
         .type("type")
         // the properties below are optional
         .alarms(List.of("alarms"))
         .interval(123)
         .percentage(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnStateMachineAlias.DeploymentPreferenceProperty.Builder	builder()
default List<String>	getAlarms()	A list of Amazon CloudWatch alarm names to be monitored during the deployment.
default Number	getInterval()	The time in minutes between each traffic shifting increment.
default Number	getPercentage()	The percentage of traffic to shift to the new version in each increment.
String	getStateMachineVersionArn()	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	getType()	The type of deployment you want to perform.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStateMachineVersionArn

@Stability(Stable)
@NotNull
String getStateMachineVersionArn()

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.

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.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

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

• 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 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-properties-stepfunctions-statemachinealias-deploymentpreference.html#cfn-stepfunctions-statemachinealias-deploymentpreference-type

getAlarms

@Stability(Stable)
@Nullable
default List<String> getAlarms()

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

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

Amazon CloudWatch considers nonexistent alarms to have an OK 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 Also:

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

getInterval

@Stability(Stable)
@Nullable
default Number getInterval()

The time in minutes between each traffic shifting increment.

See Also:

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

getPercentage

@Stability(Stable)
@Nullable
default Number getPercentage()

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

See Also:

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

builder

@Stability(Stable)
static CfnStateMachineAlias.DeploymentPreferenceProperty.Builder builder()

Returns:

a CfnStateMachineAlias.DeploymentPreferenceProperty.Builder of CfnStateMachineAlias.DeploymentPreferenceProperty