Struct aws_sdk_sfn::operation::create_state_machine_alias::builders::CreateStateMachineAliasFluentBuilder

pub struct CreateStateMachineAliasFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateStateMachineAlias.

Creates an alias for a state machine that points to one or two versions of the same state machine. You can set your application to call StartExecution with an alias and update the version the alias uses without changing the client's code.

You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second RoutingConfig object in the routingConfiguration parameter. You must also specify the percentage of execution run requests each version should receive in both RoutingConfig objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.

To create an alias that points to a single version, specify a single RoutingConfig object with a weight set to 100.

You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.

CreateStateMachineAlias is an idempotent API. Step Functions bases the idempotency check on the stateMachineArn, description, name, and routingConfiguration parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.

Related operations:

• DescribeStateMachineAlias

• ListStateMachineAliases

• UpdateStateMachineAlias

• DeleteStateMachineAlias

Implementations

impl CreateStateMachineAliasFluentBuilder

pub fn as_input(&self) -> &CreateStateMachineAliasInputBuilder

Access the CreateStateMachineAlias as a reference.

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

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

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

A description for the state machine alias.

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

A description for the state machine alias.

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

A description for the state machine alias.

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

The name of the state machine alias.

To avoid conflict with version ARNs, don't use an integer in the name of the alias.

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

The name of the state machine alias.

To avoid conflict with version ARNs, don't use an integer in the name of the alias.

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

The name of the state machine alias.

To avoid conflict with version ARNs, don't use an integer in the name of the alias.

pub fn routing_configuration(self, input: RoutingConfigurationListItem) -> Self

Appends an item to routingConfiguration.

To override the contents of this collection use set_routing_configuration.

The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. routingConfiguration contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig.

pub fn set_routing_configuration( self, input: Option<Vec<RoutingConfigurationListItem>> ) -> Self

The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. routingConfiguration contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig.

pub fn get_routing_configuration( &self ) -> &Option<Vec<RoutingConfigurationListItem>>

The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. routingConfiguration contains an array of RoutingConfig objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each RoutingConfig.

Trait Implementations

impl Clone for CreateStateMachineAliasFluentBuilder

fn clone(&self) -> CreateStateMachineAliasFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateStateMachineAliasFluentBuilder

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

Formats the value using the given formatter.