1. Packages
  2. AWS Classic
  3. API Docs
  4. sfn
  5. getAlias

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.sfn.getAlias

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Data source for managing an AWS SFN (Step Functions) State Machine Alias.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.sfn.getAlias({
        name: "my_sfn_alias",
        statemachineArn: sfnTest.arn,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.sfn.get_alias(name="my_sfn_alias",
        statemachine_arn=sfn_test["arn"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sfn"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sfn.LookupAlias(ctx, &sfn.LookupAliasArgs{
    			Name:            "my_sfn_alias",
    			StatemachineArn: sfnTest.Arn,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.Sfn.GetAlias.Invoke(new()
        {
            Name = "my_sfn_alias",
            StatemachineArn = sfnTest.Arn,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.sfn.SfnFunctions;
    import com.pulumi.aws.sfn.inputs.GetAliasArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = SfnFunctions.getAlias(GetAliasArgs.builder()
                .name("my_sfn_alias")
                .statemachineArn(sfnTest.arn())
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:sfn:getAlias
          Arguments:
            name: my_sfn_alias
            statemachineArn: ${sfnTest.arn}
    

    Using getAlias

    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 getAlias(args: GetAliasArgs, opts?: InvokeOptions): Promise<GetAliasResult>
    function getAliasOutput(args: GetAliasOutputArgs, opts?: InvokeOptions): Output<GetAliasResult>
    def get_alias(description: Optional[str] = None,
                  name: Optional[str] = None,
                  statemachine_arn: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetAliasResult
    def get_alias_output(description: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  statemachine_arn: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetAliasResult]
    func LookupAlias(ctx *Context, args *LookupAliasArgs, opts ...InvokeOption) (*LookupAliasResult, error)
    func LookupAliasOutput(ctx *Context, args *LookupAliasOutputArgs, opts ...InvokeOption) LookupAliasResultOutput

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

    public static class GetAlias 
    {
        public static Task<GetAliasResult> InvokeAsync(GetAliasArgs args, InvokeOptions? opts = null)
        public static Output<GetAliasResult> Invoke(GetAliasInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAliasResult> getAlias(GetAliasArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:sfn/getAlias:getAlias
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the State Machine alias.
    StatemachineArn string
    ARN of the State Machine.
    Description string
    Description of state machine alias.
    Name string
    Name of the State Machine alias.
    StatemachineArn string
    ARN of the State Machine.
    Description string
    Description of state machine alias.
    name String
    Name of the State Machine alias.
    statemachineArn String
    ARN of the State Machine.
    description String
    Description of state machine alias.
    name string
    Name of the State Machine alias.
    statemachineArn string
    ARN of the State Machine.
    description string
    Description of state machine alias.
    name str
    Name of the State Machine alias.
    statemachine_arn str
    ARN of the State Machine.
    description str
    Description of state machine alias.
    name String
    Name of the State Machine alias.
    statemachineArn String
    ARN of the State Machine.
    description String
    Description of state machine alias.

    getAlias Result

    The following output properties are available:

    Arn string
    ARN identifying the State Machine alias.
    CreationDate string
    Date the state machine Alias was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    RoutingConfigurations List<GetAliasRoutingConfiguration>
    Routing Configuration of state machine alias
    StatemachineArn string
    Description string
    Description of state machine alias.
    Arn string
    ARN identifying the State Machine alias.
    CreationDate string
    Date the state machine Alias was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    RoutingConfigurations []GetAliasRoutingConfiguration
    Routing Configuration of state machine alias
    StatemachineArn string
    Description string
    Description of state machine alias.
    arn String
    ARN identifying the State Machine alias.
    creationDate String
    Date the state machine Alias was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    routingConfigurations List<GetAliasRoutingConfiguration>
    Routing Configuration of state machine alias
    statemachineArn String
    description String
    Description of state machine alias.
    arn string
    ARN identifying the State Machine alias.
    creationDate string
    Date the state machine Alias was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    routingConfigurations GetAliasRoutingConfiguration[]
    Routing Configuration of state machine alias
    statemachineArn string
    description string
    Description of state machine alias.
    arn str
    ARN identifying the State Machine alias.
    creation_date str
    Date the state machine Alias was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    routing_configurations Sequence[GetAliasRoutingConfiguration]
    Routing Configuration of state machine alias
    statemachine_arn str
    description str
    Description of state machine alias.
    arn String
    ARN identifying the State Machine alias.
    creationDate String
    Date the state machine Alias was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    routingConfigurations List<Property Map>
    Routing Configuration of state machine alias
    statemachineArn String
    description String
    Description of state machine alias.

    Supporting Types

    GetAliasRoutingConfiguration

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi