CfnGameSessionQueue

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.gamelift.CfnGameSessionQueue

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:21.874Z")
public class CfnGameSessionQueue
extends CfnResource
implements IInspectable

A CloudFormation `AWS::GameLift::GameSessionQueue`.

The AWS::GameLift::GameSessionQueue resource creates a placement queue that processes requests for new game sessions. A queue uses FleetIQ algorithms to determine the best placement locations and find an available game server, then prompts the game server to start a new game session. Queues can have destinations (GameLift fleets or aliases), which determine where the queue can place new game sessions. A queue can have destinations with varied fleet type (Spot and On-Demand), instance type, and AWS Region .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 CfnGameSessionQueue cfnGameSessionQueue = CfnGameSessionQueue.Builder.create(this, "MyCfnGameSessionQueue")
         .name("name")
         // the properties below are optional
         .customEventData("customEventData")
         .destinations(List.of(DestinationProperty.builder()
                 .destinationArn("destinationArn")
                 .build()))
         .filterConfiguration(FilterConfigurationProperty.builder()
                 .allowedLocations(List.of("allowedLocations"))
                 .build())
         .notificationTarget("notificationTarget")
         .playerLatencyPolicies(List.of(PlayerLatencyPolicyProperty.builder()
                 .maximumIndividualPlayerLatencyMilliseconds(123)
                 .policyDurationSeconds(123)
                 .build()))
         .priorityConfiguration(PriorityConfigurationProperty.builder()
                 .locationOrder(List.of("locationOrder"))
                 .priorityOrder(List.of("priorityOrder"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeoutInSeconds(123)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnGameSessionQueue.Builder` A fluent builder for `CfnGameSessionQueue`.
`static interface`	`CfnGameSessionQueue.DestinationProperty` A fleet or alias designated in a game session queue.
`static interface`	`CfnGameSessionQueue.FilterConfigurationProperty` A list of fleet locations where a game session queue can place new game sessions.
`static interface`	`CfnGameSessionQueue.PlayerLatencyPolicyProperty` The queue setting that determines the highest latency allowed for individual players when placing a game session.
`static interface`	`CfnGameSessionQueue.PriorityConfigurationProperty` Custom prioritization settings for use by a game session queue when placing new game sessions with available game servers.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnGameSessionQueue(Construct scope, java.lang.String id, CfnGameSessionQueueProps props)` Create a new `AWS::GameLift::GameSessionQueue`.
`protected`	`CfnGameSessionQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnGameSessionQueue(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The unique Amazon Resource Name (ARN) for the `GameSessionQueue` .
`java.lang.String`	`getAttrName()` A descriptive label that is associated with a game session queue.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getCustomEventData()` Information to be added to all events that are related to this game session queue.
`java.lang.Object`	`getDestinations()` A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
`java.lang.Object`	`getFilterConfiguration()` A list of locations where a queue is allowed to place new game sessions.
`java.lang.String`	`getName()` A descriptive label that is associated with game session queue.
`java.lang.String`	`getNotificationTarget()` An SNS topic ARN that is set up to receive game session placement notifications.
`java.lang.Object`	`getPlayerLatencyPolicies()` A set of policies that act as a sliding cap on player latency.
`java.lang.Object`	`getPriorityConfiguration()` Custom settings to use when prioritizing destinations and locations for game session placements.
`TagManager`	`getTags()` A list of labels to assign to the new game session queue resource.
`java.lang.Number`	`getTimeoutInSeconds()` The maximum time, in seconds, that a new game session placement request remains in the queue.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setCustomEventData(java.lang.String value)` Information to be added to all events that are related to this game session queue.
`void`	`setDestinations(IResolvable value)` A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
`void`	`setDestinations(java.util.List<java.lang.Object> value)` A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
`void`	`setFilterConfiguration(CfnGameSessionQueue.FilterConfigurationProperty value)` A list of locations where a queue is allowed to place new game sessions.
`void`	`setFilterConfiguration(IResolvable value)` A list of locations where a queue is allowed to place new game sessions.
`void`	`setName(java.lang.String value)` A descriptive label that is associated with game session queue.
`void`	`setNotificationTarget(java.lang.String value)` An SNS topic ARN that is set up to receive game session placement notifications.
`void`	`setPlayerLatencyPolicies(IResolvable value)` A set of policies that act as a sliding cap on player latency.
`void`	`setPlayerLatencyPolicies(java.util.List<java.lang.Object> value)` A set of policies that act as a sliding cap on player latency.
`void`	`setPriorityConfiguration(CfnGameSessionQueue.PriorityConfigurationProperty value)` Custom settings to use when prioritizing destinations and locations for game session placements.
`void`	`setPriorityConfiguration(IResolvable value)` Custom settings to use when prioritizing destinations and locations for game session placements.
`void`	`setTimeoutInSeconds(java.lang.Number value)` The maximum time, in seconds, that a new game session placement request remains in the queue.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnGameSessionQueue
```
protected CfnGameSessionQueue(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnGameSessionQueue
```
protected CfnGameSessionQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnGameSessionQueue
```
public CfnGameSessionQueue(Construct scope,
                           java.lang.String id,
                           CfnGameSessionQueueProps props)
```
    Create a new `AWS::GameLift::GameSessionQueue`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The unique Amazon Resource Name (ARN) for the `GameSessionQueue` .
  - getAttrName
```
public java.lang.String getAttrName()
```
    A descriptive label that is associated with a game session queue.
    Names are unique within each Region.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    A list of labels to assign to the new game session queue resource.
    Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference . Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.
  - getName
```
public java.lang.String getName()
```
    A descriptive label that is associated with game session queue.
    Queue names must be unique within each Region.
  - setName
```
public void setName(java.lang.String value)
```
    A descriptive label that is associated with game session queue.
    Queue names must be unique within each Region.
  - getCustomEventData
```
public java.lang.String getCustomEventData()
```
    Information to be added to all events that are related to this game session queue.
  - setCustomEventData
```
public void setCustomEventData(java.lang.String value)
```
    Information to be added to all events that are related to this game session queue.
  - getDestinations
```
public java.lang.Object getDestinations()
```
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
    Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
  - setDestinations
```
public void setDestinations(IResolvable value)
```
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
    Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
  - setDestinations
```
public void setDestinations(java.util.List<java.lang.Object> value)
```
    A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
    Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
  - getFilterConfiguration
```
public java.lang.Object getFilterConfiguration()
```
    A list of locations where a queue is allowed to place new game sessions.
    Locations are specified in the form of AWS Region codes, such as us-west-2 . If this parameter is not set, game sessions can be placed in any queue location.
  - setFilterConfiguration
```
public void setFilterConfiguration(IResolvable value)
```
    A list of locations where a queue is allowed to place new game sessions.
    Locations are specified in the form of AWS Region codes, such as us-west-2 . If this parameter is not set, game sessions can be placed in any queue location.
  - setFilterConfiguration
```
public void setFilterConfiguration(CfnGameSessionQueue.FilterConfigurationProperty value)
```
    A list of locations where a queue is allowed to place new game sessions.
    Locations are specified in the form of AWS Region codes, such as us-west-2 . If this parameter is not set, game sessions can be placed in any queue location.
  - getNotificationTarget
```
public java.lang.String getNotificationTarget()
```
    An SNS topic ARN that is set up to receive game session placement notifications.
    See Setting up notifications for game session placement .
  - setNotificationTarget
```
public void setNotificationTarget(java.lang.String value)
```
    An SNS topic ARN that is set up to receive game session placement notifications.
    See Setting up notifications for game session placement .
  - getPlayerLatencyPolicies
```
public java.lang.Object getPlayerLatencyPolicies()
```
    A set of policies that act as a sliding cap on player latency.
    FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
  - setPlayerLatencyPolicies
```
public void setPlayerLatencyPolicies(IResolvable value)
```
    A set of policies that act as a sliding cap on player latency.
    FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
  - setPlayerLatencyPolicies
```
public void setPlayerLatencyPolicies(java.util.List<java.lang.Object> value)
```
    A set of policies that act as a sliding cap on player latency.
    FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value.
  - getPriorityConfiguration
```
public java.lang.Object getPriorityConfiguration()
```
    Custom settings to use when prioritizing destinations and locations for game session placements.
    This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
  - setPriorityConfiguration
```
public void setPriorityConfiguration(IResolvable value)
```
    Custom settings to use when prioritizing destinations and locations for game session placements.
    This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
  - setPriorityConfiguration
```
public void setPriorityConfiguration(CfnGameSessionQueue.PriorityConfigurationProperty value)
```
    Custom settings to use when prioritizing destinations and locations for game session placements.
    This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process.
  - getTimeoutInSeconds
```
public java.lang.Number getTimeoutInSeconds()
```
    The maximum time, in seconds, that a new game session placement request remains in the queue.
    When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
  - setTimeoutInSeconds
```
public void setTimeoutInSeconds(java.lang.Number value)
```
    The maximum time, in seconds, that a new game session placement request remains in the queue.
    When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

Class CfnGameSessionQueue

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnGameSessionQueue

CfnGameSessionQueue

CfnGameSessionQueue

Method Detail

inspect

renderProperties

getAttrArn

getAttrName

getCfnProperties

getTags

getName

setName

getCustomEventData

setCustomEventData

getDestinations

setDestinations

setDestinations

getFilterConfiguration

setFilterConfiguration

setFilterConfiguration

getNotificationTarget

setNotificationTarget

getPlayerLatencyPolicies

setPlayerLatencyPolicies

setPlayerLatencyPolicies

getPriorityConfiguration

setPriorityConfiguration

setPriorityConfiguration

getTimeoutInSeconds

setTimeoutInSeconds