Struct aws_sdk_sfn::operation::create_state_machine::builders::CreateStateMachineFluentBuilder

pub struct CreateStateMachineFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateStateMachine.

Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. For more information, see Amazon States Language in the Step Functions User Guide.

If you set the publish parameter of this API action to true, it publishes version 1 as the first revision of the state machine.

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name, definition, type, LoggingConfiguration, and TracingConfiguration. The check is also based on the publish and versionDescription parameters. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

Implementations

impl CreateStateMachineFluentBuilder

pub fn as_input(&self) -> &CreateStateMachineInputBuilder

Access the CreateStateMachine as a reference.

pub async fn send( self ) -> Result<CreateStateMachineOutput, SdkError<CreateStateMachineError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<CreateStateMachineOutput, CreateStateMachineError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn name(self, input: impl Into<String>) -> Self

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

pub fn set_name(self, input: Option<String>) -> Self

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

pub fn get_name(&self) -> &Option<String>

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

pub fn definition(self, input: impl Into<String>) -> Self

The Amazon States Language definition of the state machine. See Amazon States Language.

pub fn set_definition(self, input: Option<String>) -> Self

The Amazon States Language definition of the state machine. See Amazon States Language.

pub fn get_definition(&self) -> &Option<String>

The Amazon States Language definition of the state machine. See Amazon States Language.

pub fn role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

pub fn set_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

pub fn get_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

pub fn type(self, input: StateMachineType) -> Self

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.

pub fn set_type(self, input: Option<StateMachineType>) -> Self

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.

pub fn get_type(&self) -> &Option<StateMachineType>

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.

pub fn logging_configuration(self, input: LoggingConfiguration) -> Self

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.

pub fn set_logging_configuration( self, input: Option<LoggingConfiguration> ) -> Self

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.

pub fn get_logging_configuration(&self) -> &Option<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.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_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: _ . : / = + - @.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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: _ . : / = + - @.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

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: _ . : / = + - @.

pub fn tracing_configuration(self, input: TracingConfiguration) -> Self

Selects whether X-Ray tracing is enabled.

pub fn set_tracing_configuration( self, input: Option<TracingConfiguration> ) -> Self

Selects whether X-Ray tracing is enabled.

pub fn get_tracing_configuration(&self) -> &Option<TracingConfiguration>

Selects whether X-Ray tracing is enabled.

pub fn publish(self, input: bool) -> Self

Set to true to publish the first version of the state machine during creation. The default is false.

pub fn set_publish(self, input: Option<bool>) -> Self

Set to true to publish the first version of the state machine during creation. The default is false.

pub fn get_publish(&self) -> &Option<bool>

Set to true to publish the first version of the state machine during creation. The default is false.

pub fn version_description(self, input: impl Into<String>) -> Self

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.

pub fn set_version_description(self, input: Option<String>) -> Self

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.

pub fn get_version_description(&self) -> &Option<String>

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.

Trait Implementations

impl Clone for CreateStateMachineFluentBuilder

fn clone(&self) -> CreateStateMachineFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateStateMachineFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.