CfnStateMachinePropsMixin

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

Bases: Mixin

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html
CloudformationResource:: AWS::Serverless::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_sam import mixins as sam_mixins

# definition: Any

cfn_state_machine_props_mixin = sam_mixins.CfnStateMachinePropsMixin(sam_mixins.CfnStateMachineMixinProps(
    definition=definition,
    definition_substitutions={
        "definition_substitutions_key": "definitionSubstitutions"
    },
    definition_uri="definitionUri",
    events={
        "events_key": sam_mixins.CfnStateMachinePropsMixin.EventSourceProperty(
            properties=sam_mixins.CfnStateMachinePropsMixin.ApiEventProperty(
                method="method",
                path="path",
                rest_api_id="restApiId"
            ),
            type="type"
        )
    },
    logging=sam_mixins.CfnStateMachinePropsMixin.LoggingConfigurationProperty(
        destinations=[sam_mixins.CfnStateMachinePropsMixin.LogDestinationProperty(
            cloud_watch_logs_log_group=sam_mixins.CfnStateMachinePropsMixin.CloudWatchLogsLogGroupProperty(
                log_group_arn="logGroupArn"
            )
        )],
        include_execution_data=False,
        level="level"
    ),
    name="name",
    permissions_boundaries="permissionsBoundaries",
    policies="policies",
    role="role",
    tags={
        "tags_key": "tags"
    },
    tracing=sam_mixins.CfnStateMachinePropsMixin.TracingConfigurationProperty(
        enabled=False
    ),
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Serverless::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', 'definitionSubstitutions', 'definitionUri', 'events', 'logging', 'name', 'permissionsBoundaries', 'policies', 'role', 'tags', 'tracing', 'type']

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

ApiEventProperty

class CfnStateMachinePropsMixin.ApiEventProperty(*, method=None, path=None, rest_api_id=None)

Bases: object

Parameters:

method (Optional[str])
path (Optional[str])
rest_api_id (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-apievent.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_sam import mixins as sam_mixins

api_event_property = sam_mixins.CfnStateMachinePropsMixin.ApiEventProperty(
    method="method",
    path="path",
    rest_api_id="restApiId"
)

Attributes

method

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-apievent.html#cfn-serverless-statemachine-apievent-method

Type:: see

path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-apievent.html#cfn-serverless-statemachine-apievent-path

Type:: see

rest_api_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-apievent.html#cfn-serverless-statemachine-apievent-restapiid

Type:: see

CloudWatchEventEventProperty

class CfnStateMachinePropsMixin.CloudWatchEventEventProperty(*, event_bus_name=None, input=None, input_path=None, pattern=None)

Bases: object

Parameters:

event_bus_name (Optional[str])
input (Optional[str])
input_path (Optional[str])
pattern (Any)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-cloudwatcheventevent.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_sam import mixins as sam_mixins

# pattern: Any

cloud_watch_event_event_property = sam_mixins.CfnStateMachinePropsMixin.CloudWatchEventEventProperty(
    event_bus_name="eventBusName",
    input="input",
    input_path="inputPath",
    pattern=pattern
)

Attributes

event_bus_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-cloudwatcheventevent.html#cfn-serverless-statemachine-cloudwatcheventevent-eventbusname

Type:: see

input

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-cloudwatcheventevent.html#cfn-serverless-statemachine-cloudwatcheventevent-input

Type:: see

input_path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-cloudwatcheventevent.html#cfn-serverless-statemachine-cloudwatcheventevent-inputpath

Type:: see

pattern

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-cloudwatcheventevent.html#cfn-serverless-statemachine-cloudwatcheventevent-pattern

Type:: see

CloudWatchLogsLogGroupProperty

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

Bases: object

Parameters:: log_group_arn (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-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_sam import mixins as sam_mixins

cloud_watch_logs_log_group_property = sam_mixins.CfnStateMachinePropsMixin.CloudWatchLogsLogGroupProperty(
    log_group_arn="logGroupArn"
)

Attributes

log_group_arn

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

Type:: see

EventBridgeRuleEventProperty

class CfnStateMachinePropsMixin.EventBridgeRuleEventProperty(*, event_bus_name=None, input=None, input_path=None, pattern=None)

Bases: object

Parameters:

event_bus_name (Optional[str])
input (Optional[str])
input_path (Optional[str])
pattern (Any)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventbridgeruleevent.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_sam import mixins as sam_mixins

# pattern: Any

event_bridge_rule_event_property = sam_mixins.CfnStateMachinePropsMixin.EventBridgeRuleEventProperty(
    event_bus_name="eventBusName",
    input="input",
    input_path="inputPath",
    pattern=pattern
)

Attributes

event_bus_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventbridgeruleevent.html#cfn-serverless-statemachine-eventbridgeruleevent-eventbusname

Type:: see

input

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventbridgeruleevent.html#cfn-serverless-statemachine-eventbridgeruleevent-input

Type:: see

input_path

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventbridgeruleevent.html#cfn-serverless-statemachine-eventbridgeruleevent-inputpath

Type:: see

pattern

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventbridgeruleevent.html#cfn-serverless-statemachine-eventbridgeruleevent-pattern

Type:: see

EventSourceProperty

class CfnStateMachinePropsMixin.EventSourceProperty(*, properties=None, type=None)

Bases: object

Parameters:

properties (Union[IResolvable, ApiEventProperty, Dict[str, Any], CloudWatchEventEventProperty, EventBridgeRuleEventProperty, ScheduleEventProperty, None])
type (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventsource.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_sam import mixins as sam_mixins

event_source_property = sam_mixins.CfnStateMachinePropsMixin.EventSourceProperty(
    properties=sam_mixins.CfnStateMachinePropsMixin.ApiEventProperty(
        method="method",
        path="path",
        rest_api_id="restApiId"
    ),
    type="type"
)

Attributes

properties

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-eventsource.html#cfn-serverless-statemachine-eventsource-properties

Type:: see

type

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

Type:: see

FunctionSAMPTProperty

class CfnStateMachinePropsMixin.FunctionSAMPTProperty(*, function_name=None)

Bases: object

Parameters:: function_name (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-functionsampt.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_sam import mixins as sam_mixins

function_sAMPTProperty = sam_mixins.CfnStateMachinePropsMixin.FunctionSAMPTProperty(
    function_name="functionName"
)

Attributes

function_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-functionsampt.html#cfn-serverless-statemachine-functionsampt-functionname

Type:: see

IAMPolicyDocumentProperty

class CfnStateMachinePropsMixin.IAMPolicyDocumentProperty(*, statement=None, version=None)

Bases: object

Parameters:

statement (Any)
version (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-iampolicydocument.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_sam import mixins as sam_mixins

# statement: Any

i_aMPolicy_document_property = {
    "statement": statement,
    "version": "version"
}

Attributes

statement

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-iampolicydocument.html#cfn-serverless-statemachine-iampolicydocument-statement

Type:: see

version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-iampolicydocument.html#cfn-serverless-statemachine-iampolicydocument-version

Type:: see

LogDestinationProperty

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

Bases: object

Parameters:: cloud_watch_logs_log_group (Union[IResolvable, CloudWatchLogsLogGroupProperty, Dict[str, Any], None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-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_sam import mixins as sam_mixins

log_destination_property = sam_mixins.CfnStateMachinePropsMixin.LogDestinationProperty(
    cloud_watch_logs_log_group=sam_mixins.CfnStateMachinePropsMixin.CloudWatchLogsLogGroupProperty(
        log_group_arn="logGroupArn"
    )
)

Attributes

cloud_watch_logs_log_group

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

Type:: see

LoggingConfigurationProperty

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

Bases: object

Parameters:

destinations (Union[IResolvable, Sequence[Union[IResolvable, LogDestinationProperty, Dict[str, Any]]], None])
include_execution_data (Union[bool, IResolvable, None])
level (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-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_sam import mixins as sam_mixins

logging_configuration_property = sam_mixins.CfnStateMachinePropsMixin.LoggingConfigurationProperty(
    destinations=[sam_mixins.CfnStateMachinePropsMixin.LogDestinationProperty(
        cloud_watch_logs_log_group=sam_mixins.CfnStateMachinePropsMixin.CloudWatchLogsLogGroupProperty(
            log_group_arn="logGroupArn"
        )
    )],
    include_execution_data=False,
    level="level"
)

Attributes

destinations

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

Type:: see

include_execution_data

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

Type:: see

level

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

Type:: see

S3LocationProperty

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

Bases: object

Parameters:

bucket (Optional[str])
key (Optional[str])
version (Union[int, float, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-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_sam import mixins as sam_mixins

s3_location_property = sam_mixins.CfnStateMachinePropsMixin.S3LocationProperty(
    bucket="bucket",
    key="key",
    version=123
)

Attributes

bucket

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

Type:: see

key

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

Type:: see

version

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

Type:: see

SAMPolicyTemplateProperty

class CfnStateMachinePropsMixin.SAMPolicyTemplateProperty(*, lambda_invoke_policy=None, step_functions_execution_policy=None)

Bases: object

Parameters:

lambda_invoke_policy (Union[IResolvable, FunctionSAMPTProperty, Dict[str, Any], None])
step_functions_execution_policy (Union[IResolvable, StateMachineSAMPTProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-sampolicytemplate.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_sam import mixins as sam_mixins

s_aMPolicy_template_property = sam_mixins.CfnStateMachinePropsMixin.SAMPolicyTemplateProperty(
    lambda_invoke_policy=sam_mixins.CfnStateMachinePropsMixin.FunctionSAMPTProperty(
        function_name="functionName"
    ),
    step_functions_execution_policy=sam_mixins.CfnStateMachinePropsMixin.StateMachineSAMPTProperty(
        state_machine_name="stateMachineName"
    )
)

Attributes

lambda_invoke_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-sampolicytemplate.html#cfn-serverless-statemachine-sampolicytemplate-lambdainvokepolicy

Type:: see

step_functions_execution_policy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-sampolicytemplate.html#cfn-serverless-statemachine-sampolicytemplate-stepfunctionsexecutionpolicy

Type:: see

ScheduleEventProperty

class CfnStateMachinePropsMixin.ScheduleEventProperty(*, input=None, schedule=None)

Bases: object

Parameters:

input (Optional[str])
schedule (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-scheduleevent.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_sam import mixins as sam_mixins

schedule_event_property = sam_mixins.CfnStateMachinePropsMixin.ScheduleEventProperty(
    input="input",
    schedule="schedule"
)

Attributes

input

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-scheduleevent.html#cfn-serverless-statemachine-scheduleevent-input

Type:: see

schedule

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-scheduleevent.html#cfn-serverless-statemachine-scheduleevent-schedule

Type:: see

StateMachineSAMPTProperty

class CfnStateMachinePropsMixin.StateMachineSAMPTProperty(*, state_machine_name=None)

Bases: object

Parameters:: state_machine_name (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-statemachinesampt.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_sam import mixins as sam_mixins

state_machine_sAMPTProperty = sam_mixins.CfnStateMachinePropsMixin.StateMachineSAMPTProperty(
    state_machine_name="stateMachineName"
)

Attributes

state_machine_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-statemachine-statemachinesampt.html#cfn-serverless-statemachine-statemachinesampt-statemachinename

Type:: see

TracingConfigurationProperty

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

Bases: object

Parameters:: enabled (Union[bool, IResolvable, None])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-serverless-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_sam import mixins as sam_mixins

tracing_configuration_property = sam_mixins.CfnStateMachinePropsMixin.TracingConfigurationProperty(
    enabled=False
)

Attributes

enabled

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

Type:: see