Class CreateStateMachineRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateStateMachineRequest.Builder,
CreateStateMachineRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The Amazon States Language definition of the state machine.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final LoggingConfiguration
Defines what execution history events are logged and where they are logged.final String
name()
The name of the state machine.final Boolean
publish()
Set totrue
to publish the first version of the state machine during creation.final String
roleArn()
The Amazon Resource Name (ARN) of the IAM role to use for this state machine.static Class
<? extends CreateStateMachineRequest.Builder> tags()
Tags to be added when creating a state machine.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TracingConfiguration
Selects whether X-Ray tracing is enabled.final StateMachineType
type()
Determines whether a Standard or Express state machine is created.final String
Determines whether a Standard or Express state machine is created.final String
Sets description about the state machine version.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
Determines whether a Standard or Express state machine is created. The default is
STANDARD
. You cannot update thetype
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 returnStateMachineType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Determines whether a Standard or Express state machine is created. The default is
STANDARD
. You cannot update thetype
of a state machine once it has been created. - See Also:
-
typeAsString
Determines whether a Standard or Express state machine is created. The default is
STANDARD
. You cannot update thetype
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 returnStateMachineType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- Determines whether a Standard or Express state machine is created. The default is
STANDARD
. You cannot update thetype
of a state machine once it has been created. - See Also:
-
loggingConfiguration
Defines what execution history events are logged and where they are logged.
By default, the
level
is set toOFF
. 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 toOFF
. For more information see Log Levels in the Step Functions User Guide.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
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:
_ . : / = + - @
.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.- 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:
_ . : / = + - @
.
-
tracingConfiguration
Selects whether X-Ray tracing is enabled.
- Returns:
- Selects whether X-Ray tracing is enabled.
-
publish
Set to
true
to publish the first version of the state machine during creation. The default isfalse
.- Returns:
- Set to
true
to publish the first version of the state machine during creation. The default isfalse
.
-
versionDescription
Sets description about the state machine version. You can only set the description if the
publish
parameter is set totrue
. Otherwise, if you setversionDescription
, butpublish
tofalse
, this API action throwsValidationException
.- Returns:
- Sets description about the state machine version. You can only set the description if the
publish
parameter is set totrue
. Otherwise, if you setversionDescription
, butpublish
tofalse
, this API action throwsValidationException
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateStateMachineRequest.Builder,
CreateStateMachineRequest> - Specified by:
toBuilder
in classSfnRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-