Module sfn

@pulumi/aws > sfn

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.

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("sfnActivity", {});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/sfn_activity.html.markdown.

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): boolean

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

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("sfnStateMachine", {
    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,
});

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/sfn_state_machine.html.markdown.

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): boolean

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

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 mapping of resource tags

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 mapping of resource tags

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 mapping of resource tags

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 mapping of resource tags