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

Class CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.stepfunctions.CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Jsii$Proxy

All Implemented Interfaces:

CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

@Stability(Stable)
@Internal
public static final class CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

An implementation for CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.stepfunctions.CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder, CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getAlarms()	A list of Amazon CloudWatch alarm names to be monitored during the deployment.
final Number	getInterval()	The time in minutes between each traffic shifting increment.
final Number	getPercentage()	The percentage of traffic to shift to the new version in each increment.
final 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.
final String	getType()	The type of deployment you want to perform.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty.Builder.

Method Details

getAlarms

public final List<String> getAlarms()

Description copied from interface: CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

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.

Specified by:

getAlarms in interface CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

See Also:

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

getInterval

public final Number getInterval()

Description copied from interface: CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

The time in minutes between each traffic shifting increment.

Specified by:

getInterval in interface CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

See Also:

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

getPercentage

public final Number getPercentage()

Description copied from interface: CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

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

Specified by:

getPercentage in interface CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

See Also:

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

getStateMachineVersionArn

public final String getStateMachineVersionArn()

Description copied from interface: CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

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.

Specified by:

getStateMachineVersionArn in interface CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

See Also:

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

getType

public final String getType()

Description copied from interface: CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

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.

Specified by:

getType in interface CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object