Module sfn

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Resource Activity

class Activity extends CustomResource

Provides a Step Function Activity resource

Example Usage

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

const sfnActivity = new aws.sfn.Activity("sfn_activity", {});

constructor

new Activity(name: string, args?: ActivityArgs, opts?: pulumi.CustomResourceOptions)

Create a Activity resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ActivityState, opts?: pulumi.CustomResourceOptions): Activity

Get an existing Activity resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Activity

Returns true if the given object is an instance of Activity. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property creationDate

public creationDate: pulumi.Output<string>;

The date the activity was created.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the activity to create.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource StateMachine

class StateMachine extends CustomResource

Provides a Step Function State Machine resource

Example Usage

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

const sfnStateMachine = new aws.sfn.StateMachine("sfn_state_machine", {
    definition: pulumi.interpolate`{
  "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda Function",
  "StartAt": "HelloWorld",
  "States": {
    "HelloWorld": {
      "Type": "Task",
      "Resource": "${aws_lambda_function_lambda.arn}",
      "End": true
    }
  }
}
`,
    roleArn: aws_iam_role_iam_for_sfn.arn,
});

constructor

new StateMachine(name: string, args: StateMachineArgs, opts?: pulumi.CustomResourceOptions)

Create a StateMachine resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StateMachineState, opts?: pulumi.CustomResourceOptions): StateMachine

Get an existing StateMachine resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is StateMachine

Returns true if the given object is an instance of StateMachine. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property creationDate

public creationDate: pulumi.Output<string>;

The date the state machine was created.

property definition

public definition: pulumi.Output<string>;

The Amazon States Language definition of the state machine.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the state machine.

property roleArn

public roleArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

property status

public status: pulumi.Output<string>;

The current status of the state machine. Either “ACTIVE” or “DELETING”.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getActivity

getActivity(args?: GetActivityArgs, opts?: pulumi.InvokeOptions): Promise<GetActivityResult>

Provides a Step Functions Activity data source

Example Usage

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

const sfnActivity = pulumi.output(aws.sfn.getActivity({
    name: "my-activity",
}, { async: true }));

Function getStateMachine

getStateMachine(args: GetStateMachineArgs, opts?: pulumi.InvokeOptions): Promise<GetStateMachineResult>

Use this data source to get the ARN of a State Machine in AWS Step Function (SFN). By using this data source, you can reference a state machine without having to hard code the ARNs as input.

Example Usage

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

const example = pulumi.output(aws.sfn.getStateMachine({
    name: "an_example_sfn_name",
}, { async: true }));

Others

interface ActivityArgs

interface ActivityArgs

The set of arguments for constructing a Activity resource.

property name

name?: pulumi.Input<string>;

The name of the activity to create.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface ActivityState

interface ActivityState

Input properties used for looking up and filtering Activity resources.

property creationDate

creationDate?: pulumi.Input<string>;

The date the activity was created.

property name

name?: pulumi.Input<string>;

The name of the activity to create.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface GetActivityArgs

interface GetActivityArgs

A collection of arguments for invoking getActivity.

property arn

arn?: undefined | string;

The Amazon Resource Name (ARN) that identifies the activity.

property name

name?: undefined | string;

The name that identifies the activity.

interface GetActivityResult

interface GetActivityResult

A collection of values returned by getActivity.

property arn

arn: string;

property creationDate

creationDate: string;

The date the activity was created.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

interface GetStateMachineArgs

interface GetStateMachineArgs

A collection of arguments for invoking getStateMachine.

property name

name: string;

The friendly name of the state machine to match.

interface GetStateMachineResult

interface GetStateMachineResult

A collection of values returned by getStateMachine.

property arn

arn: string;

Set to the arn of the state function.

property creationDate

creationDate: string;

The date the state machine was created.

property definition

definition: string;

Set to the state machine definition.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

property roleArn

roleArn: string;

Set to the roleArn used by the state function.

property status

status: string;

Set to the current status of the state machine.

interface StateMachineArgs

interface StateMachineArgs

The set of arguments for constructing a StateMachine resource.

property definition

definition: pulumi.Input<string>;

The Amazon States Language definition of the state machine.

property name

name?: pulumi.Input<string>;

The name of the state machine.

property roleArn

roleArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface StateMachineState

interface StateMachineState

Input properties used for looking up and filtering StateMachine resources.

property creationDate

creationDate?: pulumi.Input<string>;

The date the state machine was created.

property definition

definition?: pulumi.Input<string>;

The Amazon States Language definition of the state machine.

property name

name?: pulumi.Input<string>;

The name of the state machine.

property roleArn

roleArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

property status

status?: pulumi.Input<string>;

The current status of the state machine. Either “ACTIVE” or “DELETING”.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module sfn

Resources

Functions

Others

Resources

Example Usage

Example Usage

Functions

Example Usage

Example Usage

Others