Package software.amazon.awscdk.services.sam

Class CfnStateMachine

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.sam.CfnStateMachine

All Implemented Interfaces:

software.amazon.awscdk.core.IConstruct, software.amazon.awscdk.core.IDependable, software.amazon.awscdk.core.IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-31T18:44:07.471Z")
@Stability(Stable)
public class CfnStateMachine
extends software.amazon.awscdk.core.CfnResource
implements software.amazon.awscdk.core.IInspectable

A CloudFormation `AWS::Serverless::StateMachine`.

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;
 CfnStateMachine cfnStateMachine = CfnStateMachine.Builder.create(this, "MyCfnStateMachine")
         .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	Class	Description
static interface	CfnStateMachine.ApiEventProperty	Example:
static final class	CfnStateMachine.Builder	A fluent builder for CfnStateMachine.
static interface	CfnStateMachine.CloudWatchEventEventProperty	Example:
static interface	CfnStateMachine.CloudWatchLogsLogGroupProperty	Example:
static interface	CfnStateMachine.EventBridgeRuleEventProperty	Example:
static interface	CfnStateMachine.EventSourceProperty	Example:
static interface	CfnStateMachine.FunctionSAMPTProperty	Example:
static interface	CfnStateMachine.IAMPolicyDocumentProperty	Example:
static interface	CfnStateMachine.LogDestinationProperty	Example:
static interface	CfnStateMachine.LoggingConfigurationProperty	Example:
static interface	CfnStateMachine.S3LocationProperty	Example:
static interface	CfnStateMachine.SAMPolicyTemplateProperty	Example:
static interface	CfnStateMachine.ScheduleEventProperty	Example:
static interface	CfnStateMachine.StateMachineSAMPTProperty	Example:
static interface	CfnStateMachine.TracingConfigurationProperty	Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

software.amazon.awscdk.core.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

software.amazon.awscdk.core.IInspectable.Jsii$Default, software.amazon.awscdk.core.IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
static final String	REQUIRED_TRANSFORM	The `Transform` a template must use in order to use this resource.

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnStateMachine(software.amazon.awscdk.core.Construct scope, String id)	Create a new `AWS::Serverless::StateMachine`.
	CfnStateMachine(software.amazon.awscdk.core.Construct scope, String id, CfnStateMachineProps props)	Create a new `AWS::Serverless::StateMachine`.
protected	CfnStateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStateMachine(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getCfnProperties()
Object	getDefinition()	`AWS::Serverless::StateMachine.Definition`.
Object	getDefinitionSubstitutions()	`AWS::Serverless::StateMachine.DefinitionSubstitutions`.
Object	getDefinitionUri()	`AWS::Serverless::StateMachine.DefinitionUri`.
Object	getEvents()	`AWS::Serverless::StateMachine.Events`.
Object	getLogging()	`AWS::Serverless::StateMachine.Logging`.
String	getName()	`AWS::Serverless::StateMachine.Name`.
String	getPermissionsBoundaries()	`AWS::Serverless::StateMachine.PermissionsBoundaries`.
Object	getPolicies()	`AWS::Serverless::StateMachine.Policies`.
String	getRole()	`AWS::Serverless::StateMachine.Role`.
software.amazon.awscdk.core.TagManager	getTags()	`AWS::Serverless::StateMachine.Tags`.
Object	getTracing()	`AWS::Serverless::StateMachine.Tracing`.
String	getType()	`AWS::Serverless::StateMachine.Type`.
void	inspect(software.amazon.awscdk.core.TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDefinition(Object value)	`AWS::Serverless::StateMachine.Definition`.
void	setDefinitionSubstitutions(Map<String,String> value)	`AWS::Serverless::StateMachine.DefinitionSubstitutions`.
void	setDefinitionSubstitutions(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::StateMachine.DefinitionSubstitutions`.
void	setDefinitionUri(String value)	`AWS::Serverless::StateMachine.DefinitionUri`.
void	setDefinitionUri(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::StateMachine.DefinitionUri`.
void	setDefinitionUri(CfnStateMachine.S3LocationProperty value)	`AWS::Serverless::StateMachine.DefinitionUri`.
void	setEvents(Map<String,Object> value)	`AWS::Serverless::StateMachine.Events`.
void	setEvents(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::StateMachine.Events`.
void	setLogging(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::StateMachine.Logging`.
void	setLogging(CfnStateMachine.LoggingConfigurationProperty value)	`AWS::Serverless::StateMachine.Logging`.
void	setName(String value)	`AWS::Serverless::StateMachine.Name`.
void	setPermissionsBoundaries(String value)	`AWS::Serverless::StateMachine.PermissionsBoundaries`.
void	setPolicies(String value)	`AWS::Serverless::StateMachine.Policies`.
void	setPolicies(List<Object> value)	`AWS::Serverless::StateMachine.Policies`.
void	setPolicies(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::StateMachine.Policies`.
void	setPolicies(CfnStateMachine.IAMPolicyDocumentProperty value)	`AWS::Serverless::StateMachine.Policies`.
void	setRole(String value)	`AWS::Serverless::StateMachine.Role`.
void	setTracing(software.amazon.awscdk.core.IResolvable value)	`AWS::Serverless::StateMachine.Tracing`.
void	setTracing(CfnStateMachine.TracingConfigurationProperty value)	`AWS::Serverless::StateMachine.Tracing`.
void	setType(String value)	`AWS::Serverless::StateMachine.Type`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

REQUIRED_TRANSFORM

@Stability(Stable)
public static final String REQUIRED_TRANSFORM

The `Transform` a template must use in order to use this resource.

Constructor Details

CfnStateMachine

protected CfnStateMachine(software.amazon.jsii.JsiiObjectRef objRef)

CfnStateMachine

protected CfnStateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnStateMachine

@Stability(Stable)
public CfnStateMachine(@NotNull
 software.amazon.awscdk.core.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnStateMachineProps props)

Create a new `AWS::Serverless::StateMachine`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnStateMachine

@Stability(Stable)
public CfnStateMachine(@NotNull
 software.amazon.awscdk.core.Construct scope,
 @NotNull
 String id)

Create a new `AWS::Serverless::StateMachine`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 software.amazon.awscdk.core.TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface software.amazon.awscdk.core.IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class software.amazon.awscdk.core.CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class software.amazon.awscdk.core.CfnResource

getTags

@Stability(Stable)
@NotNull
public software.amazon.awscdk.core.TagManager getTags()

`AWS::Serverless::StateMachine.Tags`.

getDefinition

@Stability(Stable)
@NotNull
public Object getDefinition()

`AWS::Serverless::StateMachine.Definition`.

setDefinition

@Stability(Stable)
public void setDefinition(@NotNull
 Object value)

`AWS::Serverless::StateMachine.Definition`.

getDefinitionSubstitutions

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

`AWS::Serverless::StateMachine.DefinitionSubstitutions`.

setDefinitionSubstitutions

@Stability(Stable)
public void setDefinitionSubstitutions(@Nullable
 software.amazon.awscdk.core.IResolvable value)

`AWS::Serverless::StateMachine.DefinitionSubstitutions`.

setDefinitionSubstitutions

@Stability(Stable)
public void setDefinitionSubstitutions(@Nullable
 Map<String,String> value)

`AWS::Serverless::StateMachine.DefinitionSubstitutions`.

getDefinitionUri

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

`AWS::Serverless::StateMachine.DefinitionUri`.

setDefinitionUri

@Stability(Stable)
public void setDefinitionUri(@Nullable
 String value)

`AWS::Serverless::StateMachine.DefinitionUri`.

setDefinitionUri

@Stability(Stable)
public void setDefinitionUri(@Nullable
 software.amazon.awscdk.core.IResolvable value)

`AWS::Serverless::StateMachine.DefinitionUri`.

setDefinitionUri

@Stability(Stable)
public void setDefinitionUri(@Nullable
 CfnStateMachine.S3LocationProperty value)

`AWS::Serverless::StateMachine.DefinitionUri`.

getEvents

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

`AWS::Serverless::StateMachine.Events`.

setEvents

@Stability(Stable)
public void setEvents(@Nullable
 software.amazon.awscdk.core.IResolvable value)

`AWS::Serverless::StateMachine.Events`.

setEvents

@Stability(Stable)
public void setEvents(@Nullable
 Map<String,Object> value)

`AWS::Serverless::StateMachine.Events`.

getLogging

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

`AWS::Serverless::StateMachine.Logging`.

setLogging

@Stability(Stable)
public void setLogging(@Nullable
 software.amazon.awscdk.core.IResolvable value)

`AWS::Serverless::StateMachine.Logging`.

setLogging

@Stability(Stable)
public void setLogging(@Nullable
 CfnStateMachine.LoggingConfigurationProperty value)

`AWS::Serverless::StateMachine.Logging`.

getName

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

`AWS::Serverless::StateMachine.Name`.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

`AWS::Serverless::StateMachine.Name`.

getPermissionsBoundaries

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

`AWS::Serverless::StateMachine.PermissionsBoundaries`.

setPermissionsBoundaries

@Stability(Stable)
public void setPermissionsBoundaries(@Nullable
 String value)

`AWS::Serverless::StateMachine.PermissionsBoundaries`.

getPolicies

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

`AWS::Serverless::StateMachine.Policies`.

setPolicies

@Stability(Stable)
public void setPolicies(@Nullable
 String value)

`AWS::Serverless::StateMachine.Policies`.

setPolicies

@Stability(Stable)
public void setPolicies(@Nullable
 software.amazon.awscdk.core.IResolvable value)

`AWS::Serverless::StateMachine.Policies`.

setPolicies

@Stability(Stable)
public void setPolicies(@Nullable
 CfnStateMachine.IAMPolicyDocumentProperty value)

`AWS::Serverless::StateMachine.Policies`.

setPolicies

@Stability(Stable)
public void setPolicies(@Nullable
 List<Object> value)

`AWS::Serverless::StateMachine.Policies`.

getRole

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

`AWS::Serverless::StateMachine.Role`.

setRole

@Stability(Stable)
public void setRole(@Nullable
 String value)

`AWS::Serverless::StateMachine.Role`.

getTracing

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

`AWS::Serverless::StateMachine.Tracing`.

setTracing

@Stability(Stable)
public void setTracing(@Nullable
 software.amazon.awscdk.core.IResolvable value)

`AWS::Serverless::StateMachine.Tracing`.

setTracing

@Stability(Stable)
public void setTracing(@Nullable
 CfnStateMachine.TracingConfigurationProperty value)

`AWS::Serverless::StateMachine.Tracing`.

getType

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

`AWS::Serverless::StateMachine.Type`.

setType

@Stability(Stable)
public void setType(@Nullable
 String value)

`AWS::Serverless::StateMachine.Type`.