CfnStateMachineProps

class aws_cdk.aws_sam.CfnStateMachineProps(*, definition=None, definition_substitutions=None, definition_uri=None, events=None, logging=None, name=None, permissions_boundaries=None, policies=None, role=None, tags=None, tracing=None, type=None)

Bases: object

Properties for defining a CfnStateMachine.

Parameters
  • definition (Optional[Any]) – AWS::Serverless::StateMachine.Definition.

  • definition_substitutions (Union[IResolvable, Mapping[str, str], None]) – AWS::Serverless::StateMachine.DefinitionSubstitutions.

  • definition_uri (Union[str, IResolvable, S3LocationProperty, Dict[str, Any], None]) – AWS::Serverless::StateMachine.DefinitionUri.

  • events (Union[IResolvable, Mapping[str, Union[IResolvable, EventSourceProperty, Dict[str, Any]]], None]) – AWS::Serverless::StateMachine.Events.

  • logging (Union[IResolvable, LoggingConfigurationProperty, Dict[str, Any], None]) – AWS::Serverless::StateMachine.Logging.

  • name (Optional[str]) – AWS::Serverless::StateMachine.Name.

  • permissions_boundaries (Optional[str]) – AWS::Serverless::StateMachine.PermissionsBoundaries.

  • policies (Union[str, IResolvable, IAMPolicyDocumentProperty, Dict[str, Any], Sequence[Union[str, IResolvable, IAMPolicyDocumentProperty, Dict[str, Any], SAMPolicyTemplateProperty]], None]) – AWS::Serverless::StateMachine.Policies.

  • role (Optional[str]) – AWS::Serverless::StateMachine.Role.

  • tags (Optional[Mapping[str, str]]) – AWS::Serverless::StateMachine.Tags.

  • tracing (Union[IResolvable, TracingConfigurationProperty, Dict[str, Any], None]) – AWS::Serverless::StateMachine.Tracing.

  • type (Optional[str]) – AWS::Serverless::StateMachine.Type.

Link

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-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_sam as sam

# definition: Any

cfn_state_machine_props = sam.CfnStateMachineProps(
    definition=definition,
    definition_substitutions={
        "definition_substitutions_key": "definitionSubstitutions"
    },
    definition_uri="definitionUri",
    events={
        "events_key": sam.CfnStateMachine.EventSourceProperty(
            properties=sam.CfnStateMachine.CloudWatchEventEventProperty(
                method="method",
                path="path",

                # the properties below are optional
                rest_api_id="restApiId"
            ),
            type="type"
        )
    },
    logging=sam.CfnStateMachine.LoggingConfigurationProperty(
        destinations=[sam.CfnStateMachine.LogDestinationProperty(
            cloud_watch_logs_log_group=sam.CfnStateMachine.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.CfnStateMachine.TracingConfigurationProperty(
        enabled=False
    ),
    type="type"
)

Attributes

definition

AWS::Serverless::StateMachine.Definition.

Link

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

Return type

Any

definition_substitutions

AWS::Serverless::StateMachine.DefinitionSubstitutions.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

definition_uri

AWS::Serverless::StateMachine.DefinitionUri.

Link

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

Return type

Union[str, IResolvable, S3LocationProperty, None]

events

AWS::Serverless::StateMachine.Events.

Link

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

Return type

Union[IResolvable, Mapping[str, Union[IResolvable, EventSourceProperty]], None]

logging

AWS::Serverless::StateMachine.Logging.

Link

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

Return type

Union[IResolvable, LoggingConfigurationProperty, None]

name

AWS::Serverless::StateMachine.Name.

Link

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

Return type

Optional[str]

permissions_boundaries

AWS::Serverless::StateMachine.PermissionsBoundaries.

Link

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

Return type

Optional[str]

policies

AWS::Serverless::StateMachine.Policies.

Link

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

Return type

Union[str, IResolvable, IAMPolicyDocumentProperty, List[Union[str, IResolvable, IAMPolicyDocumentProperty, SAMPolicyTemplateProperty]], None]

role

AWS::Serverless::StateMachine.Role.

Link

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

Return type

Optional[str]

tags

AWS::Serverless::StateMachine.Tags.

Link

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

Return type

Optional[Mapping[str, str]]

tracing

AWS::Serverless::StateMachine.Tracing.

Link

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

Return type

Union[IResolvable, TracingConfigurationProperty, None]

type

AWS::Serverless::StateMachine.Type.

Link

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

Return type

Optional[str]