AWS CDK Reference

Appearance

v2.274.0

CfnStateMachineProps Struct ​

Properties for defining a CfnStateMachine.

Source
Generated code
Type last changed
v2.227.0 · 21 Nov 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';

declare const definition: any;
const cfnStateMachineProps: stepfunctions.CfnStateMachineProps = {
  roleArn: 'roleArn',

  // the properties below are optional
  definition: definition,
  definitionS3Location: {
    bucket: 'bucket',
    key: 'key',

    // the properties below are optional
    version: 'version',
  },
  definitionString: 'definitionString',
  definitionSubstitutions: {
    definitionSubstitutionsKey: 'definitionSubstitutions',
  },
  encryptionConfiguration: {
    type: 'type',

    // the properties below are optional
    kmsDataKeyReusePeriodSeconds: 123,
    kmsKeyId: 'kmsKeyId',
  },
  loggingConfiguration: {
    destinations: [{
      cloudWatchLogsLogGroup: {
        logGroupArn: 'logGroupArn',
      },
    }],
    includeExecutionData: false,
    level: 'level',
  },
  stateMachineName: 'stateMachineName',
  stateMachineType: 'stateMachineType',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  tracingConfiguration: {
    enabled: false,
  },
};

Properties ​

definitionoptionalanydefinitionoptionalAnydefinitionoptionalObjectDefinitionoptionalobjectDefinitionoptionalinterface{}#
The Amazon States Language definition of the state machine.
notes

The state machine definition must be in JSON or YAML, and the format of the object must match the format of your CloudFormation template file. See Amazon States Language .

definitionS3LocationoptionalIResolvable | CfnStateMachine.S3LocationPropertydefinition_s3_locationoptionaltyping.Union[IResolvable, S3LocationProperty]definitionS3LocationoptionalIResolvableDefinitionS3LocationoptionalIResolvableDefinitionS3Locationoptionalinterface{}#
The name of the S3 bucket where the state machine definition is stored.

The state machine definition must be a JSON or YAML file.

definitionStringoptionalstring | ITableRef | ITaskDefinitionRef | IFunctionRef | IVersionRef | ITopicRef | IQueueRefdefinition_stringoptionaltyping.Union[str, ITableRef, ITaskDefinitionRef, IFunctionRef, IVersionRef, ITopicRef, IQueueRef]definitionStringoptionalStringDefinitionStringoptionalstringDefinitionStringoptionalinterface{}#
The Amazon States Language definition of the state machine.

The state machine definition must be in JSON. See Amazon States Language .

definitionSubstitutionsoptionalIResolvable | { [key: string]: string }definition_substitutionsoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]definitionSubstitutionsoptionalIResolvableDefinitionSubstitutionsoptionalIResolvableDefinitionSubstitutionsoptionalinterface{}#
A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.
notes

This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key-value map.

Substitutions must follow the syntax: ${key_name} or ${variable_1,variable_2,...} .

encryptionConfigurationoptionalIResolvable | CfnStateMachine.EncryptionConfigurationPropertyencryption_configurationoptionaltyping.Union[IResolvable, EncryptionConfigurationProperty]encryptionConfigurationoptionalIResolvableEncryptionConfigurationoptionalIResolvableEncryptionConfigurationoptionalinterface{}#
Encryption configuration for the state machine.
loggingConfigurationoptionalIResolvable | CfnStateMachine.LoggingConfigurationPropertylogging_configurationoptionaltyping.Union[IResolvable, LoggingConfigurationProperty]loggingConfigurationoptionalIResolvableLoggingConfigurationoptionalIResolvableLoggingConfigurationoptionalinterface{}#
Defines what execution history events are logged and where they are logged.

By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

roleArnstring | IRoleRefrole_arntyping.Union[str, IRoleRef]roleArnStringRoleArnstringRoleArninterface{}required#
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
stateMachineNameoptionalstringstate_machine_nameoptionalstrstateMachineNameoptionalStringStateMachineNameoptionalstringStateMachineNameoptional*string#
The name of the state machine.
notes

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ $ & , ; : /`
  • control characters ( U+0000-001F , U+007F-009F )

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

stateMachineTypeoptionalstringstate_machine_typeoptionalstrstateMachineTypeoptionalStringStateMachineTypeoptionalstringStateMachineTypeoptional*string#
Determines whether a `STANDARD` or `EXPRESS` state machine is created.
notes

The default is STANDARD . You cannot update the type of a state machine once it has been created. For more information on STANDARD and EXPRESS workflows, see Standard Versus Express Workflows in the AWS Step Functions Developer Guide.

tagsoptionalCfnStateMachine.TagsEntryProperty[]tagsoptionaltyping.List[TagsEntryProperty]tagsoptionalList<TagsEntryProperty>TagsoptionalTagsEntryProperty[]Tagsoptional*[]TagsEntryProperty#
The list of tags to add to a resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + -

tracingConfigurationoptionalIResolvable | CfnStateMachine.TracingConfigurationPropertytracing_configurationoptionaltyping.Union[IResolvable, TracingConfigurationProperty]tracingConfigurationoptionalIResolvableTracingConfigurationoptionalIResolvableTracingConfigurationoptionalinterface{}#
Selects whether or not the state machine's AWS X-Ray tracing is enabled.