Class CfnGameSessionQueueProps
Properties for defining a CfnGameSessionQueue.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGameSessionQueueProps : Object, ICfnGameSessionQueuePropsSyntax (vb)
Public Class CfnGameSessionQueueProps
Inherits Object
Implements ICfnGameSessionQueuePropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.GameLift;
var cfnGameSessionQueueProps = new CfnGameSessionQueueProps {
Name = "name",
// the properties below are optional
CustomEventData = "customEventData",
Destinations = new [] { new DestinationProperty {
DestinationArn = "destinationArn"
} },
FilterConfiguration = new FilterConfigurationProperty {
AllowedLocations = new [] { "allowedLocations" }
},
NotificationTarget = "notificationTarget",
PlayerLatencyPolicies = new [] { new PlayerLatencyPolicyProperty {
MaximumIndividualPlayerLatencyMilliseconds = 123,
PolicyDurationSeconds = 123
} },
PriorityConfiguration = new PriorityConfigurationProperty {
LocationOrder = new [] { "locationOrder" },
PriorityOrder = new [] { "priorityOrder" }
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TimeoutInSeconds = 123
};Synopsis
Constructors
| CfnGameSessionQueueProps() |
Properties
| CustomEventData | Information to be added to all events that are related to this game session queue. |
| Destinations | A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. |
| FilterConfiguration | A list of locations where a queue is allowed to place new game sessions. |
| Name | A descriptive label that is associated with game session queue. |
| NotificationTarget | An SNS topic ARN that is set up to receive game session placement notifications. |
| PlayerLatencyPolicies | A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. |
| PriorityConfiguration | Custom settings to use when prioritizing destinations and locations for game session placements. |
| Tags | A list of labels to assign to the new game session queue resource. |
| TimeoutInSeconds | The maximum time, in seconds, that a new game session placement request remains in the queue. |
Constructors
CfnGameSessionQueueProps()
public CfnGameSessionQueueProps()Properties
CustomEventData
Information to be added to all events that are related to this game session queue.
public string CustomEventData { get; set; }Property Value
System.String
Remarks
Destinations
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
public object Destinations { get; set; }Property Value
System.Object
Remarks
Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference.
FilterConfiguration
A list of locations where a queue is allowed to place new game sessions.
public object FilterConfiguration { get; set; }Property Value
System.Object
Remarks
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.
Name
A descriptive label that is associated with game session queue.
public string Name { get; set; }Property Value
System.String
Remarks
Queue names must be unique within each Region.
NotificationTarget
An SNS topic ARN that is set up to receive game session placement notifications.
public string NotificationTarget { get; set; }Property Value
System.String
Remarks
PlayerLatencyPolicies
A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.
public object PlayerLatencyPolicies { get; set; }Property Value
System.Object
Remarks
Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value.
PriorityConfiguration
Custom settings to use when prioritizing destinations and locations for game session placements.
public object PriorityConfiguration { get; set; }Property Value
System.Object
Remarks
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.
Tags
A list of labels to assign to the new game session queue resource.
public ICfnTag[] Tags { get; set; }Property Value
ICfnTag[]
Remarks
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.
TimeoutInSeconds
The maximum time, in seconds, that a new game session placement request remains in the queue.
public Nullable<double> TimeoutInSeconds { get; set; }Property Value
System.Nullable<System.Double>
Remarks
When a request exceeds this time, the game session placement changes to a TIMED_OUT status. If you don't specify a request timeout, the queue uses a default value.