Struct aws_sdk_gamelift::client::fluent_builders::CreateFleetLocations

pub struct CreateFleetLocations { /* private fields */ }

Fluent builder constructing a request to CreateFleetLocations.

Adds remote locations to a fleet and begins populating the new locations with EC2 instances. The new instances conform to the fleet's instance type, auto-scaling, and other configuration settings.

This operation cannot be used with fleets that don't support remote locations. Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support this feature (see CreateFleet for the complete list) and were created after the feature was released in March 2021.

To add fleet locations, specify the fleet to be updated and provide a list of one or more locations.

If successful, this operation returns the list of added locations with their status set to NEW. GameLift initiates the process of starting an instance in each added location. You can track the status of each new location by monitoring location creation events using DescribeFleetEvents. Alternatively, you can poll location status by calling DescribeFleetLocationAttributes. After a location status becomes ACTIVE, you can adjust the location's capacity as needed with UpdateFleetCapacity.

Learn more

Setting up fleets

Multi-location fleets

Related actions

CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task

Implementations

impl CreateFleetLocations

pub async fn send(
    self
) -> Result<CreateFleetLocationsOutput, SdkError<CreateFleetLocationsError>>

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

A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.

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

A unique identifier for the fleet to add locations to. You can use either the fleet ID or ARN value.

pub fn locations(self, input: LocationConfiguration) -> Self

Appends an item to Locations.

To override the contents of this collection use set_locations.

A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2.

pub fn set_locations(self, input: Option<Vec<LocationConfiguration>>) -> Self

A list of locations to deploy additional instances to and manage as part of the fleet. You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as us-west-2.

Trait Implementations

impl Clone for CreateFleetLocations

fn clone(&self) -> CreateFleetLocations

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateFleetLocations

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

Formats the value using the given formatter.