CfnStateMachine

class aws_cdk.aws_stepfunctions.CfnStateMachine(scope, id, *, role_arn, definition=None, definition_s3_location=None, definition_string=None, definition_substitutions=None, logging_configuration=None, state_machine_name=None, state_machine_type=None, tags=None, tracing_configuration=None)

Bases: CfnResource

A CloudFormation AWS::StepFunctions::StateMachine.

Provisions a state machine. A state machine consists of a collection of states that can do work ( Task states), determine to which states to transition next ( Choice states), stop an execution with an error ( Fail states), and so on. State machines are specified using a JSON-based, structured language.

CloudformationResource:: AWS::StepFunctions::StateMachine
Link:: 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.
import aws_cdk.aws_stepfunctions as stepfunctions

# definition: Any
# definition_substitutions: Any

cfn_state_machine = stepfunctions.CfnStateMachine(self, "MyCfnStateMachine",
    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": definition_substitutions
    },
    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
    )
)

Create a new AWS::StepFunctions::StateMachine.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
role_arn (str) – The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
definition (Optional[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 AWS Step Functions 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, Any], 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.
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:: attribute_name (str) – The name of the attribute.
Return type:: Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::StepFunctions::StateMachine'

attr_arn

Arn

Type:: cloudformationAttribute

attr_name

.

{ "Fn::GetAtt": ["MyStateMachine", "Name"] }

Returns the name of your state machine:

HelloWorld-StateMachine

If you did not specify the name it will be similar to the following:

MyStateMachine-1234abcdefgh

For more information about using Fn::GetAtt , see Fn::GetAtt .

CloudformationAttribute:: Name
Type:: Returns the name of the state machine. For example

attr_state_machine_revision_id

StateMachineRevisionId

Type:: cloudformationAttribute

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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 AWS Step Functions template file. See Amazon States Language .

Link:: 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.

Link:: 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 .

Link:: 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.

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

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.

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

role_arn

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

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

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.

Link:: 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.

Link:: 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: _ . : / = + - @ .

Link:: 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.

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

CloudWatchLogsLogGroupProperty

class CfnStateMachine.CloudWatchLogsLogGroupProperty(*, log_group_arn=None)

Bases: object

Defines a CloudWatch log group.

For more information see Standard Versus Express Workflows in the AWS Step Functions Developer Guide.

Parameters:: log_group_arn (Optional[str]) – The ARN of the the CloudWatch log group to which you want your logs emitted to. The ARN must end with :*
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-cloudwatchlogsloggroup.html
ExampleMetadata:: fixture=_generated

Example:

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

cloud_watch_logs_log_group_property = stepfunctions.CfnStateMachine.CloudWatchLogsLogGroupProperty(
    log_group_arn="logGroupArn"
)

Attributes

log_group_arn

The ARN of the the CloudWatch log group to which you want your logs emitted to.

The ARN must end with :*

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-cloudwatchlogsloggroup.html#cfn-stepfunctions-statemachine-cloudwatchlogsloggroup-loggrouparn

LogDestinationProperty

class CfnStateMachine.LogDestinationProperty(*, cloud_watch_logs_log_group=None)

Bases: object

Defines a destination for LoggingConfiguration .

For more information on logging with EXPRESS workflows, see Logging Express Workflows Using CloudWatch Logs .

Parameters:: cloud_watch_logs_log_group (Union[IResolvable, CloudWatchLogsLogGroupProperty, Dict[str, Any], None]) – An object describing a CloudWatch log group. For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-logdestination.html
ExampleMetadata:: fixture=_generated

Example:

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

log_destination_property = stepfunctions.CfnStateMachine.LogDestinationProperty(
    cloud_watch_logs_log_group=stepfunctions.CfnStateMachine.CloudWatchLogsLogGroupProperty(
        log_group_arn="logGroupArn"
    )
)

Attributes

cloud_watch_logs_log_group

An object describing a CloudWatch log group.

For more information, see AWS::Logs::LogGroup in the AWS CloudFormation User Guide.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-logdestination.html#cfn-stepfunctions-statemachine-logdestination-cloudwatchlogsloggroup

LoggingConfigurationProperty

class CfnStateMachine.LoggingConfigurationProperty(*, destinations=None, include_execution_data=None, level=None)

Bases: object

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.

Parameters:

destinations (Union[IResolvable, Sequence[Union[IResolvable, LogDestinationProperty, Dict[str, Any]]], None]) – An array of objects that describes where your execution history events will be logged. Limited to size 1. Required, if your log level is not set to OFF .
include_execution_data (Union[bool, IResolvable, None]) – Determines whether execution data is included in your log. When set to false , data is excluded.
level (Optional[str]) – Defines which category of execution history events are logged.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

logging_configuration_property = 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"
)

Attributes

destinations

An array of objects that describes where your execution history events will be logged.

Limited to size 1. Required, if your log level is not set to OFF .

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

include_execution_data

Determines whether execution data is included in your log.

When set to false , data is excluded.

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

level

Defines which category of execution history events are logged.

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

S3LocationProperty

class CfnStateMachine.S3LocationProperty(*, bucket, key, version=None)

Bases: object

Defines the S3 bucket location where a state machine definition is stored.

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

Parameters:

bucket (str) – The name of the S3 bucket where the state machine definition JSON or YAML file is stored.
key (str) – The name of the state machine definition file (Amazon S3 object name).
version (Optional[str]) – For versioning-enabled buckets, a specific version of the state machine definition.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

s3_location_property = stepfunctions.CfnStateMachine.S3LocationProperty(
    bucket="bucket",
    key="key",

    # the properties below are optional
    version="version"
)

Attributes

bucket

The name of the S3 bucket where the state machine definition JSON or YAML file is stored.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-bucket

key

The name of the state machine definition file (Amazon S3 object name).

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-key

version

For versioning-enabled buckets, a specific version of the state machine definition.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-s3location.html#cfn-stepfunctions-statemachine-s3location-version

TagsEntryProperty

class CfnStateMachine.TagsEntryProperty(*, key, value)

Bases: object

The TagsEntry property specifies tags to identify a state machine.

Parameters:

key (str) – The key for a key-value pair in a tag entry.
value (str) – The value for a key-value pair in a tag entry.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

tags_entry_property = stepfunctions.CfnStateMachine.TagsEntryProperty(
    key="key",
    value="value"
)

Attributes

key

The key for a key-value pair in a tag entry.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html#cfn-stepfunctions-statemachine-tagsentry-key

value

The value for a key-value pair in a tag entry.

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tagsentry.html#cfn-stepfunctions-statemachine-tagsentry-value

TracingConfigurationProperty

class CfnStateMachine.TracingConfigurationProperty(*, enabled=None)

Bases: object

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

To configure your state machine to send trace data to X-Ray, set Enabled to true .

Parameters:: enabled (Union[bool, IResolvable, None]) – When set to true , X-Ray tracing is enabled.
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-tracingconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

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

tracing_configuration_property = stepfunctions.CfnStateMachine.TracingConfigurationProperty(
    enabled=False
)

Attributes

enabled

When set to true , X-Ray tracing is enabled.

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