Package com.pulumi.aws.gamelift

Class GameSessionQueue

  • public class GameSessionQueue
extends com.pulumi.resources.CustomResource
    Provides an GameLift Game Session Queue resource. ## Example Usage ```java 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 Using `pulumi import`, import GameLift Game Session Queues using their `name`. For example: ```sh $ pulumi import aws:gamelift/gameSessionQueue:GameSessionQueue example example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> customEventData()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> destinations()  
      static GameSessionQueue get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, GameSessionQueueState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> notificationTarget()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<GameSessionQueuePlayerLatencyPolicy>>> playerLatencyPolicies()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> timeoutInSeconds()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • GameSessionQueue

        public GameSessionQueue​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • GameSessionQueue

        public GameSessionQueue​(java.lang.String name,
                        @Nullable
                        GameSessionQueueArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • GameSessionQueue

        public GameSessionQueue​(java.lang.String name,
                        @Nullable
                        GameSessionQueueArgs args,
                        @Nullable
                        com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        Game Session Queue ARN.

      • customEventData

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customEventData()
        Returns:
        Information to be added to all events that are related to this game session queue.

      • destinations

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> destinations()
        Returns:
        List of fleet/alias ARNs used by session queue for placing game sessions.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the session queue.

      • notificationTarget

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> notificationTarget()
        Returns:
        An SNS topic ARN that is set up to receive game session placement notifications.

      • playerLatencyPolicies

        public com.pulumi.core.Output<java.util.Optional<java.util.List<GameSessionQueuePlayerLatencyPolicy>>> playerLatencyPolicies()
        Returns:
        One or more policies used to choose fleet based on player latency. See below.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • timeoutInSeconds

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> timeoutInSeconds()
        Returns:
        Maximum time a game session request can remain in the queue.

      • get

        public static GameSessionQueue get​(java.lang.String name,
                                   com.pulumi.core.Output<java.lang.String> id,
                                   @Nullable
                                   GameSessionQueueState state,
                                   @Nullable
                                   com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.