Class CfnStateMachineAliasPropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStateMachineAliasPropsMixin>
- Enclosing class:
CfnStateMachineAliasPropsMixin
CfnStateMachineAliasPropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionbuild()create()create(CfnPropertyMixinOptions options) deploymentPreference(IResolvable deploymentPreference) The settings that enable gradual state machine deployments.deploymentPreference(CfnStateMachineAliasPropsMixin.DeploymentPreferenceProperty deploymentPreference) The settings that enable gradual state machine deployments.description(String description) An optional description of the state machine alias.The name of the state machine alias.routingConfiguration(List<? extends Object> routingConfiguration) The routing configuration of an alias.routingConfiguration(IResolvable routingConfiguration) The routing configuration of an alias.
-
Method Details
-
create
@Stability(Stable) public static CfnStateMachineAliasPropsMixin.Builder create(CfnPropertyMixinOptions options) - Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnStateMachineAliasPropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnStateMachineAliasPropsMixin.Builder.
-
deploymentPreference
@Stability(Stable) public CfnStateMachineAliasPropsMixin.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.
RoutingConfigurationandDeploymentPreferenceare 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
20with an interval of600minutes, 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:
-
deploymentPreference
@Stability(Stable) public CfnStateMachineAliasPropsMixin.Builder deploymentPreference(CfnStateMachineAliasPropsMixin.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.
RoutingConfigurationandDeploymentPreferenceare 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
20with an interval of600minutes, 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:
-
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:
-
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:
-
routingConfiguration
@Stability(Stable) public CfnStateMachineAliasPropsMixin.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
RoutingConfigurationif you want to explicitly set the alias weights . Weight is the percentage of traffic you want to route to a state machine version.RoutingConfigurationandDeploymentPreferenceare 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:
-
routingConfiguration
@Stability(Stable) public CfnStateMachineAliasPropsMixin.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
RoutingConfigurationif you want to explicitly set the alias weights . Weight is the percentage of traffic you want to route to a state machine version.RoutingConfigurationandDeploymentPreferenceare 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:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnStateMachineAliasPropsMixin>- Returns:
- a newly built instance of
CfnStateMachineAliasPropsMixin.
-