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

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

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

    Using getStateMachineAlias

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getStateMachineAlias(args: GetStateMachineAliasArgs, opts?: InvokeOptions): Promise<GetStateMachineAliasResult>
function getStateMachineAliasOutput(args: GetStateMachineAliasOutputArgs, opts?: InvokeOptions): Output<GetStateMachineAliasResult>
    def get_state_machine_alias(arn: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetStateMachineAliasResult
def get_state_machine_alias_output(arn: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetStateMachineAliasResult]
    func LookupStateMachineAlias(ctx *Context, args *LookupStateMachineAliasArgs, opts ...InvokeOption) (*LookupStateMachineAliasResult, error)
func LookupStateMachineAliasOutput(ctx *Context, args *LookupStateMachineAliasOutputArgs, opts ...InvokeOption) LookupStateMachineAliasResultOutput

    > Note: This function is named LookupStateMachineAlias in the Go SDK.

    public static class GetStateMachineAlias 
{
    public static Task<GetStateMachineAliasResult> InvokeAsync(GetStateMachineAliasArgs args, InvokeOptions? opts = null)
    public static Output<GetStateMachineAliasResult> Invoke(GetStateMachineAliasInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStateMachineAliasResult> getStateMachineAlias(GetStateMachineAliasArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:stepfunctions:getStateMachineAlias
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The ARN of the alias.
    Arn string
    The ARN of the alias.
    arn String
    The ARN of the alias.
    arn string
    The ARN of the alias.
    arn str
    The ARN of the alias.
    arn String
    The ARN of the alias.

    getStateMachineAlias Result

    The following output properties are available:

    Arn string
    The ARN of the alias.
    Description string
    An optional description of the alias.
    RoutingConfiguration List<Pulumi.AwsNative.StepFunctions.Outputs.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.

    Arn string
    The ARN of the alias.
    Description string
    An optional description of the alias.
    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.

    arn String
    The ARN of the alias.
    description String
    An optional description of the alias.
    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.

    arn string
    The ARN of the alias.
    description string
    An optional description of the alias.
    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.

    arn str
    The ARN of the alias.
    description str
    An optional description of the alias.
    routing_configuration Sequence[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.

    arn String
    The ARN of the alias.
    description String
    An optional description of the alias.
    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.

    Supporting Types

    StateMachineAliasRoutingConfigurationVersion

    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