AwsStepFunctionsStateMachineArgs

interface AwsStepFunctionsStateMachineArgs extends Omit<aws.sfn.StateMachineArgs, 'definition' | 'name' | 'namePrefix' | 'roleArn' | 'tags'> {
definition?: Input<string | Record<string, unknown>>;
definitionTemplateFile?: AwsStepFunctionsDefinitionTemplateFileArgs;
encryptionConfiguration?: Input<StateMachineEncryptionConfiguration | undefined>;
loggingConfiguration?: Input<StateMachineLoggingConfiguration | undefined>;
publish?: Input<boolean | undefined>;
region?: Input<string | undefined>;
roleArn: Input<string>;
stateMachineName: string;
tags?: Input<Record<string, Input<string>>>;
tracingConfiguration?: Input<StateMachineTracingConfiguration | undefined>;
type?: Input<string | undefined>;
}

Input arguments for the Step Functions state machine capability.

Remarks

Exactly one definition source must be provided:

definition
definitionTemplateFile

Example

CODE

const args: AwsStepFunctionsStateMachineArgs = {
  stateMachineName: 'orders',
  roleArn: 'step-functions-execution-role',
  definition: JSON.stringify({
    StartAt: 'Done',
    States: {
      Done: {
        Type: 'Succeed',
      },
    },
  }),
};

Hierarchy

StateMachineArgs, "definition" | "name" | "namePrefix" | "roleArn" | "tags">
AwsStepFunctionsStateMachineArgs

Properties

`definition: Input<string | Record<string, unknown>>`

Inline state machine definition as JSON string or object.

`definitionTemplateFile: AwsStepFunctionsDefinitionTemplateFileArgs`

Template file source for state machine definitions with optional variables.

`encryptionConfiguration: Input<StateMachineEncryptionConfiguration | undefined>`

Inherited from encryptionConfiguration

Defines what encryption configuration is used to encrypt data in the State Machine. For more information see [TBD] in the AWS Step Functions User Guide.

`loggingConfiguration: Input<StateMachineLoggingConfiguration | undefined>`

Inherited from loggingConfiguration

Defines what execution history events are logged and where they are logged. The loggingConfiguration parameter is valid when type is set to STANDARD or EXPRESS. Defaults to OFF. For more information see Logging Express Workflows, Log Levels and Logging Configuration in the AWS Step Functions User Guide.

`publish: Input<boolean | undefined>`

Inherited from publish

Set to true to publish a version of the state machine during creation. Default: false.

`region: Input<string | undefined>`

Inherited from region

Region where this resource will be managed. Defaults to the Region set in the provider configuration.

`roleArn: Input<string>`

IAM role reference used by the state machine. Accepts ARN or role name.

`stateMachineName: string`

Required state machine purpose name used for AWS resource naming.

`tags: Input<Record<string, Input<string>>>`

Additional tags merged with default project/environment tags.

`tracingConfiguration: Input<StateMachineTracingConfiguration | undefined>`

Inherited from tracingConfiguration

Selects whether AWS X-Ray tracing is enabled.

`type: Input<string | undefined>`

Inherited from type

Determines whether a Standard or Express state machine is created. The default is STANDARD. You cannot update the type of a state machine once it has been created. Valid values: STANDARD, EXPRESS.