Package software.amazon.awscdk.cfnpropertymixins.services.stepfunctions

Class CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.stepfunctions.CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty>

Enclosing interface:

CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

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

A builder for CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder	alarms(List<String> alarms)	Sets the value of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.getAlarms()
CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty	build()	Builds the configured instance.
CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder	interval(Number interval)	Sets the value of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.getInterval()
CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder	percentage(Number percentage)	Sets the value of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.getPercentage()
CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder	stateMachineVersionArn(String stateMachineVersionArn)	Sets the value of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.getStateMachineVersionArn()
CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder	type(String type)	Sets the value of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.getType()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

alarms

@Stability(Stable)
public CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder alarms(List<String> alarms)

Sets the value of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.getAlarms()

Parameters:

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

Returns:

this

interval

@Stability(Stable)
public CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder interval(Number interval)

Sets the value of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.getInterval()

Parameters:

interval - The time in minutes between each traffic shifting increment.

Returns:

this

percentage

@Stability(Stable)
public CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder percentage(Number percentage)

Sets the value of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.getPercentage()

Parameters:

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

Returns:

this

stateMachineVersionArn

@Stability(Stable)
public CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder stateMachineVersionArn(String stateMachineVersionArn)

Sets the value of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.getStateMachineVersionArn()

Parameters:

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

Returns:

this

type

@Stability(Stable)
public CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder type(String type)

Sets the value of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.getType()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty>

Returns:

a new instance of CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

Throws:

NullPointerException - if any required attribute was not provided