Struct aws_sdk_sfn::operation::update_state_machine::builders::UpdateStateMachineFluentBuilder

pub struct UpdateStateMachineFluentBuilder { /* private fields */ }

Fluent builder constructing a request to UpdateStateMachine.

Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

A qualified state machine ARN refers to a Distributed Map state defined within a state machine. For example, the qualified state machine ARN arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel refers to a Distributed Map state with a label mapStateLabel in the state machine named stateMachineName.

A qualified state machine ARN can either refer to a Distributed Map state defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

• The following qualified state machine ARN refers to a Distributed Map state with a label mapStateLabel in a state machine named myStateMachine.

  arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel

  If you provide a qualified state machine ARN that refers to a Distributed Map state, the request fails with ValidationException.

• The following qualified state machine ARN refers to an alias named PROD.

  arn: :states: : :stateMachine:

  If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

• The following unqualified state machine ARN refers to a state machine named myStateMachine.

  arn: :states: : :stateMachine:

After you update your state machine, you can set the publish parameter to true in the same action to publish a new version. This way, you can opt-in to strict versioning of your state machine.

Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.

All StartExecution calls within a few seconds use the updated definition and roleArn. Executions started immediately after you call UpdateStateMachine may use the previous state machine definition and roleArn.

Implementations

impl UpdateStateMachineFluentBuilder

pub fn as_input(&self) -> &UpdateStateMachineInputBuilder

Access the UpdateStateMachine as a reference.

pub async fn send( self ) -> Result<UpdateStateMachineOutput, SdkError<UpdateStateMachineError, 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<UpdateStateMachineOutput, UpdateStateMachineError, Self>

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

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

The Amazon Resource Name (ARN) of the state machine.

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

The Amazon Resource Name (ARN) of the state machine.

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

The Amazon Resource Name (ARN) of the state machine.

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 of the state machine.

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

The Amazon Resource Name (ARN) of the IAM role of the state machine.

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

The Amazon Resource Name (ARN) of the IAM role of the state machine.

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

Use the LoggingConfiguration data type to set CloudWatch Logs options.

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

Use the LoggingConfiguration data type to set CloudWatch Logs options.

pub fn get_logging_configuration(&self) -> &Option<LoggingConfiguration>

Use the LoggingConfiguration data type to set CloudWatch Logs options.

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

Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.

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

Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.

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

Specifies whether the state machine version is published. The default is false. To publish a version after updating the state machine, set publish to true.

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

An optional description of the state machine version to publish.

You can only specify the versionDescription parameter if you've set publish to true.

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

An optional description of the state machine version to publish.

You can only specify the versionDescription parameter if you've set publish to true.

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

An optional description of the state machine version to publish.

You can only specify the versionDescription parameter if you've set publish to true.

Trait Implementations

impl Clone for UpdateStateMachineFluentBuilder

fn clone(&self) -> UpdateStateMachineFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateStateMachineFluentBuilder

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

Formats the value using the given formatter.