CreateStateMachineRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.stepfunctions.model

Class CreateStateMachineRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.stepfunctions.model.CreateStateMachineRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateStateMachineRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateStateMachineRequest ()

Constructors
Constructor and Description
`CreateStateMachineRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateStateMachineRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getDefinition ()` The Amazon States Language definition of the state machine.
`EncryptionConfiguration`	`getEncryptionConfiguration ()` Settings to configure server-side encryption.
`LoggingConfiguration`	`getLoggingConfiguration ()` Defines what execution history events are logged and where they are logged.
`String`	`getName ()` The name of the state machine.
`Boolean`	`getPublish ()` Set to `true` to publish the first version of the state machine during creation.
`String`	`getRoleArn ()` The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
`List<Tag>`	`getTags ()` Tags to be added when creating a state machine.
`TracingConfiguration`	`getTracingConfiguration ()` Selects whether X-Ray tracing is enabled.
`String`	`getType ()` Determines whether a Standard or Express state machine is created.
`String`	`getVersionDescription ()` Sets description about the state machine version.
`int`	`hashCode ()`
`Boolean`	`isPublish ()` Set to `true` to publish the first version of the state machine during creation.
`void`	`setDefinition (StateMachine definition)` The Amazon States Language definition of the state machine.
`void`	`setDefinition (String definition)` The Amazon States Language definition of the state machine.
`void`	`setEncryptionConfiguration (EncryptionConfiguration encryptionConfiguration)` Settings to configure server-side encryption.
`void`	`setLoggingConfiguration (LoggingConfiguration loggingConfiguration)` Defines what execution history events are logged and where they are logged.
`void`	`setName (String name)` The name of the state machine.
`void`	`setPublish (Boolean publish)` Set to `true` to publish the first version of the state machine during creation.
`void`	`setRoleArn (String roleArn)` The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
`void`	`setTags (Collection<Tag> tags)` Tags to be added when creating a state machine.
`void`	`setTracingConfiguration (TracingConfiguration tracingConfiguration)` Selects whether X-Ray tracing is enabled.
`void`	`setType (String type)` Determines whether a Standard or Express state machine is created.
`void`	`setVersionDescription (String versionDescription)` Sets description about the state machine version.
`String`	`toString ()` Returns a string representation of this object.
`CreateStateMachineRequest`	`withDefinition (StateMachine definition)` The Amazon States Language definition of the state machine.
`CreateStateMachineRequest`	`withDefinition (String definition)` The Amazon States Language definition of the state machine.
`CreateStateMachineRequest`	`withEncryptionConfiguration (EncryptionConfiguration encryptionConfiguration)` Settings to configure server-side encryption.
`CreateStateMachineRequest`	`withLoggingConfiguration (LoggingConfiguration loggingConfiguration)` Defines what execution history events are logged and where they are logged.
`CreateStateMachineRequest`	`withName (String name)` The name of the state machine.
`CreateStateMachineRequest`	`withPublish (Boolean publish)` Set to `true` to publish the first version of the state machine during creation.
`CreateStateMachineRequest`	`withRoleArn (String roleArn)` The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
`CreateStateMachineRequest`	`withTags (Collection<Tag> tags)` Tags to be added when creating a state machine.
`CreateStateMachineRequest`	`withTags (Tag... tags)` Tags to be added when creating a state machine.
`CreateStateMachineRequest`	`withTracingConfiguration (TracingConfiguration tracingConfiguration)` Selects whether X-Ray tracing is enabled.
`CreateStateMachineRequest`	`withType (StateMachineType type)` Determines whether a Standard or Express state machine is created.
`CreateStateMachineRequest`	`withType (String type)` Determines whether a Standard or Express state machine is created.
`CreateStateMachineRequest`	`withVersionDescription (String versionDescription)` Sets description about the state machine version.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateStateMachineRequest
```
public CreateStateMachineRequest()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    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)
    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
    Parameters:
    name - 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)
    
    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
  - getName
```
public String getName()
```
    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)
    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
    Returns:
    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)
    
    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
  - withName
```
public CreateStateMachineRequest withName(String name)
```
    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)
    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
    Parameters:
    name - 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)
    
    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefinition
```
public void setDefinition(String definition)
```
    The Amazon States Language definition of the state machine. See Amazon States Language.
    
    Parameters:
    
    definition - The Amazon States Language definition of the state machine. See Amazon States Language.
  - getDefinition
```
public String getDefinition()
```
    The Amazon States Language definition of the state machine. See Amazon States Language.
    
    Returns:
    
    The Amazon States Language definition of the state machine. See Amazon States Language.
  - withDefinition
```
public CreateStateMachineRequest withDefinition(String definition)
```
    The Amazon States Language definition of the state machine. See Amazon States Language.
    
    Parameters:
    
    definition - The Amazon States Language definition of the state machine. See Amazon States Language.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefinition
```
public void setDefinition(StateMachine definition)
```
    The Amazon States Language definition of the state machine. See Amazon States Language.
    
    Parameters:
    
    definition - The Amazon States Language definition of the state machine. See Amazon States Language.
  - withDefinition
```
public CreateStateMachineRequest withDefinition(StateMachine definition)
```
    The Amazon States Language definition of the state machine. See Amazon States Language.
    
    Parameters:
    
    definition - The Amazon States Language definition of the state machine. See Amazon States Language.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
  - withRoleArn
```
public CreateStateMachineRequest withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    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.
    
    Parameters:
    
    type - 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.
    
    See Also:
    
    StateMachineType
  - getType
```
public String getType()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    StateMachineType
  - withType
```
public CreateStateMachineRequest withType(String type)
```
    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.
    
    Parameters:
    
    type - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StateMachineType
  - withType
```
public CreateStateMachineRequest withType(StateMachineType type)
```
    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.
    
    Parameters:
    
    type - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StateMachineType
  - setLoggingConfiguration
```
public void setLoggingConfiguration(LoggingConfiguration loggingConfiguration)
```
    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 Step Functions User Guide.
    
    Parameters:
    
    loggingConfiguration - 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 Step Functions User Guide.
  - getLoggingConfiguration
```
public LoggingConfiguration 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 Step Functions User Guide.
    
    Returns:
    
    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 Step Functions User Guide.
  - withLoggingConfiguration
```
public CreateStateMachineRequest withLoggingConfiguration(LoggingConfiguration loggingConfiguration)
```
    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 Step Functions User Guide.
    
    Parameters:
    
    loggingConfiguration - 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 Step Functions User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Tags to be added when creating a state machine.
    
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
    
    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
    
    Returns:
    
    Tags to be added when creating a state machine.
    
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
    
    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Tags to be added when creating a state machine.
    
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
    
    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
    
    Parameters:
    
    tags - Tags to be added when creating a state machine.
    
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
    
    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
  - withTags
```
public CreateStateMachineRequest withTags(Tag... tags)
```
    Tags to be added when creating a state machine.
    
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
    
    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Tags to be added when creating a state machine.
    
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
    
    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateStateMachineRequest withTags(Collection<Tag> tags)
```
    Tags to be added when creating a state machine.
    
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
    
    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
    
    Parameters:
    
    tags - Tags to be added when creating a state machine.
    
    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.
    
    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTracingConfiguration
```
public void setTracingConfiguration(TracingConfiguration tracingConfiguration)
```
    Selects whether X-Ray tracing is enabled.
    
    Parameters:
    
    tracingConfiguration - Selects whether X-Ray tracing is enabled.
  - getTracingConfiguration
```
public TracingConfiguration getTracingConfiguration()
```
    Selects whether X-Ray tracing is enabled.
    
    Returns:
    
    Selects whether X-Ray tracing is enabled.
  - withTracingConfiguration
```
public CreateStateMachineRequest withTracingConfiguration(TracingConfiguration tracingConfiguration)
```
    Selects whether X-Ray tracing is enabled.
    
    Parameters:
    
    tracingConfiguration - Selects whether X-Ray tracing is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublish
```
public void setPublish(Boolean publish)
```
    Set to true to publish the first version of the state machine during creation. The default is false.
    
    Parameters:
    
    publish - Set to true to publish the first version of the state machine during creation. The default is false.
  - getPublish
```
public Boolean getPublish()
```
    Set to true to publish the first version of the state machine during creation. The default is false.
    
    Returns:
    
    Set to true to publish the first version of the state machine during creation. The default is false.
  - withPublish
```
public CreateStateMachineRequest withPublish(Boolean publish)
```
    Set to true to publish the first version of the state machine during creation. The default is false.
    
    Parameters:
    
    publish - Set to true to publish the first version of the state machine during creation. The default is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isPublish
```
public Boolean isPublish()
```
    Set to true to publish the first version of the state machine during creation. The default is false.
    
    Returns:
    
    Set to true to publish the first version of the state machine during creation. The default is false.
  - setVersionDescription
```
public void setVersionDescription(String versionDescription)
```
    Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.
    
    Parameters:
    
    versionDescription - Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.
  - getVersionDescription
```
public String getVersionDescription()
```
    Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.
    
    Returns:
    
    Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.
  - withVersionDescription
```
public CreateStateMachineRequest withVersionDescription(String versionDescription)
```
    Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.
    
    Parameters:
    
    versionDescription - Sets description about the state machine version. You can only set the description if the publish parameter is set to true. Otherwise, if you set versionDescription, but publish to false, this API action throws ValidationException.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEncryptionConfiguration
```
public void setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
```
    Settings to configure server-side encryption.
    
    Parameters:
    
    encryptionConfiguration - Settings to configure server-side encryption.
  - getEncryptionConfiguration
```
public EncryptionConfiguration getEncryptionConfiguration()
```
    Settings to configure server-side encryption.
    
    Returns:
    
    Settings to configure server-side encryption.
  - withEncryptionConfiguration
```
public CreateStateMachineRequest withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
```
    Settings to configure server-side encryption.
    
    Parameters:
    
    encryptionConfiguration - Settings to configure server-side encryption.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateStateMachineRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class CreateStateMachineRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateStateMachineRequest

Method Detail

setName

getName

withName

setDefinition

getDefinition

withDefinition

setDefinition

withDefinition

setRoleArn

getRoleArn

withRoleArn

setType

getType

withType

withType

setLoggingConfiguration

getLoggingConfiguration

withLoggingConfiguration

getTags

setTags

withTags

withTags

setTracingConfiguration

getTracingConfiguration

withTracingConfiguration

setPublish

getPublish

withPublish

isPublish

setVersionDescription

getVersionDescription

withVersionDescription

setEncryptionConfiguration

getEncryptionConfiguration

withEncryptionConfiguration

toString

equals

hashCode

clone