@Generated(value="software.amazon.awssdk:codegen") public final class CreateStateMachineRequest extends SfnRequest implements ToCopyableBuilder<CreateStateMachineRequest.Builder,CreateStateMachineRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateStateMachineRequest.Builder |
| 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()
For responses, this returns true if the service returned a value for the Tags property.
|
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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final 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 _.
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 _.
public final String definition()
The Amazon States Language definition of the state machine. See Amazon States Language.
public final String roleArn()
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
public final 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().
STANDARD.
You cannot update the type of a state machine once it has been created.StateMachineTypepublic final 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().
STANDARD.
You cannot update the type of a state machine once it has been created.StateMachineTypepublic final 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.
By default, the level is set to OFF. For more information see Log Levels in
the AWS Step Functions User Guide.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
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:
_ . : / = + - @.
public final TracingConfiguration tracingConfiguration()
Selects whether AWS X-Ray tracing is enabled.
public CreateStateMachineRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateStateMachineRequest.Builder,CreateStateMachineRequest>toBuilder in class SfnRequestpublic static CreateStateMachineRequest.Builder builder()
public static Class<? extends CreateStateMachineRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.