software.amazon.awscdk.services.sam

Class CfnStateMachine

java.lang.Object

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:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:17.862Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStateMachine(Construct scope, java.lang.String id) Create a new `AWS::Serverless::StateMachine`.
	CfnStateMachine(Construct scope, java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getDefinition() `AWS::Serverless::StateMachine.Definition`.
java.lang.Object	getDefinitionSubstitutions() `AWS::Serverless::StateMachine.DefinitionSubstitutions`.
java.lang.Object	getDefinitionUri() `AWS::Serverless::StateMachine.DefinitionUri`.
java.lang.Object	getEvents() `AWS::Serverless::StateMachine.Events`.
java.lang.Object	getLogging() `AWS::Serverless::StateMachine.Logging`.
java.lang.String	getName() `AWS::Serverless::StateMachine.Name`.
java.lang.String	getPermissionsBoundaries() `AWS::Serverless::StateMachine.PermissionsBoundaries`.
java.lang.Object	getPolicies() `AWS::Serverless::StateMachine.Policies`.
java.lang.String	getRole() `AWS::Serverless::StateMachine.Role`.
TagManager	getTags() `AWS::Serverless::StateMachine.Tags`.
java.lang.Object	getTracing() `AWS::Serverless::StateMachine.Tracing`.
java.lang.String	getType() `AWS::Serverless::StateMachine.Type`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDefinition(java.lang.Object value) `AWS::Serverless::StateMachine.Definition`.
void	setDefinitionSubstitutions(IResolvable value) `AWS::Serverless::StateMachine.DefinitionSubstitutions`.
void	setDefinitionSubstitutions(java.util.Map<java.lang.String,java.lang.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(java.lang.String value) `AWS::Serverless::StateMachine.DefinitionUri`.
void	setEvents(IResolvable value) `AWS::Serverless::StateMachine.Events`.
void	setEvents(java.util.Map<java.lang.String,java.lang.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(java.lang.String value) `AWS::Serverless::StateMachine.Name`.
void	setPermissionsBoundaries(java.lang.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(java.util.List<java.lang.Object> value) `AWS::Serverless::StateMachine.Policies`.
void	setPolicies(java.lang.String value) `AWS::Serverless::StateMachine.Policies`.
void	setRole(java.lang.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(java.lang.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 java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

REQUIRED_TRANSFORM

public static final java.lang.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

public CfnStateMachine(Construct scope,
                       java.lang.String id,
                       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

public CfnStateMachine(Construct scope,
                       java.lang.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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getDefinition

public java.lang.Object getDefinition()

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

setDefinition

public void setDefinition(java.lang.Object value)

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

getDefinitionSubstitutions

public java.lang.Object getDefinitionSubstitutions()

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

setDefinitionSubstitutions

public void setDefinitionSubstitutions(IResolvable value)

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

setDefinitionSubstitutions

public void setDefinitionSubstitutions(java.util.Map<java.lang.String,java.lang.String> value)

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

getDefinitionUri

public java.lang.Object getDefinitionUri()

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

setDefinitionUri

public void setDefinitionUri(java.lang.String value)

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

setDefinitionUri

public void setDefinitionUri(IResolvable value)

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

setDefinitionUri

public void setDefinitionUri(CfnStateMachine.S3LocationProperty value)

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

getEvents

public java.lang.Object getEvents()

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

setEvents

public void setEvents(IResolvable value)

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

setEvents

public void setEvents(java.util.Map<java.lang.String,java.lang.Object> value)

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

getLogging

public java.lang.Object getLogging()

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

setLogging

public void setLogging(IResolvable value)

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

setLogging

public void setLogging(CfnStateMachine.LoggingConfigurationProperty value)

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

getName

public java.lang.String getName()

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

setName

public void setName(java.lang.String value)

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

getPermissionsBoundaries

public java.lang.String getPermissionsBoundaries()

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

setPermissionsBoundaries

public void setPermissionsBoundaries(java.lang.String value)

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

getPolicies

public java.lang.Object getPolicies()

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

setPolicies

public void setPolicies(java.lang.String value)

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

setPolicies

public void setPolicies(IResolvable value)

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

setPolicies

public void setPolicies(CfnStateMachine.IAMPolicyDocumentProperty value)

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

setPolicies

public void setPolicies(java.util.List<java.lang.Object> value)

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

getRole

public java.lang.String getRole()

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

setRole

public void setRole(java.lang.String value)

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

getTracing

public java.lang.Object getTracing()

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

setTracing

public void setTracing(IResolvable value)

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

setTracing

public void setTracing(CfnStateMachine.TracingConfigurationProperty value)

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

getType

public java.lang.String getType()

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

setType

public void setType(java.lang.String value)

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