Package 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, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:51.175Z") @Stability(Stable) public class CfnStateMachine extends CfnResource implements IInspectable, 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:

  • 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.constructs.Construct scope, @NotNull String id, @Nullable CfnStateMachineProps props)
      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)
      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

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getDefinition

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

    • setDefinition

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

    • getDefinitionSubstitutions

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

    • setDefinitionSubstitutions

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

    • setDefinitionSubstitutions

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

    • getDefinitionUri

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

    • setDefinitionUri

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

    • setDefinitionUri

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

    • setDefinitionUri

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

    • getEvents

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

    • setEvents

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

    • setEvents

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

    • getLogging

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

    • setLogging

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

    • setLogging

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

    • getName

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

    • setName

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

    • getPermissionsBoundaries

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

    • setPermissionsBoundaries

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

    • getPolicies

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

    • setPolicies

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

    • setPolicies

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

    • setPolicies

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

    • setPolicies

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

    • getRole

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

    • setRole

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

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()

    • setTagsRaw

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

    • getTracing

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

    • setTracing

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

    • setTracing

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

    • getType

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

    • setType

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