AwsStepFunctions

Service-level AWS Step Functions component.

Remarks

This is the primary component resource for the package. It orchestrates one Step Functions capability per instance: state machine, activity, or alias.

Naming:

• The state-machine, activity, and alias capability literals produce root names ${env}-${projectHash}-<capability>-<sanitised identity> with identity from the active capability's stateMachineName, activityName, or aliasName, respectively. Each identity is also its AWS name purpose.
• aws:sfn/stateMachine:StateMachine, aws:sfn/activity:Activity, and aws:sfn/alias:Alias children use the corresponding raw capability name as their sole readable tuple, producing ${env}-${projectHash}-<name>. Their qualified provider types are distinct, so the rendered child names may intentionally be the same.
• State machine, activity, and alias AWS names retain the stackAndPurpose style ${env}-${projectHash}-<purpose>; purpose must be camelCase and at most 67 characters.

Example

const awsStepFunctions = new AwsStepFunctions({
  stateMachine: {
    stateMachineName: 'orders',
    roleArn: 'step-functions-execution-role',
    definitionTemplateFile: {
      path: './workflows/order-workflow.json',
      variables: {
        submitOrderLambdaArn: submitOrderFunction.arn,
      },
    },
    type: 'STANDARD',
  },
});

Constructors

new AwsStepFunctions( args: AwsStepFunctionsArgs, options?: ComponentResourceOptions, ): AwsStepFunctions

Parameters

• args (AwsStepFunctionsArgs) — Service-level Step Functions capability inputs.The component logical name is derived from capability identity inputs.
• options (ComponentResourceOptions, optional) — Optional settings controlling resource behaviour.

Returns

AwsStepFunctions

Hierarchy

• ComponentResource
• AwsStepFunctions

Properties

activity: AwsStepFunctionsActivity

Optional activity capability created by this component.

alias: AwsStepFunctionsAlias

Optional alias capability created by this component.

stateMachine: AwsStepFunctionsStateMachine

Optional state machine capability created by this component.

urn: Output<string>

Inherited from urn

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

Methods

getData(): Promise<any>

Inherited from getData

Retrieves the data produces by initialize. The data is immediately available in a derived class's constructor after the super(...) call to ComponentResource.

Returns

• Promise<any>

getProvider(moduleMember: string): ProviderResource | undefined

Inherited from getProvider

Returns the provider for the given module member, if one exists.

Parameters

• moduleMember (string)

Returns

• ProviderResource | undefined

initialize( args: Inputs, opts?: ComponentResourceOptions, name?: string, type?: string, ): Promise<any>

Inherited from initialize

Can be overridden by a subclass to asynchronously initialize data for this component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use getData.

Parameters

• args (Inputs)
• opts (ComponentResourceOptions, optional)
• name (string, optional)
• type (string, optional)

Returns

• Promise<any>

registerOutputs( outputs?: Inputs | Promise<Inputs> | Output<Inputs>, ): void

Inherited from registerOutputs

Registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

Parameters

• outputs (Inputs | Promise<Inputs> | Output<Inputs>, optional)

Returns

• void

Static Methods

isInstance(obj: any): obj is ComponentResource<any>

Inherited from isInstance

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

Parameters

• obj (any)

Returns

• obj is ComponentResource<any>