CfnStateMachineProps

class aws_cdk.aws_stepfunctions.CfnStateMachineProps(*, role_arn, definition=None, definition_s3_location=None, definition_string=None, definition_substitutions=None, encryption_configuration=None, logging_configuration=None, state_machine_name=None, state_machine_type=None, tags=None, tracing_configuration=None)

Bases: object

Properties for defining a CfnStateMachine.

Parameters:

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

  • definition (Any) – The Amazon States Language definition of the state machine. 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 .

  • definition_s3_location (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – The name of the S3 bucket where the state machine definition is stored. The state machine definition must be a JSON or YAML file.

  • definition_string (Optional[str]) –

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

  • definition_substitutions (Union[IResolvable, Mapping[str, str], None]) – A map (string to string) that specifies the mappings for placeholder variables in the state machine definition. 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,...} .

  • encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, Dict[str, Any], None]) – Encryption configuration for the state machine.

  • logging_configuration (Union[IResolvable, LoggingConfigurationProperty, Dict[str, Any], None]) – Defines what execution history events are logged and where they are logged. .. epigraph:: By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

  • state_machine_name (Optional[str]) – The name of the state machine. A name must not contain: - white space - brackets < > { } [ ] - wildcard characters ? * - special characters " # % \ ^ | ~ `` $ & , ; : /` - control characters ( ``U+0000-001F , U+007F-009F ) .. epigraph:: 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.

  • state_machine_type (Optional[str]) – 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. For more information on STANDARD and EXPRESS workflows, see Standard Versus Express Workflows in the AWS Step Functions Developer Guide.

  • tags (Optional[Sequence[Union[TagsEntryProperty, Dict[str, Any]]]]) – The list of tags to add to a resource. Tags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + -

  • tracing_configuration (Union[IResolvable, TracingConfigurationProperty, Dict[str, Any], None]) – Selects whether or not the state machine’s AWS X-Ray tracing is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions

# definition: Any

cfn_state_machine_props = stepfunctions.CfnStateMachineProps(
    role_arn="roleArn",

    # the properties below are optional
    definition=definition,
    definition_s3_location=stepfunctions.CfnStateMachine.S3LocationProperty(
        bucket="bucket",
        key="key",

        # the properties below are optional
        version="version"
    ),
    definition_string="definitionString",
    definition_substitutions={
        "definition_substitutions_key": "definitionSubstitutions"
    },
    encryption_configuration=stepfunctions.CfnStateMachine.EncryptionConfigurationProperty(
        type="type",

        # the properties below are optional
        kms_data_key_reuse_period_seconds=123,
        kms_key_id="kmsKeyId"
    ),
    logging_configuration=stepfunctions.CfnStateMachine.LoggingConfigurationProperty(
        destinations=[stepfunctions.CfnStateMachine.LogDestinationProperty(
            cloud_watch_logs_log_group=stepfunctions.CfnStateMachine.CloudWatchLogsLogGroupProperty(
                log_group_arn="logGroupArn"
            )
        )],
        include_execution_data=False,
        level="level"
    ),
    state_machine_name="stateMachineName",
    state_machine_type="stateMachineType",
    tags=[stepfunctions.CfnStateMachine.TagsEntryProperty(
        key="key",
        value="value"
    )],
    tracing_configuration=stepfunctions.CfnStateMachine.TracingConfigurationProperty(
        enabled=False
    )
)

Attributes

definition

The Amazon States Language definition of the state machine.

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definition

definition_s3_location

The name of the S3 bucket where the state machine definition is stored.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitions3location

definition_string

The Amazon States Language definition of the state machine.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionstring

definition_substitutions

A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.

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,...} .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-definitionsubstitutions

encryption_configuration

Encryption configuration for the state machine.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-encryptionconfiguration

logging_configuration

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-loggingconfiguration

role_arn

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-rolearn

state_machine_name

The name of the state machine.

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinename

state_machine_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. For more information on STANDARD and EXPRESS workflows, see Standard Versus Express Workflows in the AWS Step Functions Developer Guide.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-statemachinetype

tags

The list of tags to add to a resource.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tags

:: ` .

tracing_configuration

Selects whether or not the state machine’s AWS X-Ray tracing is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html#cfn-stepfunctions-statemachine-tracingconfiguration