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.

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 pulumi_aws.sfn.Activity(resource_name, opts=None, name=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides a Step Function Activity resource

import pulumi
import pulumi_aws as aws

sfn_activity = aws.sfn.Activity("sfnActivity")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the activity to create.

  • tags (pulumi.Input[dict]) – Key-value map of resource tags

creation_date: pulumi.Output[str] = None

The date the activity was created.

name: pulumi.Output[str] = None

The name of the activity to create.

tags: pulumi.Output[dict] = None

Key-value map of resource tags

static get(resource_name, id, opts=None, creation_date=None, name=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • creation_date (pulumi.Input[str]) – The date the activity was created.

  • name (pulumi.Input[str]) – The name of the activity to create.

  • tags (pulumi.Input[dict]) – Key-value map of resource tags

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.sfn.AwaitableGetActivityResult(arn=None, creation_date=None, id=None, name=None)
class pulumi_aws.sfn.AwaitableGetStateMachineResult(arn=None, creation_date=None, definition=None, id=None, name=None, role_arn=None, status=None)
class pulumi_aws.sfn.GetActivityResult(arn=None, creation_date=None, id=None, name=None)

A collection of values returned by getActivity.

creation_date = None

The date the activity was created.

id = None

The provider-assigned unique ID for this managed resource.

class pulumi_aws.sfn.GetStateMachineResult(arn=None, creation_date=None, definition=None, id=None, name=None, role_arn=None, status=None)

A collection of values returned by getStateMachine.

arn = None

Set to the arn of the state function.

creation_date = None

The date the state machine was created.

definition = None

Set to the state machine definition.

id = None

The provider-assigned unique ID for this managed resource.

role_arn = None

Set to the role_arn used by the state function.

status = None

Set to the current status of the state machine.

class pulumi_aws.sfn.StateMachine(resource_name, opts=None, definition=None, name=None, role_arn=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides a Step Function State Machine resource

import pulumi
import pulumi_aws as aws

sfn_state_machine = aws.sfn.StateMachine("sfnStateMachine",
    definition=f"""{{
  "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
    }}
  }}
}}

""",
    role_arn=aws_iam_role["iam_for_sfn"]["arn"])
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • definition (pulumi.Input[str]) – The Amazon States Language definition of the state machine.

  • name (pulumi.Input[str]) – The name of the state machine.

  • role_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

  • tags (pulumi.Input[dict]) – Key-value map of resource tags

creation_date: pulumi.Output[str] = None

The date the state machine was created.

definition: pulumi.Output[str] = None

The Amazon States Language definition of the state machine.

name: pulumi.Output[str] = None

The name of the state machine.

role_arn: pulumi.Output[str] = None

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

status: pulumi.Output[str] = None

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

tags: pulumi.Output[dict] = None

Key-value map of resource tags

static get(resource_name, id, opts=None, creation_date=None, definition=None, name=None, role_arn=None, status=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • creation_date (pulumi.Input[str]) – The date the state machine was created.

  • definition (pulumi.Input[str]) – The Amazon States Language definition of the state machine.

  • name (pulumi.Input[str]) – The name of the state machine.

  • role_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

  • status (pulumi.Input[str]) – The current status of the state machine. Either “ACTIVE” or “DELETING”.

  • tags (pulumi.Input[dict]) – Key-value map of resource tags

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_aws.sfn.get_activity(arn=None, name=None, opts=None)

Provides a Step Functions Activity data source

import pulumi
import pulumi_aws as aws

sfn_activity = aws.sfn.get_activity(name="my-activity")
Parameters
  • arn (str) – The Amazon Resource Name (ARN) that identifies the activity.

  • name (str) – The name that identifies the activity.

pulumi_aws.sfn.get_state_machine(name=None, opts=None)

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.

import pulumi
import pulumi_aws as aws

example = aws.sfn.get_state_machine(name="an_example_sfn_name")
Parameters

name (str) – The friendly name of the state machine to match.