Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-stepfunctions-statemachinealias.json
Parent schema serverless-framework-configuration
Type: object

Properties

Name string | Aws_CF_FunctionString

The alias name.

Description string | Aws_CF_FunctionString

An optional description of the alias.

RoutingConfiguration RoutingConfigurationVersion[]

The routing configuration of the alias. One or two versions can be mapped to an alias to split StartExecution requests of the same state machine.

minItems=1maxItems=2uniqueItems=true
DeploymentPreference object

The settings to enable gradual state machine deployments.

5 nested properties
StateMachineVersionArn string | Aws_CF_FunctionString required
Type string | Aws_CF_FunctionString required

The type of deployment to perform.

Percentage integer

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

min=1max=99
Interval integer

The time in minutes between each traffic shifting increment.

min=1max=2100
Alarms string[]

A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state.

minItems=1maxItems=100uniqueItems=true

One of

1. variant
2. variant

Definitions

RoutingConfigurationVersion object
StateMachineVersionArn string | Aws_CF_FunctionString required

The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.

Weight integer required

The percentage of traffic you want to route to the state machine version. The sum of the weights in the routing configuration must be equal to 100.

min=0max=100
RoutingConfiguration RoutingConfigurationVersion[]

The routing configuration of the alias. One or two versions can be mapped to an alias to split StartExecution requests of the same state machine.

DeploymentPreference object

The settings to enable gradual state machine deployments.

StateMachineVersionArn string | Aws_CF_FunctionString required
Type string | Aws_CF_FunctionString required

The type of deployment to perform.

Percentage integer

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

min=1max=99
Interval integer

The time in minutes between each traffic shifting increment.

min=1max=2100
Alarms string[]

A list of CloudWatch alarm names that will be monitored during the deployment. The deployment will fail and rollback if any alarms go into ALARM state.

minItems=1maxItems=100uniqueItems=true