@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:39.486Z") @Stability(value=Stable) public class CfnGameSessionQueue extends CfnResource implements IInspectable
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();
| 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.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnGameSessionQueue(software.constructs.Construct scope,
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) |
| Modifier and Type | Method and Description |
|---|---|
String |
getAttrArn()
The unique Amazon Resource Name (ARN) for the `GameSessionQueue` .
|
String |
getAttrName()
A descriptive label that is associated with a game session queue.
|
protected Map<String,Object> |
getCfnProperties() |
String |
getCustomEventData()
Information to be added to all events that are related to this game session queue.
|
Object |
getDestinations()
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
|
Object |
getFilterConfiguration()
A list of locations where a queue is allowed to place new game sessions.
|
String |
getName()
A descriptive label that is associated with game session queue.
|
String |
getNotificationTarget()
An SNS topic ARN that is set up to receive game session placement notifications.
|
Object |
getPlayerLatencyPolicies()
A set of policies that act as a sliding cap on player latency.
|
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.
|
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 Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setCustomEventData(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(List<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(String value)
A descriptive label that is associated with game session queue.
|
void |
setNotificationTarget(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(List<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(Number value)
The maximum time, in seconds, that a new game session placement request remains in the queue.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnGameSessionQueue(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnGameSessionQueue(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnGameSessionQueue(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnGameSessionQueueProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
@Stability(value=Stable) @NotNull public String getAttrName()
Names are unique within each Region.
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
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.
@Stability(value=Stable) @NotNull public String getName()
Queue names must be unique within each Region.
@Stability(value=Stable)
public void setName(@NotNull
String value)
Queue names must be unique within each Region.
@Stability(value=Stable) @Nullable public String getCustomEventData()
@Stability(value=Stable)
public void setCustomEventData(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getDestinations()
Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
@Stability(value=Stable)
public void setDestinations(@Nullable
IResolvable value)
Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
@Stability(value=Stable)
public void setDestinations(@Nullable
List<Object> value)
Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
@Stability(value=Stable) @Nullable public Object getFilterConfiguration()
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.
@Stability(value=Stable)
public void setFilterConfiguration(@Nullable
CfnGameSessionQueue.FilterConfigurationProperty value)
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.
@Stability(value=Stable)
public void setFilterConfiguration(@Nullable
IResolvable value)
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.
@Stability(value=Stable) @Nullable public String getNotificationTarget()
@Stability(value=Stable)
public void setNotificationTarget(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getPlayerLatencyPolicies()
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.
@Stability(value=Stable)
public void setPlayerLatencyPolicies(@Nullable
IResolvable value)
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.
@Stability(value=Stable)
public void setPlayerLatencyPolicies(@Nullable
List<Object> value)
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.
@Stability(value=Stable) @Nullable public Object getPriorityConfiguration()
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.
@Stability(value=Stable)
public void setPriorityConfiguration(@Nullable
CfnGameSessionQueue.PriorityConfigurationProperty value)
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.
@Stability(value=Stable)
public void setPriorityConfiguration(@Nullable
IResolvable value)
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.
@Stability(value=Stable) @Nullable public Number getTimeoutInSeconds()
When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
@Stability(value=Stable)
public void setTimeoutInSeconds(@Nullable
Number value)
When a request exceeds this time, the game session placement changes to a TIMED_OUT status.
Copyright © 2022. All rights reserved.