1. Packages
  2. AWS Native
  3. API Docs
  4. gamelift
  5. GameSessionQueue

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.gamelift.GameSessionQueue

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    The AWS::GameLift::GameSessionQueue resource creates an Amazon GameLift (GameLift) game session queue.

    Example Usage

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var queue = new AwsNative.GameLift.GameSessionQueue("queue", new()
        {
            Name = "MyGameSessionQueue",
            TimeoutInSeconds = 60,
            NotificationTarget = "arn:aws:sns:us-west-2:111122223333:My_Placement_SNS_Topic",
            Destinations = new[]
            {
                new AwsNative.GameLift.Inputs.GameSessionQueueDestinationArgs
                {
                    DestinationArn = "arn:aws:gamelift:us-west-2:012345678912:fleet/fleet-id",
                },
                new AwsNative.GameLift.Inputs.GameSessionQueueDestinationArgs
                {
                    DestinationArn = "arn:aws:gamelift:us-west-2:012345678912:alias/alias-id",
                },
            },
            PlayerLatencyPolicies = new[]
            {
                new AwsNative.GameLift.Inputs.GameSessionQueuePlayerLatencyPolicyArgs
                {
                    MaximumIndividualPlayerLatencyMilliseconds = 1000,
                    PolicyDurationSeconds = 60,
                },
            },
            PriorityConfiguration = new AwsNative.GameLift.Inputs.GameSessionQueuePriorityConfigurationArgs
            {
                LocationOrder = new[]
                {
                    "us-west-2",
                    "us-east-1",
                },
                PriorityOrder = new[]
                {
                    AwsNative.GameLift.GameSessionQueuePriorityOrderItem.Cost,
                    AwsNative.GameLift.GameSessionQueuePriorityOrderItem.Latency,
                    AwsNative.GameLift.GameSessionQueuePriorityOrderItem.Location,
                    AwsNative.GameLift.GameSessionQueuePriorityOrderItem.Destination,
                },
            },
            FilterConfiguration = new AwsNative.GameLift.Inputs.GameSessionQueueFilterConfigurationArgs
            {
                AllowedLocations = new[]
                {
                    "us-east-1",
                    "us-west-2",
                },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/gamelift"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gamelift.NewGameSessionQueue(ctx, "queue", &gamelift.GameSessionQueueArgs{
    			Name:               pulumi.String("MyGameSessionQueue"),
    			TimeoutInSeconds:   pulumi.Int(60),
    			NotificationTarget: pulumi.String("arn:aws:sns:us-west-2:111122223333:My_Placement_SNS_Topic"),
    			Destinations: gamelift.GameSessionQueueDestinationArray{
    				&gamelift.GameSessionQueueDestinationArgs{
    					DestinationArn: pulumi.String("arn:aws:gamelift:us-west-2:012345678912:fleet/fleet-id"),
    				},
    				&gamelift.GameSessionQueueDestinationArgs{
    					DestinationArn: pulumi.String("arn:aws:gamelift:us-west-2:012345678912:alias/alias-id"),
    				},
    			},
    			PlayerLatencyPolicies: gamelift.GameSessionQueuePlayerLatencyPolicyArray{
    				&gamelift.GameSessionQueuePlayerLatencyPolicyArgs{
    					MaximumIndividualPlayerLatencyMilliseconds: pulumi.Int(1000),
    					PolicyDurationSeconds:                      pulumi.Int(60),
    				},
    			},
    			PriorityConfiguration: &gamelift.GameSessionQueuePriorityConfigurationArgs{
    				LocationOrder: pulumi.StringArray{
    					pulumi.String("us-west-2"),
    					pulumi.String("us-east-1"),
    				},
    				PriorityOrder: gamelift.GameSessionQueuePriorityOrderItemArray{
    					gamelift.GameSessionQueuePriorityOrderItemCost,
    					gamelift.GameSessionQueuePriorityOrderItemLatency,
    					gamelift.GameSessionQueuePriorityOrderItemLocation,
    					gamelift.GameSessionQueuePriorityOrderItemDestination,
    				},
    			},
    			FilterConfiguration: &gamelift.GameSessionQueueFilterConfigurationArgs{
    				AllowedLocations: pulumi.StringArray{
    					pulumi.String("us-east-1"),
    					pulumi.String("us-west-2"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    queue = aws_native.gamelift.GameSessionQueue("queue",
        name="MyGameSessionQueue",
        timeout_in_seconds=60,
        notification_target="arn:aws:sns:us-west-2:111122223333:My_Placement_SNS_Topic",
        destinations=[
            aws_native.gamelift.GameSessionQueueDestinationArgs(
                destination_arn="arn:aws:gamelift:us-west-2:012345678912:fleet/fleet-id",
            ),
            aws_native.gamelift.GameSessionQueueDestinationArgs(
                destination_arn="arn:aws:gamelift:us-west-2:012345678912:alias/alias-id",
            ),
        ],
        player_latency_policies=[aws_native.gamelift.GameSessionQueuePlayerLatencyPolicyArgs(
            maximum_individual_player_latency_milliseconds=1000,
            policy_duration_seconds=60,
        )],
        priority_configuration=aws_native.gamelift.GameSessionQueuePriorityConfigurationArgs(
            location_order=[
                "us-west-2",
                "us-east-1",
            ],
            priority_order=[
                aws_native.gamelift.GameSessionQueuePriorityOrderItem.COST,
                aws_native.gamelift.GameSessionQueuePriorityOrderItem.LATENCY,
                aws_native.gamelift.GameSessionQueuePriorityOrderItem.LOCATION,
                aws_native.gamelift.GameSessionQueuePriorityOrderItem.DESTINATION,
            ],
        ),
        filter_configuration=aws_native.gamelift.GameSessionQueueFilterConfigurationArgs(
            allowed_locations=[
                "us-east-1",
                "us-west-2",
            ],
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const queue = new aws_native.gamelift.GameSessionQueue("queue", {
        name: "MyGameSessionQueue",
        timeoutInSeconds: 60,
        notificationTarget: "arn:aws:sns:us-west-2:111122223333:My_Placement_SNS_Topic",
        destinations: [
            {
                destinationArn: "arn:aws:gamelift:us-west-2:012345678912:fleet/fleet-id",
            },
            {
                destinationArn: "arn:aws:gamelift:us-west-2:012345678912:alias/alias-id",
            },
        ],
        playerLatencyPolicies: [{
            maximumIndividualPlayerLatencyMilliseconds: 1000,
            policyDurationSeconds: 60,
        }],
        priorityConfiguration: {
            locationOrder: [
                "us-west-2",
                "us-east-1",
            ],
            priorityOrder: [
                aws_native.gamelift.GameSessionQueuePriorityOrderItem.Cost,
                aws_native.gamelift.GameSessionQueuePriorityOrderItem.Latency,
                aws_native.gamelift.GameSessionQueuePriorityOrderItem.Location,
                aws_native.gamelift.GameSessionQueuePriorityOrderItem.Destination,
            ],
        },
        filterConfiguration: {
            allowedLocations: [
                "us-east-1",
                "us-west-2",
            ],
        },
    });
    

    Coming soon!

    Example

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AwsNative = Pulumi.AwsNative;
    
    return await Deployment.RunAsync(() => 
    {
        var queueResource = new AwsNative.GameLift.GameSessionQueue("queueResource", new()
        {
            Name = "MyGameSessionQueue",
        });
    
        var matchmakingRuleSetResource = new AwsNative.GameLift.MatchmakingRuleSet("matchmakingRuleSetResource", new()
        {
            Name = "MyRuleSet",
            RuleSetBody = "{\"name\": \"MyMatchmakingRuleSet\",\"ruleLanguageVersion\": \"1.0\", \"teams\": [{\"name\": \"MyTeam\",\"minPlayers\": 1,\"maxPlayers\": 20}]}",
        });
    
        var matchmakingConfigurationResource = new AwsNative.GameLift.MatchmakingConfiguration("matchmakingConfigurationResource", new()
        {
            Name = "MyMatchmakingConfiguration",
            AcceptanceRequired = true,
            AcceptanceTimeoutSeconds = 60,
            AdditionalPlayerCount = 8,
            BackfillMode = AwsNative.GameLift.MatchmakingConfigurationBackfillMode.Automatic,
            CustomEventData = "MyCustomEventData",
            Description = "A basic matchmaking configuration for a GameLift-hosted game",
            FlexMatchMode = AwsNative.GameLift.MatchmakingConfigurationFlexMatchMode.WithQueue,
            GameSessionData = "MyGameSessionData",
            GameProperties = new[]
            {
                new AwsNative.GameLift.Inputs.MatchmakingConfigurationGamePropertyArgs
                {
                    Key = "level",
                    Value = "10",
                },
                new AwsNative.GameLift.Inputs.MatchmakingConfigurationGamePropertyArgs
                {
                    Key = "gameMode",
                    Value = "hard",
                },
            },
            GameSessionQueueArns = new[]
            {
                queueResource.Arn,
            },
            RequestTimeoutSeconds = 100,
            RuleSetName = matchmakingRuleSetResource.Id,
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                queueResource,
                matchmakingRuleSetResource,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/gamelift"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		queueResource, err := gamelift.NewGameSessionQueue(ctx, "queueResource", &gamelift.GameSessionQueueArgs{
    			Name: pulumi.String("MyGameSessionQueue"),
    		})
    		if err != nil {
    			return err
    		}
    		matchmakingRuleSetResource, err := gamelift.NewMatchmakingRuleSet(ctx, "matchmakingRuleSetResource", &gamelift.MatchmakingRuleSetArgs{
    			Name:        pulumi.String("MyRuleSet"),
    			RuleSetBody: pulumi.String("{\"name\": \"MyMatchmakingRuleSet\",\"ruleLanguageVersion\": \"1.0\", \"teams\": [{\"name\": \"MyTeam\",\"minPlayers\": 1,\"maxPlayers\": 20}]}"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = gamelift.NewMatchmakingConfiguration(ctx, "matchmakingConfigurationResource", &gamelift.MatchmakingConfigurationArgs{
    			Name:                     pulumi.String("MyMatchmakingConfiguration"),
    			AcceptanceRequired:       pulumi.Bool(true),
    			AcceptanceTimeoutSeconds: pulumi.Int(60),
    			AdditionalPlayerCount:    pulumi.Int(8),
    			BackfillMode:             gamelift.MatchmakingConfigurationBackfillModeAutomatic,
    			CustomEventData:          pulumi.String("MyCustomEventData"),
    			Description:              pulumi.String("A basic matchmaking configuration for a GameLift-hosted game"),
    			FlexMatchMode:            gamelift.MatchmakingConfigurationFlexMatchModeWithQueue,
    			GameSessionData:          pulumi.String("MyGameSessionData"),
    			GameProperties: gamelift.MatchmakingConfigurationGamePropertyArray{
    				&gamelift.MatchmakingConfigurationGamePropertyArgs{
    					Key:   pulumi.String("level"),
    					Value: pulumi.String("10"),
    				},
    				&gamelift.MatchmakingConfigurationGamePropertyArgs{
    					Key:   pulumi.String("gameMode"),
    					Value: pulumi.String("hard"),
    				},
    			},
    			GameSessionQueueArns: pulumi.StringArray{
    				queueResource.Arn,
    			},
    			RequestTimeoutSeconds: pulumi.Int(100),
    			RuleSetName:           matchmakingRuleSetResource.ID(),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			queueResource,
    			matchmakingRuleSetResource,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_aws_native as aws_native
    
    queue_resource = aws_native.gamelift.GameSessionQueue("queueResource", name="MyGameSessionQueue")
    matchmaking_rule_set_resource = aws_native.gamelift.MatchmakingRuleSet("matchmakingRuleSetResource",
        name="MyRuleSet",
        rule_set_body="{\"name\": \"MyMatchmakingRuleSet\",\"ruleLanguageVersion\": \"1.0\", \"teams\": [{\"name\": \"MyTeam\",\"minPlayers\": 1,\"maxPlayers\": 20}]}")
    matchmaking_configuration_resource = aws_native.gamelift.MatchmakingConfiguration("matchmakingConfigurationResource",
        name="MyMatchmakingConfiguration",
        acceptance_required=True,
        acceptance_timeout_seconds=60,
        additional_player_count=8,
        backfill_mode=aws_native.gamelift.MatchmakingConfigurationBackfillMode.AUTOMATIC,
        custom_event_data="MyCustomEventData",
        description="A basic matchmaking configuration for a GameLift-hosted game",
        flex_match_mode=aws_native.gamelift.MatchmakingConfigurationFlexMatchMode.WITH_QUEUE,
        game_session_data="MyGameSessionData",
        game_properties=[
            aws_native.gamelift.MatchmakingConfigurationGamePropertyArgs(
                key="level",
                value="10",
            ),
            aws_native.gamelift.MatchmakingConfigurationGamePropertyArgs(
                key="gameMode",
                value="hard",
            ),
        ],
        game_session_queue_arns=[queue_resource.arn],
        request_timeout_seconds=100,
        rule_set_name=matchmaking_rule_set_resource.id,
        opts = pulumi.ResourceOptions(depends_on=[
                queue_resource,
                matchmaking_rule_set_resource,
            ]))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws_native from "@pulumi/aws-native";
    
    const queueResource = new aws_native.gamelift.GameSessionQueue("queueResource", {name: "MyGameSessionQueue"});
    const matchmakingRuleSetResource = new aws_native.gamelift.MatchmakingRuleSet("matchmakingRuleSetResource", {
        name: "MyRuleSet",
        ruleSetBody: "{\"name\": \"MyMatchmakingRuleSet\",\"ruleLanguageVersion\": \"1.0\", \"teams\": [{\"name\": \"MyTeam\",\"minPlayers\": 1,\"maxPlayers\": 20}]}",
    });
    const matchmakingConfigurationResource = new aws_native.gamelift.MatchmakingConfiguration("matchmakingConfigurationResource", {
        name: "MyMatchmakingConfiguration",
        acceptanceRequired: true,
        acceptanceTimeoutSeconds: 60,
        additionalPlayerCount: 8,
        backfillMode: aws_native.gamelift.MatchmakingConfigurationBackfillMode.Automatic,
        customEventData: "MyCustomEventData",
        description: "A basic matchmaking configuration for a GameLift-hosted game",
        flexMatchMode: aws_native.gamelift.MatchmakingConfigurationFlexMatchMode.WithQueue,
        gameSessionData: "MyGameSessionData",
        gameProperties: [
            {
                key: "level",
                value: "10",
            },
            {
                key: "gameMode",
                value: "hard",
            },
        ],
        gameSessionQueueArns: [queueResource.arn],
        requestTimeoutSeconds: 100,
        ruleSetName: matchmakingRuleSetResource.id,
    }, {
        dependsOn: [
            queueResource,
            matchmakingRuleSetResource,
        ],
    });
    

    Coming soon!

    Create GameSessionQueue Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GameSessionQueue(name: string, args?: GameSessionQueueArgs, opts?: CustomResourceOptions);
    @overload
    def GameSessionQueue(resource_name: str,
                         args: Optional[GameSessionQueueArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def GameSessionQueue(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         custom_event_data: Optional[str] = None,
                         destinations: Optional[Sequence[GameSessionQueueDestinationArgs]] = None,
                         filter_configuration: Optional[GameSessionQueueFilterConfigurationArgs] = None,
                         name: Optional[str] = None,
                         notification_target: Optional[str] = None,
                         player_latency_policies: Optional[Sequence[GameSessionQueuePlayerLatencyPolicyArgs]] = None,
                         priority_configuration: Optional[GameSessionQueuePriorityConfigurationArgs] = None,
                         tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                         timeout_in_seconds: Optional[int] = 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-native:gamelift:GameSessionQueue
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const gameSessionQueueResource = new aws_native.gamelift.GameSessionQueue("gameSessionQueueResource", {
        customEventData: "string",
        destinations: [{
            destinationArn: "string",
        }],
        filterConfiguration: {
            allowedLocations: ["string"],
        },
        name: "string",
        notificationTarget: "string",
        playerLatencyPolicies: [{
            maximumIndividualPlayerLatencyMilliseconds: 0,
            policyDurationSeconds: 0,
        }],
        priorityConfiguration: {
            locationOrder: ["string"],
            priorityOrder: [aws_native.gamelift.GameSessionQueuePriorityOrderItem.Latency],
        },
        tags: [{
            key: "string",
            value: "string",
        }],
        timeoutInSeconds: 0,
    });
    
    Coming soon!
    

    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:

    CustomEventData string
    Information that is added to all events that are related to this game session queue.
    Destinations List<Pulumi.AwsNative.GameLift.Inputs.GameSessionQueueDestination>
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
    FilterConfiguration Pulumi.AwsNative.GameLift.Inputs.GameSessionQueueFilterConfiguration
    A list of locations where a queue is allowed to place new game sessions.
    Name string
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    NotificationTarget string
    An SNS topic ARN that is set up to receive game session placement notifications.
    PlayerLatencyPolicies List<Pulumi.AwsNative.GameLift.Inputs.GameSessionQueuePlayerLatencyPolicy>
    A set of policies that act as a sliding cap on player latency.
    PriorityConfiguration Pulumi.AwsNative.GameLift.Inputs.GameSessionQueuePriorityConfiguration
    Custom settings to use when prioritizing destinations and locations for game session placements.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    TimeoutInSeconds int
    The maximum time, in seconds, that a new game session placement request remains in the queue.
    CustomEventData string
    Information that is added to all events that are related to this game session queue.
    Destinations []GameSessionQueueDestinationArgs
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
    FilterConfiguration GameSessionQueueFilterConfigurationArgs
    A list of locations where a queue is allowed to place new game sessions.
    Name string
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    NotificationTarget string
    An SNS topic ARN that is set up to receive game session placement notifications.
    PlayerLatencyPolicies []GameSessionQueuePlayerLatencyPolicyArgs
    A set of policies that act as a sliding cap on player latency.
    PriorityConfiguration GameSessionQueuePriorityConfigurationArgs
    Custom settings to use when prioritizing destinations and locations for game session placements.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    TimeoutInSeconds int
    The maximum time, in seconds, that a new game session placement request remains in the queue.
    customEventData String
    Information that is added to all events that are related to this game session queue.
    destinations List<GameSessionQueueDestination>
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
    filterConfiguration GameSessionQueueFilterConfiguration
    A list of locations where a queue is allowed to place new game sessions.
    name String
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    notificationTarget String
    An SNS topic ARN that is set up to receive game session placement notifications.
    playerLatencyPolicies List<GameSessionQueuePlayerLatencyPolicy>
    A set of policies that act as a sliding cap on player latency.
    priorityConfiguration GameSessionQueuePriorityConfiguration
    Custom settings to use when prioritizing destinations and locations for game session placements.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    timeoutInSeconds Integer
    The maximum time, in seconds, that a new game session placement request remains in the queue.
    customEventData string
    Information that is added to all events that are related to this game session queue.
    destinations GameSessionQueueDestination[]
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
    filterConfiguration GameSessionQueueFilterConfiguration
    A list of locations where a queue is allowed to place new game sessions.
    name string
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    notificationTarget string
    An SNS topic ARN that is set up to receive game session placement notifications.
    playerLatencyPolicies GameSessionQueuePlayerLatencyPolicy[]
    A set of policies that act as a sliding cap on player latency.
    priorityConfiguration GameSessionQueuePriorityConfiguration
    Custom settings to use when prioritizing destinations and locations for game session placements.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    timeoutInSeconds number
    The maximum time, in seconds, that a new game session placement request remains in the queue.
    custom_event_data str
    Information that is added to all events that are related to this game session queue.
    destinations Sequence[GameSessionQueueDestinationArgs]
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
    filter_configuration GameSessionQueueFilterConfigurationArgs
    A list of locations where a queue is allowed to place new game sessions.
    name str
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    notification_target str
    An SNS topic ARN that is set up to receive game session placement notifications.
    player_latency_policies Sequence[GameSessionQueuePlayerLatencyPolicyArgs]
    A set of policies that act as a sliding cap on player latency.
    priority_configuration GameSessionQueuePriorityConfigurationArgs
    Custom settings to use when prioritizing destinations and locations for game session placements.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    timeout_in_seconds int
    The maximum time, in seconds, that a new game session placement request remains in the queue.
    customEventData String
    Information that is added to all events that are related to this game session queue.
    destinations List<Property Map>
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
    filterConfiguration Property Map
    A list of locations where a queue is allowed to place new game sessions.
    name String
    A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
    notificationTarget String
    An SNS topic ARN that is set up to receive game session placement notifications.
    playerLatencyPolicies List<Property Map>
    A set of policies that act as a sliding cap on player latency.
    priorityConfiguration Property Map
    Custom settings to use when prioritizing destinations and locations for game session placements.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    timeoutInSeconds Number
    The maximum time, in seconds, that a new game session placement request remains in the queue.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GameSessionQueueDestination, GameSessionQueueDestinationArgs

    DestinationArn string
    The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
    DestinationArn string
    The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
    destinationArn String
    The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
    destinationArn string
    The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
    destination_arn str
    The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.
    destinationArn String
    The Amazon Resource Name (ARN) that is assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a Region name, provide a unique identifier across all Regions.

    GameSessionQueueFilterConfiguration, GameSessionQueueFilterConfigurationArgs

    AllowedLocations List<string>
    A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
    AllowedLocations []string
    A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
    allowedLocations List<String>
    A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
    allowedLocations string[]
    A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
    allowed_locations Sequence[str]
    A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .
    allowedLocations List<String>
    A list of locations to allow game session placement in, in the form of AWS Region codes such as us-west-2 .

    GameSessionQueuePlayerLatencyPolicy, GameSessionQueuePlayerLatencyPolicyArgs

    MaximumIndividualPlayerLatencyMilliseconds int
    The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
    PolicyDurationSeconds int
    The length of time, in seconds, that the policy is enforced while placing a new game session.
    MaximumIndividualPlayerLatencyMilliseconds int
    The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
    PolicyDurationSeconds int
    The length of time, in seconds, that the policy is enforced while placing a new game session.
    maximumIndividualPlayerLatencyMilliseconds Integer
    The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
    policyDurationSeconds Integer
    The length of time, in seconds, that the policy is enforced while placing a new game session.
    maximumIndividualPlayerLatencyMilliseconds number
    The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
    policyDurationSeconds number
    The length of time, in seconds, that the policy is enforced while placing a new game session.
    maximum_individual_player_latency_milliseconds int
    The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
    policy_duration_seconds int
    The length of time, in seconds, that the policy is enforced while placing a new game session.
    maximumIndividualPlayerLatencyMilliseconds Number
    The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.
    policyDurationSeconds Number
    The length of time, in seconds, that the policy is enforced while placing a new game session.

    GameSessionQueuePriorityConfiguration, GameSessionQueuePriorityConfigurationArgs

    LocationOrder List<string>
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    PriorityOrder List<Pulumi.AwsNative.GameLift.GameSessionQueuePriorityOrderItem>
    The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

    • LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.
    • COST -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.
    • DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.
    • LOCATION -- FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder .
    LocationOrder []string
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    PriorityOrder []GameSessionQueuePriorityOrderItem
    The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

    • LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.
    • COST -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.
    • DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.
    • LOCATION -- FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder .
    locationOrder List<String>
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    priorityOrder List<GameSessionQueuePriorityOrderItem>
    The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

    • LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.
    • COST -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.
    • DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.
    • LOCATION -- FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder .
    locationOrder string[]
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    priorityOrder GameSessionQueuePriorityOrderItem[]
    The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

    • LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.
    • COST -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.
    • DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.
    • LOCATION -- FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder .
    location_order Sequence[str]
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    priority_order Sequence[GameSessionQueuePriorityOrderItem]
    The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

    • LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.
    • COST -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.
    • DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.
    • LOCATION -- FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder .
    locationOrder List<String>
    The prioritization order to use for fleet locations, when the PriorityOrder property includes LOCATION . Locations are identified by AWS Region codes such as us-west-2 . Each location can only be listed once.
    priorityOrder List<"LATENCY" | "COST" | "DESTINATION" | "LOCATION">
    The recommended sequence to use when prioritizing where to place new game sessions. Each type can only be listed once.

    • LATENCY -- FleetIQ prioritizes locations where the average player latency (provided in each game session request) is lowest.
    • COST -- FleetIQ prioritizes destinations with the lowest current hosting costs. Cost is evaluated based on the location, instance type, and fleet type (Spot or On-Demand) for each destination in the queue.
    • DESTINATION -- FleetIQ prioritizes based on the order that destinations are listed in the queue configuration.
    • LOCATION -- FleetIQ prioritizes based on the provided order of locations, as defined in LocationOrder .

    GameSessionQueuePriorityOrderItem, GameSessionQueuePriorityOrderItemArgs

    Latency
    LATENCY
    Cost
    COST
    Destination
    DESTINATION
    Location
    LOCATION
    GameSessionQueuePriorityOrderItemLatency
    LATENCY
    GameSessionQueuePriorityOrderItemCost
    COST
    GameSessionQueuePriorityOrderItemDestination
    DESTINATION
    GameSessionQueuePriorityOrderItemLocation
    LOCATION
    Latency
    LATENCY
    Cost
    COST
    Destination
    DESTINATION
    Location
    LOCATION
    Latency
    LATENCY
    Cost
    COST
    Destination
    DESTINATION
    Location
    LOCATION
    LATENCY
    LATENCY
    COST
    COST
    DESTINATION
    DESTINATION
    LOCATION
    LOCATION
    "LATENCY"
    LATENCY
    "COST"
    COST
    "DESTINATION"
    DESTINATION
    "LOCATION"
    LOCATION

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi