Package software.amazon.awscdk.cfnpropertymixins.services.stepfunctions

Class CfnStateMachinePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.stepfunctions.CfnStateMachinePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:05.798Z")
@Stability(Stable)
public class CfnStateMachinePropsMixin
extends Mixin
implements software.constructs.IMixin

Provisions a state machine.

A state machine consists of a collection of states that can do work ( Task states), determine to which states to transition next ( Choice states), stop an execution with an error ( Fail states), and so on. State machines are specified using a JSON-based, structured language.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.stepfunctions.*;
 import software.amazon.awscdk.*;
 Object definition;
 IMergeStrategy mergeStrategy;
 CfnStateMachinePropsMixin cfnStateMachinePropsMixin = CfnStateMachinePropsMixin.Builder.create(CfnStateMachineMixinProps.builder()
         .definition(definition)
         .definitionS3Location(S3LocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .version("version")
                 .build())
         .definitionString("definitionString")
         .definitionSubstitutions(Map.of(
                 "definitionSubstitutionsKey", "definitionSubstitutions"))
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsDataKeyReusePeriodSeconds(123)
                 .kmsKeyId("kmsKeyId")
                 .type("type")
                 .build())
         .loggingConfiguration(LoggingConfigurationProperty.builder()
                 .destinations(List.of(LogDestinationProperty.builder()
                         .cloudWatchLogsLogGroup(CloudWatchLogsLogGroupProperty.builder()
                                 .logGroupArn("logGroupArn")
                                 .build())
                         .build()))
                 .includeExecutionData(false)
                 .level("level")
                 .build())
         .roleArn("roleArn")
         .stateMachineName("stateMachineName")
         .stateMachineType("stateMachineType")
         .tags(List.of(TagsEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tracingConfiguration(TracingConfigurationProperty.builder()
                 .enabled(false)
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnStateMachinePropsMixin.Builder	A fluent builder for CfnStateMachinePropsMixin.
static interface	CfnStateMachinePropsMixin.CloudWatchLogsLogGroupProperty	Defines a CloudWatch log group.
static interface	CfnStateMachinePropsMixin.EncryptionConfigurationProperty	Settings to configure server-side encryption for a state machine.
static interface	CfnStateMachinePropsMixin.LogDestinationProperty	Defines a destination for LoggingConfiguration .
static interface	CfnStateMachinePropsMixin.LoggingConfigurationProperty	Defines what execution history events are logged and where they are logged.
static interface	CfnStateMachinePropsMixin.S3LocationProperty	Defines the S3 bucket location where a state machine definition is stored.
static interface	CfnStateMachinePropsMixin.TagsEntryProperty	The TagsEntry property specifies tags to identify a state machine.
static interface	CfnStateMachinePropsMixin.TracingConfigurationProperty	Selects whether or not the state machine's AWS X-Ray tracing is enabled.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnStateMachinePropsMixin(CfnStateMachineMixinProps props)	Create a mixin to apply properties to AWS::StepFunctions::StateMachine.
	CfnStateMachinePropsMixin(CfnStateMachineMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::StepFunctions::StateMachine.
protected	CfnStateMachinePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStateMachinePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnStateMachineMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnStateMachinePropsMixin

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

CfnStateMachinePropsMixin

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

CfnStateMachinePropsMixin

@Stability(Stable)
public CfnStateMachinePropsMixin(@NotNull
 CfnStateMachineMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::StepFunctions::StateMachine.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnStateMachinePropsMixin

@Stability(Stable)
public CfnStateMachinePropsMixin(@NotNull
 CfnStateMachineMixinProps props)

Create a mixin to apply properties to AWS::StepFunctions::StateMachine.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnStateMachineMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()