software.amazon.awscdk.services.stepfunctions

Class CfnStateMachine

java.lang.Object

software.amazon.jsii.JsiiObject

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.stepfunctions.CfnStateMachine

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-02-19T00:19:34.271Z")
 @Stability(value=Stable)
public class CfnStateMachine
extends CfnResource
implements IInspectable

A CloudFormation `AWS::StepFunctions::StateMachine`.

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.services.stepfunctions.*;
 Object definition;
 CfnStateMachine cfnStateMachine = CfnStateMachine.Builder.create(this, "MyCfnStateMachine")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStateMachine.Builder A fluent builder for CfnStateMachine.
static interface	CfnStateMachine.CloudWatchLogsLogGroupProperty Defines a CloudWatch log group.
static interface	CfnStateMachine.LogDestinationProperty Defines a destination for `LoggingConfiguration` .
static interface	CfnStateMachine.LoggingConfigurationProperty Defines what execution history events are logged and where they are logged.
static interface	CfnStateMachine.S3LocationProperty Defines the S3 bucket location where a state machine definition is stored.
static interface	CfnStateMachine.TagsEntryProperty The `TagsEntry` property specifies *tags* to identify a state machine.
static interface	CfnStateMachine.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.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 String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStateMachine(Construct scope, String id, CfnStateMachineProps props) Create a new `AWS::StepFunctions::StateMachine`.
protected	CfnStateMachine(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStateMachine(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrName() Returns the name of the state machine.
protected Map<String,Object>	getCfnProperties()
Object	getDefinition() The Amazon States Language definition of the state machine.
Object	getDefinitionS3Location() The name of the S3 bucket where the state machine definition is stored.
String	getDefinitionString() The Amazon States Language definition of the state machine.
Object	getDefinitionSubstitutions() A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.
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.
String	getStateMachineName() The name of the state machine.
String	getStateMachineType() Determines whether a `STANDARD` or `EXPRESS` state machine is created.
TagManager	getTags() The list of tags to add to a resource.
Object	getTracingConfiguration() Selects whether or not the state machine's AWS X-Ray tracing is enabled.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDefinition(Object value) The Amazon States Language definition of the state machine.
void	setDefinitionS3Location(CfnStateMachine.S3LocationProperty value) The name of the S3 bucket where the state machine definition is stored.
void	setDefinitionS3Location(IResolvable value) The name of the S3 bucket where the state machine definition is stored.
void	setDefinitionString(String value) The Amazon States Language definition of the state machine.
void	setDefinitionSubstitutions(IResolvable value) A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.
void	setDefinitionSubstitutions(Map<String,String> value) A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.
void	setLoggingConfiguration(CfnStateMachine.LoggingConfigurationProperty value) Defines what execution history events are logged and where they are logged.
void	setLoggingConfiguration(IResolvable value) Defines what execution history events are logged and where they are logged.
void	setRoleArn(String value) The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
void	setStateMachineName(String value) The name of the state machine.
void	setStateMachineType(String value) Determines whether a `STANDARD` or `EXPRESS` state machine is created.
void	setTracingConfiguration(CfnStateMachine.TracingConfigurationProperty value) Selects whether or not the state machine's AWS X-Ray tracing is enabled.
void	setTracingConfiguration(IResolvable value) Selects whether or not the state machine's AWS X-Ray tracing is enabled.

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStateMachine

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

CfnStateMachine

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

CfnStateMachine

@Stability(value=Stable)
public CfnStateMachine(@NotNull
                                                Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnStateMachineProps props)

Create a new `AWS::StepFunctions::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. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

Returns the name of the state machine. For example:.

{ "Fn::GetAtt": ["MyStateMachine", "Name"] }

Returns the name of your state machine:

HelloWorld-StateMachine

If you did not specify the name it will be similar to the following:

MyStateMachine-1234abcdefgh

For more information about using Fn::GetAtt , see Fn::GetAtt .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The list of tags to add to a resource.

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

getDefinition

@Stability(value=Stable)
 @NotNull
public 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 AWS Step Functions template file. See Amazon States Language .

setDefinition

@Stability(value=Stable)
public void setDefinition(@NotNull
                                                   Object value)

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 AWS Step Functions template file. See Amazon States Language .

getRoleArn

@Stability(value=Stable)
 @NotNull
public String getRoleArn()

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

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@NotNull
                                                String value)

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

getDefinitionS3Location

@Stability(value=Stable)
 @Nullable
public 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.

setDefinitionS3Location

@Stability(value=Stable)
public void setDefinitionS3Location(@Nullable
                                                             IResolvable value)

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

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

setDefinitionS3Location

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

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

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

getDefinitionString

@Stability(value=Stable)
 @Nullable
public String getDefinitionString()

The Amazon States Language definition of the state machine.

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

setDefinitionString

@Stability(value=Stable)
public void setDefinitionString(@Nullable
                                                         String value)

The Amazon States Language definition of the state machine.

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

getDefinitionSubstitutions

@Stability(value=Stable)
 @Nullable
public 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.

setDefinitionSubstitutions

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

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.

setDefinitionSubstitutions

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

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.

getLoggingConfiguration

@Stability(value=Stable)
 @Nullable
public 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.

setLoggingConfiguration

@Stability(value=Stable)
public void setLoggingConfiguration(@Nullable
                                                             IResolvable value)

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.

setLoggingConfiguration

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

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.

getStateMachineName

@Stability(value=Stable)
 @Nullable
public 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.

setStateMachineName

@Stability(value=Stable)
public void setStateMachineName(@Nullable
                                                         String value)

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.

getStateMachineType

@Stability(value=Stable)
 @Nullable
public 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.

setStateMachineType

@Stability(value=Stable)
public void setStateMachineType(@Nullable
                                                         String value)

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.

getTracingConfiguration

@Stability(value=Stable)
 @Nullable
public Object getTracingConfiguration()

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

setTracingConfiguration

@Stability(value=Stable)
public void setTracingConfiguration(@Nullable
                                                             IResolvable value)

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

setTracingConfiguration

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

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