CfnStateMachinePropsMixin

class aws_cdk.mixins_preview.aws_stepfunctions.mixins.CfnStateMachinePropsMixin(props, *, strategy=None)

Bases: Mixin

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
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

# definition: Any

cfn_state_machine_props_mixin = stepfunctions_mixins.CfnStateMachinePropsMixin(stepfunctions_mixins.CfnStateMachineMixinProps(
    definition=definition,
    definition_s3_location=stepfunctions_mixins.CfnStateMachinePropsMixin.S3LocationProperty(
        bucket="bucket",
        key="key",
        version="version"
    ),
    definition_string="definitionString",
    definition_substitutions={
        "definition_substitutions_key": "definitionSubstitutions"
    },
    encryption_configuration=stepfunctions_mixins.CfnStateMachinePropsMixin.EncryptionConfigurationProperty(
        kms_data_key_reuse_period_seconds=123,
        kms_key_id="kmsKeyId",
        type="type"
    ),
    logging_configuration=stepfunctions_mixins.CfnStateMachinePropsMixin.LoggingConfigurationProperty(
        destinations=[stepfunctions_mixins.CfnStateMachinePropsMixin.LogDestinationProperty(
            cloud_watch_logs_log_group=stepfunctions_mixins.CfnStateMachinePropsMixin.CloudWatchLogsLogGroupProperty(
                log_group_arn="logGroupArn"
            )
        )],
        include_execution_data=False,
        level="level"
    ),
    role_arn="roleArn",
    state_machine_name="stateMachineName",
    state_machine_type="stateMachineType",
    tags=[stepfunctions_mixins.CfnStateMachinePropsMixin.TagsEntryProperty(
        key="key",
        value="value"
    )],
    tracing_configuration=stepfunctions_mixins.CfnStateMachinePropsMixin.TracingConfigurationProperty(
        enabled=False
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::StepFunctions::StateMachine.

Parameters:

props (Union[CfnStateMachineMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['definition', 'definitionS3Location', 'definitionString', 'definitionSubstitutions', 'encryptionConfiguration', 'loggingConfiguration', 'roleArn', 'stateMachineName', 'stateMachineType', 'tags', 'tracingConfiguration']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CloudWatchLogsLogGroupProperty

class CfnStateMachinePropsMixin.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.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

cloud_watch_logs_log_group_property = stepfunctions_mixins.CfnStateMachinePropsMixin.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 CfnStateMachinePropsMixin.EncryptionConfigurationProperty(*, kms_data_key_reuse_period_seconds=None, kms_key_id=None, type=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 key for encryption.

Parameters:

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 key to encrypt data. To specify a AWS key in a different AWS account, you must use the key ARN or alias ARN.
type (Optional[str]) – Encryption option for a state machine.

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.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

encryption_configuration_property = stepfunctions_mixins.CfnStateMachinePropsMixin.EncryptionConfigurationProperty(
    kms_data_key_reuse_period_seconds=123,
    kms_key_id="kmsKeyId",
    type="type"
)

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 key to encrypt data.

To specify a AWS 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 CfnStateMachinePropsMixin.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 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.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

log_destination_property = stepfunctions_mixins.CfnStateMachinePropsMixin.LogDestinationProperty(
    cloud_watch_logs_log_group=stepfunctions_mixins.CfnStateMachinePropsMixin.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 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 CfnStateMachinePropsMixin.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.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

logging_configuration_property = stepfunctions_mixins.CfnStateMachinePropsMixin.LoggingConfigurationProperty(
    destinations=[stepfunctions_mixins.CfnStateMachinePropsMixin.LogDestinationProperty(
        cloud_watch_logs_log_group=stepfunctions_mixins.CfnStateMachinePropsMixin.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 CfnStateMachinePropsMixin.S3LocationProperty(*, bucket=None, key=None, 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 (Optional[str]) – The name of the S3 bucket where the state machine definition JSON or YAML file is stored.
key (Optional[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.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

s3_location_property = stepfunctions_mixins.CfnStateMachinePropsMixin.S3LocationProperty(
    bucket="bucket",
    key="key",
    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 CfnStateMachinePropsMixin.TagsEntryProperty(*, key=None, value=None)

Bases: object

The TagsEntry property specifies tags to identify a state machine.

Parameters:

key (Optional[str]) – The key for a key-value pair in a tag entry.
value (Optional[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.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

tags_entry_property = stepfunctions_mixins.CfnStateMachinePropsMixin.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 CfnStateMachinePropsMixin.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.mixins_preview.aws_stepfunctions import mixins as stepfunctions_mixins

tracing_configuration_property = stepfunctions_mixins.CfnStateMachinePropsMixin.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