aws_sdk_gamelift/client/

create_game_session_queue.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateGameSessionQueue`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::set_name):<br>required: **true**<br><p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region.</p><br>
    ///   - [`timeout_in_seconds(i32)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::timeout_in_seconds) / [`set_timeout_in_seconds(Option<i32>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::set_timeout_in_seconds):<br>required: **false**<br><p>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 <code>TIMED_OUT</code> status. If you don't specify a request timeout, the queue uses a default value.</p><br>
    ///   - [`player_latency_policies(PlayerLatencyPolicy)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::player_latency_policies) / [`set_player_latency_policies(Option<Vec::<PlayerLatencyPolicy>>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::set_player_latency_policies):<br>required: **false**<br><p>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.</p><br>
    ///   - [`destinations(GameSessionQueueDestination)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::destinations) / [`set_destinations(Option<Vec::<GameSessionQueueDestination>>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::set_destinations):<br>required: **false**<br><p>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.</p><br>
    ///   - [`filter_configuration(FilterConfiguration)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::filter_configuration) / [`set_filter_configuration(Option<FilterConfiguration>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::set_filter_configuration):<br>required: **false**<br><p>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 <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location.</p><br>
    ///   - [`priority_configuration(PriorityConfiguration)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::priority_configuration) / [`set_priority_configuration(Option<PriorityConfiguration>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::set_priority_configuration):<br>required: **false**<br><p>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.</p><br>
    ///   - [`custom_event_data(impl Into<String>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::custom_event_data) / [`set_custom_event_data(Option<String>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::set_custom_event_data):<br>required: **false**<br><p>Information to be added to all events that are related to this game session queue.</p><br>
    ///   - [`notification_target(impl Into<String>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::notification_target) / [`set_notification_target(Option<String>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::set_notification_target):<br>required: **false**<br><p>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</p><br>
    ///   - [`tags(Tag)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::set_tags):<br>required: **false**<br><p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</p><br>
    /// - On success, responds with [`CreateGameSessionQueueOutput`](crate::operation::create_game_session_queue::CreateGameSessionQueueOutput) with field(s):
    ///   - [`game_session_queue(Option<GameSessionQueue>)`](crate::operation::create_game_session_queue::CreateGameSessionQueueOutput::game_session_queue): <p>An object that describes the newly created game session queue.</p>
    /// - On failure, responds with [`SdkError<CreateGameSessionQueueError>`](crate::operation::create_game_session_queue::CreateGameSessionQueueError)
    pub fn create_game_session_queue(&self) -> crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder {
        crate::operation::create_game_session_queue::builders::CreateGameSessionQueueFluentBuilder::new(self.handle.clone())
    }
}