Package software.amazon.awscdk.services.stepfunctions

Interface CfnStateMachineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStateMachineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.353Z")
@Stability(Stable)
public interface CfnStateMachineProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStateMachine.

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.stepfunctions.*;
 Object definition;
 CfnStateMachineProps cfnStateMachineProps = CfnStateMachineProps.builder()
         .roleArn("roleArn")
         // the properties below are optional
         .definition(definition)
         .definitionS3Location(S3LocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 // the properties below are optional
                 .version("version")
                 .build())
         .definitionString("definitionString")
         .definitionSubstitutions(Map.of(
                 "definitionSubstitutionsKey", "definitionSubstitutions"))
         .loggingConfiguration(LoggingConfigurationProperty.builder()
                 .destinations(List.of(LogDestinationProperty.builder()
                         .cloudWatchLogsLogGroup(CloudWatchLogsLogGroupProperty.builder()
                                 .logGroupArn("logGroupArn")
                                 .build())
                         .build()))
                 .includeExecutionData(false)
                 .level("level")
                 .build())
         .stateMachineName("stateMachineName")
         .stateMachineType("stateMachineType")
         .tags(List.of(TagsEntryProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tracingConfiguration(TracingConfigurationProperty.builder()
                 .enabled(false)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStateMachineProps.Builder	A builder for CfnStateMachineProps
static final class	CfnStateMachineProps.Jsii$Proxy	An implementation for CfnStateMachineProps

Method Summary

Modifier and Type	Method	Description
static CfnStateMachineProps.Builder	builder()
default Object	getDefinition()	The Amazon States Language definition of the state machine.
default Object	getDefinitionS3Location()	The name of the S3 bucket where the state machine definition is stored.
default String	getDefinitionString()	The Amazon States Language definition of the state machine.
default Object	getDefinitionSubstitutions()	A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.
default Object	getLoggingConfiguration()	Defines what execution history events are logged and where they are logged.
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
default String	getStateMachineName()	The name of the state machine.
default String	getStateMachineType()	Determines whether a STANDARD or EXPRESS state machine is created.
default List<CfnStateMachine.TagsEntryProperty>	getTags()	The list of tags to add to a resource.
default Object	getTracingConfiguration()	Selects whether or not the state machine's AWS X-Ray tracing is enabled.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

See Also:

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

getDefinition

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

The Amazon States Language definition of the state machine.

The state machine definition must be in JSON or YAML, and the format of the object must match the format of your CloudFormation template file. See Amazon States Language .

See Also:

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

getDefinitionS3Location

@Stability(Stable)
@Nullable
default Object getDefinitionS3Location()

The name of the S3 bucket where the state machine definition is stored.

The state machine definition must be a JSON or YAML file.

See Also:

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

getDefinitionString

@Stability(Stable)
@Nullable
default String getDefinitionString()

The Amazon States Language definition of the state machine.

The state machine definition must be in JSON. See Amazon States Language .

See Also:

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

getDefinitionSubstitutions

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

A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.

This enables the customer to inject values obtained at runtime, for example from intrinsic functions, in the state machine definition. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key-value map.

Substitutions must follow the syntax: ${key_name} or ${variable_1,variable_2,...} .

See Also:

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

getLoggingConfiguration

@Stability(Stable)
@Nullable
default Object getLoggingConfiguration()

Defines what execution history events are logged and where they are logged.

By default, the level is set to OFF . For more information see Log Levels in the AWS Step Functions User Guide.

See Also:

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

getStateMachineName

@Stability(Stable)
@Nullable
default String getStateMachineName()

The name of the state machine.

A name must not contain:

• white space
• brackets < > { } [ ]
• wildcard characters ? *
• special characters " # % \ ^ | ~ $ & , ; : /`
• control characters ( U+0000-001F , U+007F-009F )

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

See Also:

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

getStateMachineType

@Stability(Stable)
@Nullable
default String getStateMachineType()

Determines whether a STANDARD or EXPRESS state machine is created.

The default is STANDARD . You cannot update the type of a state machine once it has been created. For more information on STANDARD and EXPRESS workflows, see Standard Versus Express Workflows in the AWS Step Functions Developer Guide.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnStateMachine.TagsEntryProperty> getTags()

The list of tags to add to a resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: `_ . : / = + -

See Also:

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

getTracingConfiguration

@Stability(Stable)
@Nullable
default Object getTracingConfiguration()

Selects whether or not the state machine's AWS X-Ray tracing is enabled.

See Also:

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

builder

@Stability(Stable)
static CfnStateMachineProps.Builder builder()

Returns:

a CfnStateMachineProps.Builder of CfnStateMachineProps