software.amazon.awssdk.services.sfn.model

Class CreateStateMachineRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sfn.model.SfnRequest

software.amazon.awssdk.services.sfn.model.CreateStateMachineRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateStateMachineRequest.Builder,CreateStateMachineRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateStateMachineRequest
extends SfnRequest
implements ToCopyableBuilder<CreateStateMachineRequest.Builder,CreateStateMachineRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateStateMachineRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateStateMachineRequest.Builder	builder()
String	definition() The Amazon States Language definition of the state machine.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
LoggingConfiguration	loggingConfiguration() Defines what execution history events are logged and where they are logged.
String	name() The name of the state machine.
String	roleArn() The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateStateMachineRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() Tags to be added when creating a state machine.
CreateStateMachineRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
TracingConfiguration	tracingConfiguration() Selects whether AWS X-Ray tracing is enabled.
StateMachineType	type() Determines whether a Standard or Express state machine is created.
String	typeAsString() Determines whether a Standard or Express state machine is created.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public 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 _.

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 _.

definition

public String definition()

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.

roleArn

public String roleArn()

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.

type

public 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.

If the service returns an enum value that is not available in the current SDK version, type will return StateMachineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

typeAsString

public String typeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, type will return StateMachineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

loggingConfiguration

public 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 AWS 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 AWS Step Functions User Guide.

hasTags

public boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public List<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 AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

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 AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

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

tracingConfiguration

public TracingConfiguration tracingConfiguration()

Selects whether AWS X-Ray tracing is enabled.

Returns:

Selects whether AWS X-Ray tracing is enabled.

toBuilder

public CreateStateMachineRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateStateMachineRequest.Builder,CreateStateMachineRequest>

Specified by:

toBuilder in class SfnRequest

builder

public static CreateStateMachineRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateStateMachineRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo