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,IEnvironmentAware,IStateMachineRef,ITaggable,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
date="2025-12-18T18:20:17.693Z")
@Stability(Stable)
public class CfnStateMachine
extends CfnResource
implements IInspectable, IStateMachineRef, ITaggable
https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html.
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(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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceExample:static final classA fluent builder forCfnStateMachine.static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:static interfaceExample:Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.sam.IStateMachineRef
IStateMachineRef.Jsii$Default, IStateMachineRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnStateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnStateMachine(software.amazon.jsii.JsiiObjectRef objRef) CfnStateMachine(software.constructs.Construct scope, String id) Create a newAWS::Serverless::StateMachine.CfnStateMachine(software.constructs.Construct scope, String id, CfnStateMachineProps props) Create a newAWS::Serverless::StateMachine. -
Method Summary
Modifier and TypeMethodDescriptionReturns union: eitherIResolvableor Mapinvalid input: '<'String, eitherIResolvableorCfnStateMachine.EventSourceProperty>Returns union: eitherIResolvableorCfnStateMachine.LoggingConfigurationPropertygetName()Returns union: eitherStringorIResolvableorCfnStateMachine.IAMPolicyDocumentPropertyor Listinvalid input: '<'eitherStringorIResolvableorCfnStateMachine.IAMPolicyDocumentPropertyorCfnStateMachine.SAMPolicyTemplateProperty>getRole()A reference to a StateMachine resource.getTags()Tag Manager which manages the tags for this resource.Returns union: eitherIResolvableorCfnStateMachine.TracingConfigurationPropertygetType()voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.static BooleanChecks whether the given object is a CfnStateMachine.renderProperties(Map<String, Object> props) voidsetDefinition(Object value) voidsetDefinitionSubstitutions(Map<String, String> value) voidvoidsetDefinitionUri(String value) voidsetDefinitionUri(IResolvable value) voidvoidvoidsetEvents(IResolvable value) voidsetLogging(IResolvable value) voidvoidvoidsetPermissionsBoundaries(String value) voidsetPolicies(String value) voidsetPolicies(List<Object> value) voidsetPolicies(IResolvable value) voidvoidvoidsetTagsRaw(Map<String, String> value) voidsetTracing(IResolvable value) voidvoidMethods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class. -
REQUIRED_TRANSFORM
TheTransforma 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.constructs.Construct scope, @NotNull String id, @Nullable CfnStateMachineProps props) Create a newAWS::Serverless::StateMachine.- Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties.
-
CfnStateMachine
@Stability(Stable) public CfnStateMachine(@NotNull software.constructs.Construct scope, @NotNull String id) Create a newAWS::Serverless::StateMachine.- Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.
-
-
Method Details
-
isCfnStateMachine
Checks whether the given object is a CfnStateMachine.- Parameters:
x- This parameter is required.
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- 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:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getStateMachineRef
A reference to a StateMachine resource.- Specified by:
getStateMachineRefin interfaceIStateMachineRef
-
getTags
Tag Manager which manages the tags for this resource. -
getDefinition
-
setDefinition
-
getDefinitionSubstitutions
-
setDefinitionSubstitutions
-
setDefinitionSubstitutions
-
getDefinitionUri
-
setDefinitionUri
-
setDefinitionUri
-
setDefinitionUri
-
getEvents
Returns union: eitherIResolvableor Mapinvalid input: '<'String, eitherIResolvableorCfnStateMachine.EventSourceProperty> -
setEvents
-
setEvents
-
getLogging
Returns union: eitherIResolvableorCfnStateMachine.LoggingConfigurationProperty -
setLogging
-
setLogging
@Stability(Stable) public void setLogging(@Nullable CfnStateMachine.LoggingConfigurationProperty value) -
getName
-
setName
-
getPermissionsBoundaries
-
setPermissionsBoundaries
-
getPolicies
Returns union: eitherStringorIResolvableorCfnStateMachine.IAMPolicyDocumentPropertyor Listinvalid input: '<'eitherStringorIResolvableorCfnStateMachine.IAMPolicyDocumentPropertyorCfnStateMachine.SAMPolicyTemplateProperty> -
setPolicies
-
setPolicies
-
setPolicies
@Stability(Stable) public void setPolicies(@Nullable CfnStateMachine.IAMPolicyDocumentProperty value) -
setPolicies
-
getRole
-
setRole
-
getTagsRaw
-
setTagsRaw
-
getTracing
Returns union: eitherIResolvableorCfnStateMachine.TracingConfigurationProperty -
setTracing
-
setTracing
@Stability(Stable) public void setTracing(@Nullable CfnStateMachine.TracingConfigurationProperty value) -
getType
-
setType
-