Alias class

Provides a Step Function State Machine Alias.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const sfnAlias = new aws.sfn.Alias("sfn_alias", {
    routingConfigurations: [{
        stateMachineVersionArn: sfnTest.stateMachineVersionArn,
        weight: 100,
    }],
    name: "my_sfn_alias",
});
const mySfnAlias = new aws.sfn.Alias("my_sfn_alias", {
    routingConfigurations: [
        {
            stateMachineVersionArn: "arn:aws:states:us-east-1:12345:stateMachine:demo:3",
            weight: 50,
        },
        {
            stateMachineVersionArn: "arn:aws:states:us-east-1:12345:stateMachine:demo:2",
            weight: 50,
        },
    ],
    name: "my_sfn_alias",
});
import pulumi
import pulumi_aws as aws

sfn_alias = aws.sfn.Alias("sfn_alias",
    routing_configurations=[{
        "state_machine_version_arn": sfn_test["stateMachineVersionArn"],
        "weight": 100,
    }],
    name="my_sfn_alias")
my_sfn_alias = aws.sfn.Alias("my_sfn_alias",
    routing_configurations=[
        {
            "state_machine_version_arn": "arn:aws:states:us-east-1:12345:stateMachine:demo:3",
            "weight": 50,
        },
        {
            "state_machine_version_arn": "arn:aws:states:us-east-1:12345:stateMachine:demo:2",
            "weight": 50,
        },
    ],
    name="my_sfn_alias")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var sfnAlias = new Aws.Sfn.Alias("sfn_alias", new()
    {
        RoutingConfigurations = new[]
        {
            new Aws.Sfn.Inputs.AliasRoutingConfigurationArgs
            {
                StateMachineVersionArn = sfnTest.StateMachineVersionArn,
                Weight = 100,
            },
        },
        Name = "my_sfn_alias",
    });

    var mySfnAlias = new Aws.Sfn.Alias("my_sfn_alias", new()
    {
        RoutingConfigurations = new[]
        {
            new Aws.Sfn.Inputs.AliasRoutingConfigurationArgs
            {
                StateMachineVersionArn = "arn:aws:states:us-east-1:12345:stateMachine:demo:3",
                Weight = 50,
            },
            new Aws.Sfn.Inputs.AliasRoutingConfigurationArgs
            {
                StateMachineVersionArn = "arn:aws:states:us-east-1:12345:stateMachine:demo:2",
                Weight = 50,
            },
        },
        Name = "my_sfn_alias",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/sfn"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sfn.NewAlias(ctx, "sfn_alias", &sfn.AliasArgs{
			RoutingConfigurations: sfn.AliasRoutingConfigurationArray{
				&sfn.AliasRoutingConfigurationArgs{
					StateMachineVersionArn: pulumi.Any(sfnTest.StateMachineVersionArn),
					Weight:                 pulumi.Int(100),
				},
			},
			Name: pulumi.String("my_sfn_alias"),
		})
		if err != nil {
			return err
		}
		_, err = sfn.NewAlias(ctx, "my_sfn_alias", &sfn.AliasArgs{
			RoutingConfigurations: sfn.AliasRoutingConfigurationArray{
				&sfn.AliasRoutingConfigurationArgs{
					StateMachineVersionArn: pulumi.String("arn:aws:states:us-east-1:12345:stateMachine:demo:3"),
					Weight:                 pulumi.Int(50),
				},
				&sfn.AliasRoutingConfigurationArgs{
					StateMachineVersionArn: pulumi.String("arn:aws:states:us-east-1:12345:stateMachine:demo:2"),
					Weight:                 pulumi.Int(50),
				},
			},
			Name: pulumi.String("my_sfn_alias"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_sfn_alias" "sfn_alias" {
  routing_configurations {
    state_machine_version_arn = sfnTest.stateMachineVersionArn
    weight                    = 100
  }
  name = "my_sfn_alias"
}
resource "aws_sfn_alias" "my_sfn_alias" {
  routing_configurations {
    state_machine_version_arn = "arn:aws:states:us-east-1:12345:stateMachine:demo:3"
    weight                    = 50
  }
  routing_configurations {
    state_machine_version_arn = "arn:aws:states:us-east-1:12345:stateMachine:demo:2"
    weight                    = 50
  }
  name = "my_sfn_alias"
}
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());

    }
}
resources:
  sfnAlias:
    type: aws:sfn:Alias
    name: sfn_alias
    properties:
      routingConfigurations:
        - stateMachineVersionArn: ${sfnTest.stateMachineVersionArn}
          weight: 100
      name: my_sfn_alias
  mySfnAlias:
    type: aws:sfn:Alias
    name: my_sfn_alias
    properties:
      routingConfigurations:
        - stateMachineVersionArn: arn:aws:states:us-east-1:12345:stateMachine:demo:3
          weight: 50
        - stateMachineVersionArn: arn:aws:states:us-east-1:12345:stateMachine:demo:2
          weight: 50
      name: my_sfn_alias

Import

Identity Schema

Required

  • arn (String) ARN of the alias.

Using pulumi import, import SFN (Step Functions) Alias using the arn. For example:

$ pulumi import aws:sfn/alias:Alias foo arn:aws:states:us-east-1:123456789098:stateMachine:myStateMachine:foo

Constructors

Alias(String name, {AliasArgs? args, CustomResourceOptions? options})
Creates a new Alias. name The Pulumi resource name. args Arguments used to configure this Alias. The set of arguments for Alias. options Resource options controlling this resource's behavior.
Alias.reference(String urn)
Creates a typed reference to an existing Alias resource.

Properties

arn ↔ Output<String>
ARN identifying your state machine alias.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
creationDate ↔ Output<String>
The date the state machine alias was created.
latefinal
description ↔ Output<String?>
Description of the alias.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Name for the alias you are creating.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
routingConfigurations ↔ Output<List<AliasRoutingConfiguration>>
The StateMachine alias' route configuration settings. Fields documented below
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {AliasState? state, CustomResourceOptions? options}) → Alias
Gets an existing Alias resource's state with the given name and id.