GameSessionQueue

Provides an Gamelift Game Session Queue resource.

Create a GameSessionQueue Resource

new GameSessionQueue(name: string, args?: GameSessionQueueArgs, opts?: CustomResourceOptions);

def GameSessionQueue(resource_name, opts=None, destinations=None, name=None, player_latency_policies=None, tags=None, timeout_in_seconds=None, __props__=None);

func NewGameSessionQueue(ctx *Context, name string, args *GameSessionQueueArgs, opts ...ResourceOption) (*GameSessionQueue, error)

public GameSessionQueue(string name, GameSessionQueueArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GameSessionQueueArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GameSessionQueueArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GameSessionQueueArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

GameSessionQueue Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The GameSessionQueue resource accepts the following input properties:

Destinations List<string>: List of fleet/alias ARNs used by session queue for placing game sessions.
Name string: Name of the session queue.
PlayerLatencyPolicies List<GameSessionQueuePlayerLatencyPolicyArgs>: One or more policies used to choose fleet based on player latency. See below.
Tags Dictionary<string, string>: Key-value map of resource tags
TimeoutInSeconds int: Maximum time a game session request can remain in the queue.

Destinations []string: List of fleet/alias ARNs used by session queue for placing game sessions.
Name string: Name of the session queue.
PlayerLatencyPolicies []GameSessionQueuePlayerLatencyPolicy: One or more policies used to choose fleet based on player latency. See below.
Tags map[string]string: Key-value map of resource tags
TimeoutInSeconds int: Maximum time a game session request can remain in the queue.

destinations string[]: List of fleet/alias ARNs used by session queue for placing game sessions.
name string: Name of the session queue.
playerLatencyPolicies GameSessionQueuePlayerLatencyPolicy[]: One or more policies used to choose fleet based on player latency. See below.
tags {[key: string]: string}: Key-value map of resource tags
timeoutInSeconds number: Maximum time a game session request can remain in the queue.

destinations List[str]: List of fleet/alias ARNs used by session queue for placing game sessions.
name str: Name of the session queue.
player_latency_policies List[GameSessionQueuePlayerLatencyPolicy]: One or more policies used to choose fleet based on player latency. See below.
tags Dict[str, str]: Key-value map of resource tags
timeout_in_seconds float: Maximum time a game session request can remain in the queue.

Outputs

All input properties are implicitly available as output properties. Additionally, the GameSessionQueue resource produces the following output properties:

Arn string: Game Session Queue ARN.
Id string: The provider-assigned unique ID for this managed resource.

Arn string: Game Session Queue ARN.
Id string: The provider-assigned unique ID for this managed resource.

arn string: Game Session Queue ARN.
id string: The provider-assigned unique ID for this managed resource.

arn str: Game Session Queue ARN.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing GameSessionQueue Resource

Get an existing GameSessionQueue resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GameSessionQueueState, opts?: CustomResourceOptions): GameSessionQueue

static get(resource_name, id, opts=None, arn=None, destinations=None, name=None, player_latency_policies=None, tags=None, timeout_in_seconds=None, __props__=None);

func GetGameSessionQueue(ctx *Context, name string, id IDInput, state *GameSessionQueueState, opts ...ResourceOption) (*GameSessionQueue, error)

public static GameSessionQueue Get(string name, Input<string> id, GameSessionQueueState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: Game Session Queue ARN.
Destinations List<string>: List of fleet/alias ARNs used by session queue for placing game sessions.
Name string: Name of the session queue.
PlayerLatencyPolicies List<GameSessionQueuePlayerLatencyPolicyArgs>: One or more policies used to choose fleet based on player latency. See below.
Tags Dictionary<string, string>: Key-value map of resource tags
TimeoutInSeconds int: Maximum time a game session request can remain in the queue.

Arn string: Game Session Queue ARN.
Destinations []string: List of fleet/alias ARNs used by session queue for placing game sessions.
Name string: Name of the session queue.
PlayerLatencyPolicies []GameSessionQueuePlayerLatencyPolicy: One or more policies used to choose fleet based on player latency. See below.
Tags map[string]string: Key-value map of resource tags
TimeoutInSeconds int: Maximum time a game session request can remain in the queue.

arn string: Game Session Queue ARN.
destinations string[]: List of fleet/alias ARNs used by session queue for placing game sessions.
name string: Name of the session queue.
playerLatencyPolicies GameSessionQueuePlayerLatencyPolicy[]: One or more policies used to choose fleet based on player latency. See below.
tags {[key: string]: string}: Key-value map of resource tags
timeoutInSeconds number: Maximum time a game session request can remain in the queue.

arn str: Game Session Queue ARN.
destinations List[str]: List of fleet/alias ARNs used by session queue for placing game sessions.
name str: Name of the session queue.
player_latency_policies List[GameSessionQueuePlayerLatencyPolicy]: One or more policies used to choose fleet based on player latency. See below.
tags Dict[str, str]: Key-value map of resource tags
timeout_in_seconds float: Maximum time a game session request can remain in the queue.

Supporting Types

GameSessionQueuePlayerLatencyPolicy

See the input and output API doc for this type.

MaximumIndividualPlayerLatencyMilliseconds int: Maximum latency value that is allowed for any player.
PolicyDurationSeconds int: Length of time that the policy is enforced while placing a new game session. Absence of value for this attribute means that the policy is enforced until the queue times out.

MaximumIndividualPlayerLatencyMilliseconds int: Maximum latency value that is allowed for any player.
PolicyDurationSeconds int: Length of time that the policy is enforced while placing a new game session. Absence of value for this attribute means that the policy is enforced until the queue times out.

maximumIndividualPlayerLatencyMilliseconds number: Maximum latency value that is allowed for any player.
policyDurationSeconds number: Length of time that the policy is enforced while placing a new game session. Absence of value for this attribute means that the policy is enforced until the queue times out.

maximumIndividualPlayerLatencyMilliseconds float: Maximum latency value that is allowed for any player.
policyDurationSeconds float: Length of time that the policy is enforced while placing a new game session. Absence of value for this attribute means that the policy is enforced until the queue times out.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud