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.104.0 (build e79254c)",
           date="2024-12-17T21:37:39.145Z")
@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()
default Object	getDefinitionUri()
default Object	getEvents()
default Object	getLogging()
default String	getName()
default String	getPermissionsBoundaries()
default Object	getPolicies()
default String	getRole()
default Map<String,String>	getTags()
default Object	getTracing()
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()

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

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

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

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

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

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