GameSessionQueue class

Provides an GameLift Game Session Queue resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.gamelift.GameSessionQueue("test", {
    playerLatencyPolicies: [
        {
            maximumIndividualPlayerLatencyMilliseconds: 100,
            policyDurationSeconds: 5,
        },
        {
            maximumIndividualPlayerLatencyMilliseconds: 200,
        },
    ],
    name: "example-session-queue",
    destinations: [
        usWest2Fleet.arn,
        euCentral1Fleet.arn,
    ],
    notificationTarget: gameSessionQueueNotifications.arn,
    timeoutInSeconds: 60,
});
import pulumi
import pulumi_aws as aws

test = aws.gamelift.GameSessionQueue("test",
    player_latency_policies=[
        {
            "maximum_individual_player_latency_milliseconds": 100,
            "policy_duration_seconds": 5,
        },
        {
            "maximum_individual_player_latency_milliseconds": 200,
        },
    ],
    name="example-session-queue",
    destinations=[
        us_west2_fleet["arn"],
        eu_central1_fleet["arn"],
    ],
    notification_target=game_session_queue_notifications["arn"],
    timeout_in_seconds=60)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var test = new Aws.GameLift.GameSessionQueue("test", new()
    {
        PlayerLatencyPolicies = new[]
        {
            new Aws.GameLift.Inputs.GameSessionQueuePlayerLatencyPolicyArgs
            {
                MaximumIndividualPlayerLatencyMilliseconds = 100,
                PolicyDurationSeconds = 5,
            },
            new Aws.GameLift.Inputs.GameSessionQueuePlayerLatencyPolicyArgs
            {
                MaximumIndividualPlayerLatencyMilliseconds = 200,
            },
        },
        Name = "example-session-queue",
        Destinations = new[]
        {
            usWest2Fleet.Arn,
            euCentral1Fleet.Arn,
        },
        NotificationTarget = gameSessionQueueNotifications.Arn,
        TimeoutInSeconds = 60,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			PlayerLatencyPolicies: gamelift.GameSessionQueuePlayerLatencyPolicyArray{
				&gamelift.GameSessionQueuePlayerLatencyPolicyArgs{
					MaximumIndividualPlayerLatencyMilliseconds: pulumi.Int(100),
					PolicyDurationSeconds:                      pulumi.Int(5),
				},
				&gamelift.GameSessionQueuePlayerLatencyPolicyArgs{
					MaximumIndividualPlayerLatencyMilliseconds: pulumi.Int(200),
				},
			},
			Name: pulumi.String("example-session-queue"),
			Destinations: pulumi.StringArray{
				usWest2Fleet.Arn,
				euCentral1Fleet.Arn,
			},
			NotificationTarget: pulumi.Any(gameSessionQueueNotifications.Arn),
			TimeoutInSeconds:   pulumi.Int(60),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_gamelift_gamesessionqueue" "test" {
  player_latency_policies {
    maximum_individual_player_latency_milliseconds = 100
    policy_duration_seconds                        = 5
  }
  player_latency_policies {
    maximum_individual_player_latency_milliseconds = 200
  }
  name                = "example-session-queue"
  destinations        = [usWest2Fleet.arn, euCentral1Fleet.arn]
  notification_target = gameSessionQueueNotifications.arn
  timeout_in_seconds  = 60
}
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.ArrayList;
import java.util.Arrays;
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()
            .playerLatencyPolicies(
                GameSessionQueuePlayerLatencyPolicyArgs.builder()
                    .maximumIndividualPlayerLatencyMilliseconds(100)
                    .policyDurationSeconds(5)
                    .build(),
                GameSessionQueuePlayerLatencyPolicyArgs.builder()
                    .maximumIndividualPlayerLatencyMilliseconds(200)
                    .build())
            .name("example-session-queue")
            .destinations(
                usWest2Fleet.arn(),
                euCentral1Fleet.arn())
            .notificationTarget(gameSessionQueueNotifications.arn())
            .timeoutInSeconds(60)
            .build());

    }
}
resources:
  test:
    type: aws:gamelift:GameSessionQueue
    properties:
      playerLatencyPolicies:
        - maximumIndividualPlayerLatencyMilliseconds: 100
          policyDurationSeconds: 5
        - maximumIndividualPlayerLatencyMilliseconds: 200
      name: example-session-queue
      destinations:
        - ${usWest2Fleet.arn}
        - ${euCentral1Fleet.arn}
      notificationTarget: ${gameSessionQueueNotifications.arn}
      timeoutInSeconds: 60

Import

Using pulumi import, import GameLift Game Session Queues using their name. For example:

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

Constructors

GameSessionQueue(String name, {GameSessionQueueArgs? args, CustomResourceOptions? options})
Creates a new GameSessionQueue. name The Pulumi resource name. args Arguments used to configure this GameSessionQueue. The set of arguments for GameSessionQueue. options Resource options controlling this resource's behavior.
GameSessionQueue.reference(String urn)
Creates a typed reference to an existing GameSessionQueue resource.

Properties

arn ↔ Output<String>
Game Session Queue ARN.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
customEventData ↔ Output<String?>
Information to be added to all events that are related to this game session queue.
latefinal
destinations ↔ Output<List<String>?>
List of fleet/alias ARNs used by session queue for placing game sessions.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
Name of the session queue.
latefinal
notificationTarget ↔ Output<String?>
An SNS topic ARN that is set up to receive game session placement notifications.
latefinal
playerLatencyPolicies ↔ Output<List<GameSessionQueuePlayerLatencyPolicy>?>
One or more policies used to choose fleet based on player latency. See below.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Key-value map of resource tags. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
timeoutInSeconds ↔ Output<int?>
Maximum time a game session request can remain in the queue.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {GameSessionQueueState? state, CustomResourceOptions? options}) → GameSessionQueue
Gets an existing GameSessionQueue resource's state with the given name and id.