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.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:35.713Z")
@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(CloudWatchEventEventProperty.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();
 

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()	AWS::Serverless::StateMachine.Definition.
default Object	getDefinitionSubstitutions()	AWS::Serverless::StateMachine.DefinitionSubstitutions.
default Object	getDefinitionUri()	AWS::Serverless::StateMachine.DefinitionUri.
default Object	getEvents()	AWS::Serverless::StateMachine.Events.
default Object	getLogging()	AWS::Serverless::StateMachine.Logging.
default String	getName()	AWS::Serverless::StateMachine.Name.
default String	getPermissionsBoundaries()	AWS::Serverless::StateMachine.PermissionsBoundaries.
default Object	getPolicies()	AWS::Serverless::StateMachine.Policies.
default String	getRole()	AWS::Serverless::StateMachine.Role.
default Map<String,String>	getTags()	AWS::Serverless::StateMachine.Tags.
default Object	getTracing()	AWS::Serverless::StateMachine.Tracing.
default String	getType()	AWS::Serverless::StateMachine.Type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefinition

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

AWS::Serverless::StateMachine.Definition.

getDefinitionSubstitutions

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

AWS::Serverless::StateMachine.DefinitionSubstitutions.

getDefinitionUri

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

AWS::Serverless::StateMachine.DefinitionUri.

getEvents

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

AWS::Serverless::StateMachine.Events.

getLogging

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

AWS::Serverless::StateMachine.Logging.

getName

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

AWS::Serverless::StateMachine.Name.

getPermissionsBoundaries

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

AWS::Serverless::StateMachine.PermissionsBoundaries.

getPolicies

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

AWS::Serverless::StateMachine.Policies.

getRole

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

AWS::Serverless::StateMachine.Role.

getTags

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

AWS::Serverless::StateMachine.Tags.

getTracing

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

AWS::Serverless::StateMachine.Tracing.

getType

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

AWS::Serverless::StateMachine.Type.

builder

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

Returns:

a CfnStateMachineProps.Builder of CfnStateMachineProps