pub struct CreateGameSessionQueueFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateGameSessionQueue.
Creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to locate the best available placement locations for a new game session, and then prompts the game server process to start a new game session.
A game session queue is configured with a set of destinations (Amazon GameLift Servers fleets or aliases) that determine where the queue can place new game sessions. These destinations can span multiple Amazon Web Services Regions, can use different instance types, and can include both Spot and On-Demand fleets. If the queue includes multi-location fleets, the queue can place game sessions in any of a fleet's remote locations.
You can configure a queue to determine how it selects the best available placement for a new game session. Queues can prioritize placement decisions based on a combination of location, hosting cost, and player latency. You can set up the queue to use the default prioritization or provide alternate instructions using PriorityConfiguration.
Request options
Use this operation to make these common types of requests.
-
Create a queue with the minimum required parameters.
-
Name -
Destinations(This parameter isn't required, but a queue can't make placements without at least one destination.)
-
-
Create a queue with placement notification. Queues that have high placement activity must use a notification system, such as with Amazon Simple Notification Service (Amazon SNS) or Amazon CloudWatch.
-
Required parameters
NameandDestinations -
NotificationTarget
-
-
Create a queue with custom prioritization settings. These custom settings replace the default prioritization configuration for a queue.
-
Required parameters
NameandDestinations -
PriorityConfiguration
-
-
Create a queue with special rules for processing player latency data.
-
Required parameters
NameandDestinations -
PlayerLatencyPolicies
-
Results
If successful, this operation returns a new GameSessionQueue object with an assigned queue ARN. Use the queue's name or ARN when submitting new game session requests with StartGameSessionPlacement or StartMatchmaking.
Learn more
Related actions
CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task
Implementations§
Source§impl CreateGameSessionQueueFluentBuilder
impl CreateGameSessionQueueFluentBuilder
Sourcepub fn as_input(&self) -> &CreateGameSessionQueueInputBuilder
pub fn as_input(&self) -> &CreateGameSessionQueueInputBuilder
Access the CreateGameSessionQueue as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateGameSessionQueueOutput, SdkError<CreateGameSessionQueueError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateGameSessionQueueOutput, SdkError<CreateGameSessionQueueError, 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.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateGameSessionQueueOutput, CreateGameSessionQueueError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateGameSessionQueueOutput, CreateGameSessionQueueError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
Sourcepub fn timeout_in_seconds(self, input: i32) -> Self
pub fn timeout_in_seconds(self, input: i32) -> Self
The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. If you don't specify a request timeout, the queue uses a default value.
Sourcepub fn set_timeout_in_seconds(self, input: Option<i32>) -> Self
pub fn set_timeout_in_seconds(self, input: Option<i32>) -> Self
The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. If you don't specify a request timeout, the queue uses a default value.
Sourcepub fn get_timeout_in_seconds(&self) -> &Option<i32>
pub fn get_timeout_in_seconds(&self) -> &Option<i32>
The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status. If you don't specify a request timeout, the queue uses a default value.
Sourcepub fn player_latency_policies(self, input: PlayerLatencyPolicy) -> Self
pub fn player_latency_policies(self, input: PlayerLatencyPolicy) -> Self
Appends an item to PlayerLatencyPolicies.
To override the contents of this collection use set_player_latency_policies.
A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.
Sourcepub fn set_player_latency_policies(
self,
input: Option<Vec<PlayerLatencyPolicy>>,
) -> Self
pub fn set_player_latency_policies( self, input: Option<Vec<PlayerLatencyPolicy>>, ) -> Self
A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.
Sourcepub fn get_player_latency_policies(&self) -> &Option<Vec<PlayerLatencyPolicy>>
pub fn get_player_latency_policies(&self) -> &Option<Vec<PlayerLatencyPolicy>>
A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.
Sourcepub fn destinations(self, input: GameSessionQueueDestination) -> Self
pub fn destinations(self, input: GameSessionQueueDestination) -> Self
Appends an item to Destinations.
To override the contents of this collection use set_destinations.
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
Sourcepub fn set_destinations(
self,
input: Option<Vec<GameSessionQueueDestination>>,
) -> Self
pub fn set_destinations( self, input: Option<Vec<GameSessionQueueDestination>>, ) -> Self
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
Sourcepub fn get_destinations(&self) -> &Option<Vec<GameSessionQueueDestination>>
pub fn get_destinations(&self) -> &Option<Vec<GameSessionQueueDestination>>
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
Sourcepub fn filter_configuration(self, input: FilterConfiguration) -> Self
pub fn filter_configuration(self, input: FilterConfiguration) -> Self
A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
Sourcepub fn set_filter_configuration(
self,
input: Option<FilterConfiguration>,
) -> Self
pub fn set_filter_configuration( self, input: Option<FilterConfiguration>, ) -> Self
A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
Sourcepub fn get_filter_configuration(&self) -> &Option<FilterConfiguration>
pub fn get_filter_configuration(&self) -> &Option<FilterConfiguration>
A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as us-west-2. If this parameter is not set, game sessions can be placed in any queue location.
Sourcepub fn priority_configuration(self, input: PriorityConfiguration) -> Self
pub fn priority_configuration(self, input: PriorityConfiguration) -> Self
Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
Sourcepub fn set_priority_configuration(
self,
input: Option<PriorityConfiguration>,
) -> Self
pub fn set_priority_configuration( self, input: Option<PriorityConfiguration>, ) -> Self
Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
Sourcepub fn get_priority_configuration(&self) -> &Option<PriorityConfiguration>
pub fn get_priority_configuration(&self) -> &Option<PriorityConfiguration>
Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
Sourcepub fn custom_event_data(self, input: impl Into<String>) -> Self
pub fn custom_event_data(self, input: impl Into<String>) -> Self
Information to be added to all events that are related to this game session queue.
Sourcepub fn set_custom_event_data(self, input: Option<String>) -> Self
pub fn set_custom_event_data(self, input: Option<String>) -> Self
Information to be added to all events that are related to this game session queue.
Sourcepub fn get_custom_event_data(&self) -> &Option<String>
pub fn get_custom_event_data(&self) -> &Option<String>
Information to be added to all events that are related to this game session queue.
Sourcepub fn notification_target(self, input: impl Into<String>) -> Self
pub fn notification_target(self, input: impl Into<String>) -> Self
An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
Sourcepub fn set_notification_target(self, input: Option<String>) -> Self
pub fn set_notification_target(self, input: Option<String>) -> Self
An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
Sourcepub fn get_notification_target(&self) -> &Option<String>
pub fn get_notification_target(&self) -> &Option<String>
An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.
Appends an item to Tags.
To override the contents of this collection use set_tags.
A list of labels to assign to the new game session queue 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.
A list of labels to assign to the new game session queue 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.
A list of labels to assign to the new game session queue 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.
Trait Implementations§
Source§impl Clone for CreateGameSessionQueueFluentBuilder
impl Clone for CreateGameSessionQueueFluentBuilder
Source§fn clone(&self) -> CreateGameSessionQueueFluentBuilder
fn clone(&self) -> CreateGameSessionQueueFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateGameSessionQueueFluentBuilder
impl !RefUnwindSafe for CreateGameSessionQueueFluentBuilder
impl Send for CreateGameSessionQueueFluentBuilder
impl Sync for CreateGameSessionQueueFluentBuilder
impl Unpin for CreateGameSessionQueueFluentBuilder
impl !UnwindSafe for CreateGameSessionQueueFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);