Package software.amazon.awssdk.services.sfn.model

Interface CreateStateMachineRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateStateMachineRequest.Builder,CreateStateMachineRequest>, SdkBuilder<CreateStateMachineRequest.Builder,CreateStateMachineRequest>, SdkPojo, SdkRequest.Builder, SfnRequest.Builder

Enclosing class:

CreateStateMachineRequest

public static interface CreateStateMachineRequest.Builder
extends SfnRequest.Builder, SdkPojo, CopyableBuilder<CreateStateMachineRequest.Builder,CreateStateMachineRequest>

Method Summary

Modifier and Type	Method	Description
CreateStateMachineRequest.Builder	definition(String definition)	The Amazon States Language definition of the state machine.
default CreateStateMachineRequest.Builder	encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)	Settings to configure server-side encryption.
CreateStateMachineRequest.Builder	encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	Settings to configure server-side encryption.
default CreateStateMachineRequest.Builder	loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration)	Defines what execution history events are logged and where they are logged.
CreateStateMachineRequest.Builder	loggingConfiguration(LoggingConfiguration loggingConfiguration)	Defines what execution history events are logged and where they are logged.
CreateStateMachineRequest.Builder	name(String name)	The name of the state machine.
CreateStateMachineRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateStateMachineRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateStateMachineRequest.Builder	publish(Boolean publish)	Set to true to publish the first version of the state machine during creation.
CreateStateMachineRequest.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
CreateStateMachineRequest.Builder	tags(Collection<Tag> tags)	Tags to be added when creating a state machine.
CreateStateMachineRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Tags to be added when creating a state machine.
CreateStateMachineRequest.Builder	tags(Tag... tags)	Tags to be added when creating a state machine.
default CreateStateMachineRequest.Builder	tracingConfiguration(Consumer<TracingConfiguration.Builder> tracingConfiguration)	Selects whether X-Ray tracing is enabled.
CreateStateMachineRequest.Builder	tracingConfiguration(TracingConfiguration tracingConfiguration)	Selects whether X-Ray tracing is enabled.
CreateStateMachineRequest.Builder	type(String type)	Determines whether a Standard or Express state machine is created.
CreateStateMachineRequest.Builder	type(StateMachineType type)	Determines whether a Standard or Express state machine is created.
CreateStateMachineRequest.Builder	versionDescription(String versionDescription)	Sets description about the state machine version.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.services.sfn.model.SfnRequest.Builder

build

Method Details

name

CreateStateMachineRequest.Builder name(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.

definition

CreateStateMachineRequest.Builder definition(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.

roleArn

CreateStateMachineRequest.Builder roleArn(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.

type

CreateStateMachineRequest.Builder type(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
• StateMachineType

type

CreateStateMachineRequest.Builder type(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
• StateMachineType

loggingConfiguration

CreateStateMachineRequest.Builder loggingConfiguration(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.

loggingConfiguration

default CreateStateMachineRequest.Builder loggingConfiguration(Consumer<LoggingConfiguration.Builder> 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.

This is a convenience method that creates an instance of the LoggingConfiguration.Builder avoiding the need to create one manually via LoggingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to loggingConfiguration(LoggingConfiguration).

Parameters:

loggingConfiguration - a consumer that will call methods on LoggingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• loggingConfiguration(LoggingConfiguration)

tags

CreateStateMachineRequest.Builder tags(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.

tags

CreateStateMachineRequest.Builder tags(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.

tags

CreateStateMachineRequest.Builder tags(Consumer<Tag.Builder>... 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: _ . : / = + - @.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tags(java.util.Collection<Tag>)

tracingConfiguration

CreateStateMachineRequest.Builder tracingConfiguration(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.

tracingConfiguration

default CreateStateMachineRequest.Builder tracingConfiguration(Consumer<TracingConfiguration.Builder> tracingConfiguration)

Selects whether X-Ray tracing is enabled.

This is a convenience method that creates an instance of the TracingConfiguration.Builder avoiding the need to create one manually via TracingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tracingConfiguration(TracingConfiguration).

Parameters:

tracingConfiguration - a consumer that will call methods on TracingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tracingConfiguration(TracingConfiguration)

publish

CreateStateMachineRequest.Builder publish(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.

versionDescription

CreateStateMachineRequest.Builder versionDescription(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.

encryptionConfiguration

CreateStateMachineRequest.Builder encryptionConfiguration(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.

encryptionConfiguration

default CreateStateMachineRequest.Builder encryptionConfiguration(Consumer<EncryptionConfiguration.Builder> encryptionConfiguration)

Settings to configure server-side encryption.

This is a convenience method that creates an instance of the EncryptionConfiguration.Builder avoiding the need to create one manually via EncryptionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionConfiguration(EncryptionConfiguration).

Parameters:

encryptionConfiguration - a consumer that will call methods on EncryptionConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• encryptionConfiguration(EncryptionConfiguration)

overrideConfiguration

CreateStateMachineRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateStateMachineRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.