software.amazon.awscdk.services.sam

Class CfnStateMachine

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.sam.CfnStateMachine

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.998Z")
 @Stability(value=Stable)
public class CfnStateMachine
extends CfnResource
implements 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 and Description
static interface	CfnStateMachine.ApiEventProperty Example:
static 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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStateMachine(software.constructs.Construct scope, String id) Create a new `AWS::Serverless::StateMachine`.
	CfnStateMachine(software.constructs.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 and 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`.
TagManager	getTags() `AWS::Serverless::StateMachine.Tags`.
Object	getTracing() `AWS::Serverless::StateMachine.Tracing`.
String	getType() `AWS::Serverless::StateMachine.Type`.
void	inspect(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(IResolvable value) `AWS::Serverless::StateMachine.DefinitionSubstitutions`.
void	setDefinitionSubstitutions(Map<String,String> value) `AWS::Serverless::StateMachine.DefinitionSubstitutions`.
void	setDefinitionUri(CfnStateMachine.S3LocationProperty value) `AWS::Serverless::StateMachine.DefinitionUri`.
void	setDefinitionUri(IResolvable value) `AWS::Serverless::StateMachine.DefinitionUri`.
void	setDefinitionUri(String value) `AWS::Serverless::StateMachine.DefinitionUri`.
void	setEvents(IResolvable value) `AWS::Serverless::StateMachine.Events`.
void	setEvents(Map<String,Object> value) `AWS::Serverless::StateMachine.Events`.
void	setLogging(CfnStateMachine.LoggingConfigurationProperty value) `AWS::Serverless::StateMachine.Logging`.
void	setLogging(IResolvable value) `AWS::Serverless::StateMachine.Logging`.
void	setName(String value) `AWS::Serverless::StateMachine.Name`.
void	setPermissionsBoundaries(String value) `AWS::Serverless::StateMachine.PermissionsBoundaries`.
void	setPolicies(CfnStateMachine.IAMPolicyDocumentProperty value) `AWS::Serverless::StateMachine.Policies`.
void	setPolicies(IResolvable value) `AWS::Serverless::StateMachine.Policies`.
void	setPolicies(List<Object> value) `AWS::Serverless::StateMachine.Policies`.
void	setPolicies(String value) `AWS::Serverless::StateMachine.Policies`.
void	setRole(String value) `AWS::Serverless::StateMachine.Role`.
void	setTracing(CfnStateMachine.TracingConfigurationProperty value) `AWS::Serverless::StateMachine.Tracing`.
void	setTracing(IResolvable value) `AWS::Serverless::StateMachine.Tracing`.
void	setType(String value) `AWS::Serverless::StateMachine.Type`.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

REQUIRED_TRANSFORM

@Stability(value=Stable)
public static final String REQUIRED_TRANSFORM

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

Constructor Detail

CfnStateMachine

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

CfnStateMachine

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

CfnStateMachine

@Stability(value=Stable)
public CfnStateMachine(@NotNull
                                                software.constructs.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(value=Stable)
public CfnStateMachine(@NotNull
                                                software.constructs.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 Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

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

renderProperties

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

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getDefinition

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

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

setDefinition

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

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

getDefinitionSubstitutions

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

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

setDefinitionSubstitutions

@Stability(value=Stable)
public void setDefinitionSubstitutions(@Nullable
                                                                IResolvable value)

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

setDefinitionSubstitutions

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

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

getDefinitionUri

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

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

setDefinitionUri

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

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

setDefinitionUri

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

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

setDefinitionUri

@Stability(value=Stable)
public void setDefinitionUri(@Nullable
                                                      IResolvable value)

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

getEvents

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

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

setEvents

@Stability(value=Stable)
public void setEvents(@Nullable
                                               IResolvable value)

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

setEvents

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

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

getLogging

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

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

setLogging

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

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

setLogging

@Stability(value=Stable)
public void setLogging(@Nullable
                                                IResolvable value)

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

getName

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

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

setName

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

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

getPermissionsBoundaries

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

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

setPermissionsBoundaries

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

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

getPolicies

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

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

setPolicies

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

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

setPolicies

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

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

setPolicies

@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 IResolvable value)

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

setPolicies

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

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

getRole

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

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

setRole

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

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

getTracing

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

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

setTracing

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

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

setTracing

@Stability(value=Stable)
public void setTracing(@Nullable
                                                IResolvable value)

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

getType

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

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

setType

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

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