Fork me on GitHub

Module sfn

@pulumi/aws > sfn

Index

sfn/activity.ts sfn/stateMachine.ts

class Activity

Provides a Step Function Activity resource

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 urn

urn: Output<URN>;

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

class StateMachine

Provides a Step Function State Machine resource

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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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 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.

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.

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.

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