CfnStateMachine

java.lang.Object
- 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:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:55.764Z")
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 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 java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnStateMachine(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()`
`java.lang.String`	`getAttrName()` Returns the name of the state machine.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getDefinition()` The Amazon States Language definition of the state machine.
`java.lang.Object`	`getDefinitionS3Location()` The name of the S3 bucket where the state machine definition is stored.
`java.lang.String`	`getDefinitionString()` The Amazon States Language definition of the state machine.
`java.lang.Object`	`getDefinitionSubstitutions()` A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.
`java.lang.Object`	`getLoggingConfiguration()` Defines what execution history events are logged and where they are logged.
`java.lang.String`	`getRoleArn()` The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
`java.lang.String`	`getStateMachineName()` The name of the state machine.
`java.lang.String`	`getStateMachineType()` Determines whether a `STANDARD` or `EXPRESS` state machine is created.
`TagManager`	`getTags()` The list of tags to add to a resource.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setDefinition(java.lang.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(java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.lang.String value)` The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
`void`	`setStateMachineName(java.lang.String value)` The name of the state machine.
`void`	`setStateMachineType(java.lang.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnStateMachine(Construct scope,
                       java.lang.String id,
                       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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
  - getAttrName
```
public java.lang.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
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
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
```
public java.lang.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
```
public void setDefinition(java.lang.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
```
public java.lang.String getRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
  - setRoleArn
```
public void setRoleArn(java.lang.String value)
```
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
  - getDefinitionS3Location
```
public java.lang.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
```
public void setDefinitionS3Location(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
```
public void setDefinitionS3Location(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
```
public java.lang.String getDefinitionString()
```
    The Amazon States Language definition of the state machine.
    The state machine definition must be in JSON. See Amazon States Language .
  - setDefinitionString
```
public void setDefinitionString(java.lang.String value)
```
    The Amazon States Language definition of the state machine.
    The state machine definition must be in JSON. See Amazon States Language .
  - getDefinitionSubstitutions
```
public java.lang.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
```
public void setDefinitionSubstitutions(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
```
public void setDefinitionSubstitutions(java.util.Map<java.lang.String,java.lang.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
```
public java.lang.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
```
public void setLoggingConfiguration(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
```
public void setLoggingConfiguration(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
```
public java.lang.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
```
public void setStateMachineName(java.lang.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
```
public java.lang.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
```
public void setStateMachineType(java.lang.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
```
public java.lang.Object getTracingConfiguration()
```
    Selects whether or not the state machine's AWS X-Ray tracing is enabled.
  - setTracingConfiguration
```
public void setTracingConfiguration(IResolvable value)
```
    Selects whether or not the state machine's AWS X-Ray tracing is enabled.
  - setTracingConfiguration
```
public void setTracingConfiguration(CfnStateMachine.TracingConfigurationProperty value)
```
    Selects whether or not the state machine's AWS X-Ray tracing is enabled.

Class CfnStateMachine

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnStateMachine

CfnStateMachine

CfnStateMachine

Method Detail

inspect

renderProperties

getAttrArn

getAttrName

getCfnProperties

getTags

getDefinition

setDefinition

getRoleArn

setRoleArn

getDefinitionS3Location

setDefinitionS3Location

setDefinitionS3Location

getDefinitionString

setDefinitionString

getDefinitionSubstitutions

setDefinitionSubstitutions

setDefinitionSubstitutions

getLoggingConfiguration

setLoggingConfiguration

setLoggingConfiguration

getStateMachineName

setStateMachineName

getStateMachineType

setStateMachineType

getTracingConfiguration

setTracingConfiguration

setTracingConfiguration