CfnStateMachine

class aws_cdk.aws_stepfunctions.CfnStateMachine(scope, id, *, 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: CfnResource

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.

See:

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

CloudformationResource:

AWS::StepFunctions::StateMachine

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 = 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": "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
    )
)
Parameters:

  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • 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.

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_dependency(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_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

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 intermediate 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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

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 resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

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.

  • type_hint (Optional[ResolutionTypeHint]) –

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

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
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

Returns the ARN of the resource.

CloudformationAttribute:

Arn

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

Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.

CloudformationAttribute:

StateMachineRevisionId

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.

definition_s3_location

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

definition_string

The Amazon States Language definition of the state machine.

definition_substitutions

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

encryption_configuration

Encryption configuration for the state machine.

logging_configuration

Defines what execution history events are logged and where they are logged.

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 tree node.

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.

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.

state_machine_type

Determines whether a STANDARD or EXPRESS state machine is created.

tags

Tag Manager which manages the tags for this resource.

tags_raw

The list of tags to add to a resource.

tracing_configuration

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

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(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

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 :*

See:

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.
from aws_cdk import 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 :*

See:

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

EncryptionConfigurationProperty

class CfnStateMachine.EncryptionConfigurationProperty(*, type, kms_data_key_reuse_period_seconds=None, kms_key_id=None)

Bases: object

Settings to configure server-side encryption for a state machine.

By default, Step Functions provides transparent server-side encryption. With this configuration, you can specify a customer managed AWS KMS key for encryption.

Parameters:

  • type (str) – Encryption option for a state machine.

  • kms_data_key_reuse_period_seconds (Union[int, float, None]) – Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call GenerateDataKey . Only applies to customer managed keys.

  • kms_key_id (Optional[str]) – An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data. To specify a AWS KMS key in a different AWS account, you must use the key ARN or alias ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stepfunctions-statemachine-encryptionconfiguration.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

encryption_configuration_property = stepfunctions.CfnStateMachine.EncryptionConfigurationProperty(
    type="type",

    # the properties below are optional
    kms_data_key_reuse_period_seconds=123,
    kms_key_id="kmsKeyId"
)

Attributes

kms_data_key_reuse_period_seconds

Maximum duration that Step Functions will reuse data keys.

When the period expires, Step Functions will call GenerateDataKey . Only applies to customer managed keys.

See:

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

kms_key_id

An alias, alias ARN, key ID, or key ARN of a symmetric encryption AWS KMS key to encrypt data.

To specify a AWS KMS key in a different AWS account, you must use the key ARN or alias ARN.

See:

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

type

Encryption option for a state machine.

See:

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

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.

See:

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.
from aws_cdk import 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.

See:

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.

Step Functions provides the log levels — OFF , ALL , ERROR , and FATAL . No event types log when set to OFF and all event types do when set to ALL . .. epigraph:

By default, the ``level`` is set to ``OFF`` . For more information see `Log Levels <https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html>`_ 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.

See:

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.
from aws_cdk import 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 .

See:

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.

See:

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.

See:

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.

See:

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.
from aws_cdk import 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.

See:

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).

See:

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.

See:

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.

See:

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.
from aws_cdk import 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.

See:

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.

See:

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.

See:

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.
from aws_cdk import aws_stepfunctions as stepfunctions

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

Attributes

enabled

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

See:

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