AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.11.0 published on Wednesday, Aug 17, 2022 by Pulumi

GameSessionQueue

Provides an GameLift Game Session Queue resource.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.GameLift.GameSessionQueue("test", new()
    {
        Destinations = new[]
        {
            aws_gamelift_fleet.Us_west_2_fleet.Arn,
            aws_gamelift_fleet.Eu_central_1_fleet.Arn,
        },
        NotificationTarget = aws_sns_topic.Game_session_queue_notifications.Arn,
        PlayerLatencyPolicies = new[]
        {
            new Aws.GameLift.Inputs.GameSessionQueuePlayerLatencyPolicyArgs
            {
                MaximumIndividualPlayerLatencyMilliseconds = 100,
                PolicyDurationSeconds = 5,
            },
            new Aws.GameLift.Inputs.GameSessionQueuePlayerLatencyPolicyArgs
            {
                MaximumIndividualPlayerLatencyMilliseconds = 200,
            },
        },
        TimeoutInSeconds = 60,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/gamelift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gamelift.NewGameSessionQueue(ctx, "test", &gamelift.GameSessionQueueArgs{
			Destinations: pulumi.StringArray{
				pulumi.Any(aws_gamelift_fleet.Us_west_2_fleet.Arn),
				pulumi.Any(aws_gamelift_fleet.Eu_central_1_fleet.Arn),
			},
			NotificationTarget: pulumi.Any(aws_sns_topic.Game_session_queue_notifications.Arn),
			PlayerLatencyPolicies: gamelift.GameSessionQueuePlayerLatencyPolicyArray{
				&gamelift.GameSessionQueuePlayerLatencyPolicyArgs{
					MaximumIndividualPlayerLatencyMilliseconds: pulumi.Int(100),
					PolicyDurationSeconds:                      pulumi.Int(5),
				},
				&gamelift.GameSessionQueuePlayerLatencyPolicyArgs{
					MaximumIndividualPlayerLatencyMilliseconds: pulumi.Int(200),
				},
			},
			TimeoutInSeconds: pulumi.Int(60),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.gamelift.GameSessionQueue;
import com.pulumi.aws.gamelift.GameSessionQueueArgs;
import com.pulumi.aws.gamelift.inputs.GameSessionQueuePlayerLatencyPolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new GameSessionQueue("test", GameSessionQueueArgs.builder()        
            .destinations(            
                aws_gamelift_fleet.us_west_2_fleet().arn(),
                aws_gamelift_fleet.eu_central_1_fleet().arn())
            .notificationTarget(aws_sns_topic.game_session_queue_notifications().arn())
            .playerLatencyPolicies(            
                GameSessionQueuePlayerLatencyPolicyArgs.builder()
                    .maximumIndividualPlayerLatencyMilliseconds(100)
                    .policyDurationSeconds(5)
                    .build(),
                GameSessionQueuePlayerLatencyPolicyArgs.builder()
                    .maximumIndividualPlayerLatencyMilliseconds(200)
                    .build())
            .timeoutInSeconds(60)
            .build());

    }
}
import pulumi
import pulumi_aws as aws

test = aws.gamelift.GameSessionQueue("test",
    destinations=[
        aws_gamelift_fleet["us_west_2_fleet"]["arn"],
        aws_gamelift_fleet["eu_central_1_fleet"]["arn"],
    ],
    notification_target=aws_sns_topic["game_session_queue_notifications"]["arn"],
    player_latency_policies=[
        aws.gamelift.GameSessionQueuePlayerLatencyPolicyArgs(
            maximum_individual_player_latency_milliseconds=100,
            policy_duration_seconds=5,
        ),
        aws.gamelift.GameSessionQueuePlayerLatencyPolicyArgs(
            maximum_individual_player_latency_milliseconds=200,
        ),
    ],
    timeout_in_seconds=60)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.gamelift.GameSessionQueue("test", {
    destinations: [
        aws_gamelift_fleet.us_west_2_fleet.arn,
        aws_gamelift_fleet.eu_central_1_fleet.arn,
    ],
    notificationTarget: aws_sns_topic.game_session_queue_notifications.arn,
    playerLatencyPolicies: [
        {
            maximumIndividualPlayerLatencyMilliseconds: 100,
            policyDurationSeconds: 5,
        },
        {
            maximumIndividualPlayerLatencyMilliseconds: 200,
        },
    ],
    timeoutInSeconds: 60,
});
resources:
  test:
    type: aws:gamelift:GameSessionQueue
    properties:
      destinations:
        - ${aws_gamelift_fleet.us_west_2_fleet.arn}
        - ${aws_gamelift_fleet.eu_central_1_fleet.arn}
      notificationTarget: ${aws_sns_topic.game_session_queue_notifications.arn}
      playerLatencyPolicies:
        - maximumIndividualPlayerLatencyMilliseconds: 100
          policyDurationSeconds: 5
        - maximumIndividualPlayerLatencyMilliseconds: 200
      timeoutInSeconds: 60

Create a GameSessionQueue Resource

new GameSessionQueue(name: string, args?: GameSessionQueueArgs, opts?: CustomResourceOptions);
@overload
def GameSessionQueue(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     destinations: Optional[Sequence[str]] = None,
                     name: Optional[str] = None,
                     notification_target: Optional[str] = None,
                     player_latency_policies: Optional[Sequence[GameSessionQueuePlayerLatencyPolicyArgs]] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     timeout_in_seconds: Optional[int] = None)
@overload
def GameSessionQueue(resource_name: str,
                     args: Optional[GameSessionQueueArgs] = None,
                     opts: Optional[ResourceOptions] = None)
func NewGameSessionQueue(ctx *Context, name string, args *GameSessionQueueArgs, opts ...ResourceOption) (*GameSessionQueue, error)
public GameSessionQueue(string name, GameSessionQueueArgs? args = null, CustomResourceOptions? opts = null)
public GameSessionQueue(String name, GameSessionQueueArgs args)
public GameSessionQueue(String name, GameSessionQueueArgs args, CustomResourceOptions options)
type: aws:gamelift:GameSessionQueue
properties: # The arguments to resource properties.
options: # 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.
resource_name str
The unique name of the resource.
args GameSessionQueueArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control 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.
name String
The unique name of the resource.
args GameSessionQueueArgs
The arguments to resource properties.
options 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 Architecture and Concepts 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.

NotificationTarget string

An SNS topic ARN that is set up to receive game session placement notifications.

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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

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.

NotificationTarget string

An SNS topic ARN that is set up to receive game session placement notifications.

PlayerLatencyPolicies []GameSessionQueuePlayerLatencyPolicyArgs

One or more policies used to choose fleet based on player latency. See below.

Tags map[string]string

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TimeoutInSeconds int

Maximum time a game session request can remain in the queue.

destinations List<String>

List of fleet/alias ARNs used by session queue for placing game sessions.

name String

Name of the session queue.

notificationTarget String

An SNS topic ARN that is set up to receive game session placement notifications.

playerLatencyPolicies List<GameSessionQueuePlayerLatencyPolicyArgs>

One or more policies used to choose fleet based on player latency. See below.

tags Map<String,String>

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timeoutInSeconds Integer

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.

notificationTarget string

An SNS topic ARN that is set up to receive game session placement notifications.

playerLatencyPolicies GameSessionQueuePlayerLatencyPolicyArgs[]

One or more policies used to choose fleet based on player latency. See below.

tags {[key: string]: string}

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timeoutInSeconds number

Maximum time a game session request can remain in the queue.

destinations Sequence[str]

List of fleet/alias ARNs used by session queue for placing game sessions.

name str

Name of the session queue.

notification_target str

An SNS topic ARN that is set up to receive game session placement notifications.

player_latency_policies Sequence[GameSessionQueuePlayerLatencyPolicyArgs]

One or more policies used to choose fleet based on player latency. See below.

tags Mapping[str, str]

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timeout_in_seconds int

Maximum time a game session request can remain in the queue.

destinations List<String>

List of fleet/alias ARNs used by session queue for placing game sessions.

name String

Name of the session queue.

notificationTarget String

An SNS topic ARN that is set up to receive game session placement notifications.

playerLatencyPolicies List<Property Map>

One or more policies used to choose fleet based on player latency. See below.

tags Map<String>

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timeoutInSeconds Number

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.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

Game Session Queue ARN.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

Game Session Queue ARN.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

Game Session Queue ARN.

id string

The provider-assigned unique ID for this managed resource.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

Game Session Queue ARN.

id str

The provider-assigned unique ID for this managed resource.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

Game Session Queue ARN.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        destinations: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        notification_target: Optional[str] = None,
        player_latency_policies: Optional[Sequence[GameSessionQueuePlayerLatencyPolicyArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeout_in_seconds: Optional[int] = None) -> GameSessionQueue
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)
public static GameSessionQueue get(String name, Output<String> id, GameSessionQueueState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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.
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.

NotificationTarget string

An SNS topic ARN that is set up to receive game session placement notifications.

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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

NotificationTarget string

An SNS topic ARN that is set up to receive game session placement notifications.

PlayerLatencyPolicies []GameSessionQueuePlayerLatencyPolicyArgs

One or more policies used to choose fleet based on player latency. See below.

Tags map[string]string

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

TimeoutInSeconds int

Maximum time a game session request can remain in the queue.

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.

notificationTarget String

An SNS topic ARN that is set up to receive game session placement notifications.

playerLatencyPolicies List<GameSessionQueuePlayerLatencyPolicyArgs>

One or more policies used to choose fleet based on player latency. See below.

tags Map<String,String>

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timeoutInSeconds Integer

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.

notificationTarget string

An SNS topic ARN that is set up to receive game session placement notifications.

playerLatencyPolicies GameSessionQueuePlayerLatencyPolicyArgs[]

One or more policies used to choose fleet based on player latency. See below.

tags {[key: string]: string}

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timeoutInSeconds number

Maximum time a game session request can remain in the queue.

arn str

Game Session Queue ARN.

destinations Sequence[str]

List of fleet/alias ARNs used by session queue for placing game sessions.

name str

Name of the session queue.

notification_target str

An SNS topic ARN that is set up to receive game session placement notifications.

player_latency_policies Sequence[GameSessionQueuePlayerLatencyPolicyArgs]

One or more policies used to choose fleet based on player latency. See below.

tags Mapping[str, str]

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timeout_in_seconds int

Maximum time a game session request can remain in the queue.

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.

notificationTarget String

An SNS topic ARN that is set up to receive game session placement notifications.

playerLatencyPolicies List<Property Map>

One or more policies used to choose fleet based on player latency. See below.

tags Map<String>

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

timeoutInSeconds Number

Maximum time a game session request can remain in the queue.

Supporting Types

GameSessionQueuePlayerLatencyPolicy

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 Integer

Maximum latency value that is allowed for any player.

policyDurationSeconds Integer

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.

maximum_individual_player_latency_milliseconds int

Maximum latency value that is allowed for any player.

policy_duration_seconds 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.

Import

GameLift Game Session Queues can be imported by their name, e.g.,

 $ pulumi import aws:gamelift/gameSessionQueue:GameSessionQueue example example

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.