Package com.pulumi.aws.sfn

Class Alias

  • public class Alias
extends com.pulumi.resources.CustomResource
    Provides a Step Function State Machine Alias. ## Example Usage ### Basic Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.sfn.Alias;
 import com.pulumi.aws.sfn.AliasArgs;
 import com.pulumi.aws.sfn.inputs.AliasRoutingConfigurationArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 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) {
         var sfnAlias = new Alias("sfnAlias", AliasArgs.builder()
             .routingConfigurations(AliasRoutingConfigurationArgs.builder()
                 .stateMachineVersionArn(sfnTest.stateMachineVersionArn())
                 .weight(100)
                 .build())
             .name("my_sfn_alias")
             .build());
 
         var mySfnAlias = new Alias("mySfnAlias", AliasArgs.builder()
             .routingConfigurations(            
                 AliasRoutingConfigurationArgs.builder()
                     .stateMachineVersionArn("arn:aws:states:us-east-1:12345:stateMachine:demo:3")
                     .weight(50)
                     .build(),
                 AliasRoutingConfigurationArgs.builder()
                     .stateMachineVersionArn("arn:aws:states:us-east-1:12345:stateMachine:demo:2")
                     .weight(50)
                     .build())
             .name("my_sfn_alias")
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `arn` (String) ARN of the alias. Using `pulumi import`, import SFN (Step Functions) Alias using the `arn`. For example: ```sh $ pulumi import aws:sfn/alias:Alias foo arn:aws:states:us-east-1:123456789098:stateMachine:myStateMachine:foo ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Alias​(java.lang.String name)  
      Alias​(java.lang.String name, AliasArgs args)  
      Alias​(java.lang.String name, AliasArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> creationDate()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static Alias get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AliasState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<AliasRoutingConfiguration>> routingConfigurations()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Alias

        public Alias​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Alias

        public Alias​(java.lang.String name,
             AliasArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Alias

        public Alias​(java.lang.String name,
             AliasArgs args,
             @Nullable
             com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN identifying your state machine alias.

      • creationDate

        public com.pulumi.core.Output<java.lang.String> creationDate()
        Returns:
        The date the state machine alias was created.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the alias.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name for the alias you are creating.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • routingConfigurations

        public com.pulumi.core.Output<java.util.List<AliasRoutingConfiguration>> routingConfigurations()
        Returns:
        The StateMachine alias' route configuration settings. Fields documented below

      • get

        public static Alias get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        AliasState state,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.