Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. stepfunctions
  5. StateMachineAlias

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.stepfunctions.StateMachineAlias

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for StateMachineAlias

    Create StateMachineAlias Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new StateMachineAlias(name: string, args?: StateMachineAliasArgs, opts?: CustomResourceOptions);
    @overload
def StateMachineAlias(resource_name: str,
                      args: Optional[StateMachineAliasArgs] = None,
                      opts: Optional[ResourceOptions] = None)

@overload
def StateMachineAlias(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      deployment_preference: Optional[StateMachineAliasDeploymentPreferenceArgs] = None,
                      description: Optional[str] = None,
                      name: Optional[str] = None,
                      routing_configuration: Optional[Sequence[StateMachineAliasRoutingConfigurationVersionArgs]] = None)
    func NewStateMachineAlias(ctx *Context, name string, args *StateMachineAliasArgs, opts ...ResourceOption) (*StateMachineAlias, error)
    public StateMachineAlias(string name, StateMachineAliasArgs? args = null, CustomResourceOptions? opts = null)
    public StateMachineAlias(String name, StateMachineAliasArgs args)
public StateMachineAlias(String name, StateMachineAliasArgs args, CustomResourceOptions options)

    type: aws-native:stepfunctions:StateMachineAlias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args StateMachineAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StateMachineAliasArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StateMachineAliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StateMachineAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StateMachineAliasArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    StateMachineAlias Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The StateMachineAlias resource accepts the following input properties:

    DeploymentPreference Pulumi.AwsNative.StepFunctions.Inputs.StateMachineAliasDeploymentPreference

    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.

    RoutingConfiguration and DeploymentPreference are 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 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 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.

    Description string
    An optional description of the alias.
    Name string
    The alias name.
    RoutingConfiguration List<Pulumi.AwsNative.StepFunctions.Inputs.StateMachineAliasRoutingConfigurationVersion>

    The routing configuration of an alias. Routing configuration splits StartExecution requests between one or two versions of the same state machine.

    Use RoutingConfiguration if you want to explicitly set the alias weights . Weight is the percentage of traffic you want to route to a state machine version.

    RoutingConfiguration and DeploymentPreference are mutually exclusive properties. You must define only one of these properties.

    DeploymentPreference StateMachineAliasDeploymentPreferenceArgs

    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.

    RoutingConfiguration and DeploymentPreference are 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 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 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.

    Description string
    An optional description of the alias.
    Name string
    The alias name.
    RoutingConfiguration []StateMachineAliasRoutingConfigurationVersionArgs

    The routing configuration of an alias. Routing configuration splits StartExecution requests between one or two versions of the same state machine.

    Use RoutingConfiguration if you want to explicitly set the alias weights . Weight is the percentage of traffic you want to route to a state machine version.

    RoutingConfiguration and DeploymentPreference are mutually exclusive properties. You must define only one of these properties.

    deploymentPreference StateMachineAliasDeploymentPreference

    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.

    RoutingConfiguration and DeploymentPreference are 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 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 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.

    description String
    An optional description of the alias.
    name String
    The alias name.
    routingConfiguration List<StateMachineAliasRoutingConfigurationVersion>

    The routing configuration of an alias. Routing configuration splits StartExecution requests between one or two versions of the same state machine.

    Use RoutingConfiguration if you want to explicitly set the alias weights . Weight is the percentage of traffic you want to route to a state machine version.

    RoutingConfiguration and DeploymentPreference are mutually exclusive properties. You must define only one of these properties.

    deploymentPreference StateMachineAliasDeploymentPreference

    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.

    RoutingConfiguration and DeploymentPreference are 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 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 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.

    description string
    An optional description of the alias.
    name string
    The alias name.
    routingConfiguration StateMachineAliasRoutingConfigurationVersion[]

    The routing configuration of an alias. Routing configuration splits StartExecution requests between one or two versions of the same state machine.

    Use RoutingConfiguration if you want to explicitly set the alias weights . Weight is the percentage of traffic you want to route to a state machine version.

    RoutingConfiguration and DeploymentPreference are mutually exclusive properties. You must define only one of these properties.

    deployment_preference StateMachineAliasDeploymentPreferenceArgs

    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.

    RoutingConfiguration and DeploymentPreference are 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 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 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.

    description str
    An optional description of the alias.
    name str
    The alias name.
    routing_configuration Sequence[StateMachineAliasRoutingConfigurationVersionArgs]

    The routing configuration of an alias. Routing configuration splits StartExecution requests between one or two versions of the same state machine.

    Use RoutingConfiguration if you want to explicitly set the alias weights . Weight is the percentage of traffic you want to route to a state machine version.

    RoutingConfiguration and DeploymentPreference are mutually exclusive properties. You must define only one of these properties.

    deploymentPreference Property Map

    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.

    RoutingConfiguration and DeploymentPreference are 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 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 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.

    description String
    An optional description of the alias.
    name String
    The alias name.
    routingConfiguration List<Property Map>

    The routing configuration of an alias. Routing configuration splits StartExecution requests between one or two versions of the same state machine.

    Use RoutingConfiguration if you want to explicitly set the alias weights . Weight is the percentage of traffic you want to route to a state machine version.

    RoutingConfiguration and DeploymentPreference are mutually exclusive properties. You must define only one of these properties.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StateMachineAlias resource produces the following output properties:

    Arn string
    The ARN of the alias.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The ARN of the alias.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN of the alias.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The ARN of the alias.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The ARN of the alias.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The ARN of the alias.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    StateMachineAliasDeploymentPreference, StateMachineAliasDeploymentPreferenceArgs

    StateMachineVersionArn string

    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.

    Type Pulumi.AwsNative.StepFunctions.StateMachineAliasDeploymentPreferenceType
    The type of deployment to perform.
    Alarms List<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.
    Interval int
    The time in minutes between each traffic shifting increment.
    Percentage int
    The percentage of traffic to shift to the new version in each increment.
    StateMachineVersionArn string

    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.

    Type StateMachineAliasDeploymentPreferenceType
    The type of deployment to perform.
    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.
    Interval int
    The time in minutes between each traffic shifting increment.
    Percentage int
    The percentage of traffic to shift to the new version in each increment.
    stateMachineVersionArn String

    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.

    type StateMachineAliasDeploymentPreferenceType
    The type of deployment to perform.
    alarms List<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.
    interval Integer
    The time in minutes between each traffic shifting increment.
    percentage Integer
    The percentage of traffic to shift to the new version in each increment.
    stateMachineVersionArn string

    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.

    type StateMachineAliasDeploymentPreferenceType
    The type of deployment to perform.
    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.
    interval number
    The time in minutes between each traffic shifting increment.
    percentage number
    The percentage of traffic to shift to the new version in each increment.
    state_machine_version_arn str

    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.

    type StateMachineAliasDeploymentPreferenceType
    The type of deployment to perform.
    alarms Sequence[str]
    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.
    interval int
    The time in minutes between each traffic shifting increment.
    percentage int
    The percentage of traffic to shift to the new version in each increment.
    stateMachineVersionArn String

    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.

    type "LINEAR" | "ALL_AT_ONCE" | "CANARY"
    The type of deployment to perform.
    alarms List<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.
    interval Number
    The time in minutes between each traffic shifting increment.
    percentage Number
    The percentage of traffic to shift to the new version in each increment.

    StateMachineAliasDeploymentPreferenceType, StateMachineAliasDeploymentPreferenceTypeArgs

    Linear
    LINEAR
    AllAtOnce
    ALL_AT_ONCE
    Canary
    CANARY
    StateMachineAliasDeploymentPreferenceTypeLinear
    LINEAR
    StateMachineAliasDeploymentPreferenceTypeAllAtOnce
    ALL_AT_ONCE
    StateMachineAliasDeploymentPreferenceTypeCanary
    CANARY
    Linear
    LINEAR
    AllAtOnce
    ALL_AT_ONCE
    Canary
    CANARY
    Linear
    LINEAR
    AllAtOnce
    ALL_AT_ONCE
    Canary
    CANARY
    LINEAR
    LINEAR
    ALL_AT_ONCE
    ALL_AT_ONCE
    CANARY
    CANARY
    "LINEAR"
    LINEAR
    "ALL_AT_ONCE"
    ALL_AT_ONCE
    "CANARY"
    CANARY

    StateMachineAliasRoutingConfigurationVersion, StateMachineAliasRoutingConfigurationVersionArgs

    StateMachineVersionArn string
    The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
    Weight int
    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.
    StateMachineVersionArn string
    The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
    Weight int
    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.
    stateMachineVersionArn String
    The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
    weight Integer
    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.
    stateMachineVersionArn string
    The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
    weight number
    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.
    state_machine_version_arn str
    The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
    weight int
    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.
    stateMachineVersionArn String
    The Amazon Resource Name (ARN) that identifies one or two state machine versions defined in the routing configuration.
    weight Number
    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.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native