Package software.amazon.awscdk.services.sam

Interface CfnStateMachineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStateMachineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:29.971Z")
@Stability(Stable)
public interface CfnStateMachineProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStateMachine.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sam.*;
 Object definition;
 CfnStateMachineProps cfnStateMachineProps = CfnStateMachineProps.builder()
         .definition(definition)
         .definitionSubstitutions(Map.of(
                 "definitionSubstitutionsKey", "definitionSubstitutions"))
         .definitionUri("definitionUri")
         .events(Map.of(
                 "eventsKey", EventSourceProperty.builder()
                         .properties(ApiEventProperty.builder()
                                 .method("method")
                                 .path("path")
                                 // the properties below are optional
                                 .restApiId("restApiId")
                                 .build())
                         .type("type")
                         .build()))
         .logging(LoggingConfigurationProperty.builder()
                 .destinations(List.of(LogDestinationProperty.builder()
                         .cloudWatchLogsLogGroup(CloudWatchLogsLogGroupProperty.builder()
                                 .logGroupArn("logGroupArn")
                                 .build())
                         .build()))
                 .includeExecutionData(false)
                 .level("level")
                 .build())
         .name("name")
         .permissionsBoundaries("permissionsBoundaries")
         .policies("policies")
         .role("role")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .tracing(TracingConfigurationProperty.builder()
                 .enabled(false)
                 .build())
         .type("type")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStateMachineProps.Builder	A builder for CfnStateMachineProps
static final class	CfnStateMachineProps.Jsii$Proxy	An implementation for CfnStateMachineProps

Method Summary

Modifier and Type	Method	Description
static CfnStateMachineProps.Builder	builder()
default Object	getDefinition()
default Object	getDefinitionSubstitutions()	Returns union: either Mapinvalid input: '<'String, String> or IResolvable
default Object	getDefinitionUri()	Returns union: either String or IResolvable or CfnStateMachine.S3LocationProperty
default Object	getEvents()	Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnStateMachine.EventSourceProperty>
default Object	getLogging()	Returns union: either IResolvable or CfnStateMachine.LoggingConfigurationProperty
default String	getName()
default String	getPermissionsBoundaries()
default Object	getPolicies()	Returns union: either String or IResolvable or CfnStateMachine.IAMPolicyDocumentProperty or Listinvalid input: '<'either String or IResolvable or CfnStateMachine.IAMPolicyDocumentProperty or CfnStateMachine.SAMPolicyTemplateProperty>
default String	getRole()
default Map<String,String>	getTags()
default Object	getTracing()	Returns union: either IResolvable or CfnStateMachine.TracingConfigurationProperty
default String	getType()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefinition

@Stability(Stable)
@Nullable
default Object getDefinition()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-definition

getDefinitionSubstitutions

@Stability(Stable)
@Nullable
default Object getDefinitionSubstitutions()

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getDefinitionUri

@Stability(Stable)
@Nullable
default Object getDefinitionUri()

Returns union: either String or IResolvable or CfnStateMachine.S3LocationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-definitionuri

getEvents

@Stability(Stable)
@Nullable
default Object getEvents()

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnStateMachine.EventSourceProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-events

getLogging

@Stability(Stable)
@Nullable
default Object getLogging()

Returns union: either IResolvable or CfnStateMachine.LoggingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-logging

getName

@Stability(Stable)
@Nullable
default String getName()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-name

getPermissionsBoundaries

@Stability(Stable)
@Nullable
default String getPermissionsBoundaries()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-permissionsboundaries

getPolicies

@Stability(Stable)
@Nullable
default Object getPolicies()

Returns union: either String or IResolvable or CfnStateMachine.IAMPolicyDocumentProperty or Listinvalid input: '<'either String or IResolvable or CfnStateMachine.IAMPolicyDocumentProperty or CfnStateMachine.SAMPolicyTemplateProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-policies

getRole

@Stability(Stable)
@Nullable
default String getRole()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-role

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-tags

getTracing

@Stability(Stable)
@Nullable
default Object getTracing()

Returns union: either IResolvable or CfnStateMachine.TracingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-serverless-statemachine.html#cfn-serverless-statemachine-tracing

getType

@Stability(Stable)
@Nullable
default String getType()

See Also:

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

builder

@Stability(Stable)
static CfnStateMachineProps.Builder builder()

Returns:

a CfnStateMachineProps.Builder of CfnStateMachineProps