Class CfnGameSessionQueue
The AWS::GameLift::GameSessionQueue
resource creates a placement queue that processes requests for new game sessions.
Inherited Members
Namespace: Amazon.CDK.AWS.GameLift
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGameSessionQueue : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnGameSessionQueue
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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 .
CloudformationResource: AWS::GameLift::GameSessionQueue
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 cfnGameSessionQueue = new CfnGameSessionQueue(this, "MyCfnGameSessionQueue", 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
CfnGameSessionQueue(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnGameSessionQueue(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnGameSessionQueue(Construct, String, ICfnGameSessionQueueProps) |
Properties
AttrArn | The unique Amazon Resource Name (ARN) for the |
AttrName | A descriptive label that is associated with a game session queue. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 act as a sliding cap on player latency. |
PriorityConfiguration | Custom settings to use when prioritizing destinations and locations for game session placements. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnGameSessionQueue(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnGameSessionQueue(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnGameSessionQueue(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnGameSessionQueue(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnGameSessionQueue(Construct, String, ICfnGameSessionQueueProps)
public CfnGameSessionQueue(Construct scope, string id, ICfnGameSessionQueueProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnGameSessionQueueProps
Resource properties.
Properties
AttrArn
The unique Amazon Resource Name (ARN) for the GameSessionQueue
.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrName
A descriptive label that is associated with a game session queue.
public virtual string AttrName { get; }
Property Value
System.String
Remarks
Names are unique within each Region.
CloudformationAttribute: Name
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CustomEventData
Information to be added to all events that are related to this game session queue.
public virtual string CustomEventData { get; set; }
Property Value
System.String
Destinations
A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
public virtual object Destinations { get; set; }
Property Value
System.Object
FilterConfiguration
A list of locations where a queue is allowed to place new game sessions.
public virtual object FilterConfiguration { get; set; }
Property Value
System.Object
Name
A descriptive label that is associated with game session queue.
public virtual string Name { get; set; }
Property Value
System.String
NotificationTarget
An SNS topic ARN that is set up to receive game session placement notifications.
public virtual string NotificationTarget { get; set; }
Property Value
System.String
PlayerLatencyPolicies
A set of policies that act as a sliding cap on player latency.
public virtual object PlayerLatencyPolicies { get; set; }
Property Value
System.Object
PriorityConfiguration
Custom settings to use when prioritizing destinations and locations for game session placements.
public virtual object PriorityConfiguration { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
A list of labels to assign to the new game session queue resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
TimeoutInSeconds
The maximum time, in seconds, that a new game session placement request remains in the queue.
public virtual Nullable<double> TimeoutInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>