Struct aws_sdk_gamelift::client::fluent_builders::CreateAlias

pub struct CreateAlias { /* private fields */ }

Fluent builder constructing a request to CreateAlias.

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. An alias provides a level of abstraction for a fleet that is useful when redirecting player traffic from one fleet to another, such as when updating your game build.

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID and an ARN. You can reassign an alias to another fleet by calling UpdateAlias.

Related actions

CreateAlias | ListAliases | DescribeAlias | UpdateAlias | DeleteAlias | ResolveAlias | All APIs by task

Implementations

impl CreateAlias

pub async fn send(self) -> Result<CreateAliasOutput, SdkError<CreateAliasError>>

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 name(self, input: impl Into<String>) -> Self

A descriptive label that is associated with an alias. Alias names do not need to be unique.

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

A descriptive label that is associated with an alias. Alias names do not need to be unique.

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

A human-readable description of the alias.

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

A human-readable description of the alias.

pub fn routing_strategy(self, input: RoutingStrategy) -> Self

The routing configuration, including routing type and fleet target, for the alias.

pub fn set_routing_strategy(self, input: Option<RoutingStrategy>) -> Self

The routing configuration, including routing type and fleet target, for the alias.

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

Appends an item to Tags.

To override the contents of this collection use set_tags.

A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.

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

A list of labels to assign to the new alias resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the Amazon Web Services General Reference for actual tagging limits.

Trait Implementations

impl Clone for CreateAlias

fn clone(&self) -> CreateAlias

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAlias

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

Formats the value using the given formatter.