software.amazon.awscdk.services.gamelift

Class CfnGameSessionQueue

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.gamelift.CfnGameSessionQueue

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.744Z")
 @Stability(value=Stable)
public class CfnGameSessionQueue
extends CfnResource
implements IInspectable

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

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())
         .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 Example:
static interface	CfnGameSessionQueue.FilterConfigurationProperty Example:
static interface	CfnGameSessionQueue.PlayerLatencyPolicyProperty Example:
static interface	CfnGameSessionQueue.PriorityConfigurationProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrName()
protected Map<String,Object>	getCfnProperties()
String	getCustomEventData() `AWS::GameLift::GameSessionQueue.CustomEventData`.
Object	getDestinations() `AWS::GameLift::GameSessionQueue.Destinations`.
Object	getFilterConfiguration() `AWS::GameLift::GameSessionQueue.FilterConfiguration`.
String	getName() `AWS::GameLift::GameSessionQueue.Name`.
String	getNotificationTarget() `AWS::GameLift::GameSessionQueue.NotificationTarget`.
Object	getPlayerLatencyPolicies() `AWS::GameLift::GameSessionQueue.PlayerLatencyPolicies`.
Object	getPriorityConfiguration() `AWS::GameLift::GameSessionQueue.PriorityConfiguration`.
Number	getTimeoutInSeconds() `AWS::GameLift::GameSessionQueue.TimeoutInSeconds`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCustomEventData(String value) `AWS::GameLift::GameSessionQueue.CustomEventData`.
void	setDestinations(IResolvable value) `AWS::GameLift::GameSessionQueue.Destinations`.
void	setDestinations(List<Object> value) `AWS::GameLift::GameSessionQueue.Destinations`.
void	setFilterConfiguration(CfnGameSessionQueue.FilterConfigurationProperty value) `AWS::GameLift::GameSessionQueue.FilterConfiguration`.
void	setFilterConfiguration(IResolvable value) `AWS::GameLift::GameSessionQueue.FilterConfiguration`.
void	setName(String value) `AWS::GameLift::GameSessionQueue.Name`.
void	setNotificationTarget(String value) `AWS::GameLift::GameSessionQueue.NotificationTarget`.
void	setPlayerLatencyPolicies(IResolvable value) `AWS::GameLift::GameSessionQueue.PlayerLatencyPolicies`.
void	setPlayerLatencyPolicies(List<Object> value) `AWS::GameLift::GameSessionQueue.PlayerLatencyPolicies`.
void	setPriorityConfiguration(CfnGameSessionQueue.PriorityConfigurationProperty value) `AWS::GameLift::GameSessionQueue.PriorityConfiguration`.
void	setPriorityConfiguration(IResolvable value) `AWS::GameLift::GameSessionQueue.PriorityConfiguration`.
void	setTimeoutInSeconds(Number value) `AWS::GameLift::GameSessionQueue.TimeoutInSeconds`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnGameSessionQueue(@NotNull
                                                    software.constructs.Construct scope,
                                                    @NotNull
                                                    String id,
                                                    @NotNull
                                                    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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrName

@Stability(value=Stable)
 @NotNull
public String getAttrName()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCustomEventData

@Stability(value=Stable)
 @Nullable
public String getCustomEventData()

`AWS::GameLift::GameSessionQueue.CustomEventData`.

setCustomEventData

@Stability(value=Stable)
public void setCustomEventData(@Nullable
                                                        String value)

`AWS::GameLift::GameSessionQueue.CustomEventData`.

getDestinations

@Stability(value=Stable)
 @Nullable
public Object getDestinations()

`AWS::GameLift::GameSessionQueue.Destinations`.

setDestinations

@Stability(value=Stable)
public void setDestinations(@Nullable
                                                     IResolvable value)

`AWS::GameLift::GameSessionQueue.Destinations`.

setDestinations

@Stability(value=Stable)
public void setDestinations(@Nullable
                                                     List<Object> value)

`AWS::GameLift::GameSessionQueue.Destinations`.

getFilterConfiguration

@Stability(value=Stable)
 @Nullable
public Object getFilterConfiguration()

`AWS::GameLift::GameSessionQueue.FilterConfiguration`.

setFilterConfiguration

@Stability(value=Stable)
public void setFilterConfiguration(@Nullable
                                                            CfnGameSessionQueue.FilterConfigurationProperty value)

`AWS::GameLift::GameSessionQueue.FilterConfiguration`.

setFilterConfiguration

@Stability(value=Stable)
public void setFilterConfiguration(@Nullable
                                                            IResolvable value)

`AWS::GameLift::GameSessionQueue.FilterConfiguration`.

getName

@Stability(value=Stable)
 @NotNull
public String getName()

`AWS::GameLift::GameSessionQueue.Name`.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

`AWS::GameLift::GameSessionQueue.Name`.

getNotificationTarget

@Stability(value=Stable)
 @Nullable
public String getNotificationTarget()

`AWS::GameLift::GameSessionQueue.NotificationTarget`.

setNotificationTarget

@Stability(value=Stable)
public void setNotificationTarget(@Nullable
                                                           String value)

`AWS::GameLift::GameSessionQueue.NotificationTarget`.

getPlayerLatencyPolicies

@Stability(value=Stable)
 @Nullable
public Object getPlayerLatencyPolicies()

`AWS::GameLift::GameSessionQueue.PlayerLatencyPolicies`.

setPlayerLatencyPolicies

@Stability(value=Stable)
public void setPlayerLatencyPolicies(@Nullable
                                                              IResolvable value)

`AWS::GameLift::GameSessionQueue.PlayerLatencyPolicies`.

setPlayerLatencyPolicies

@Stability(value=Stable)
public void setPlayerLatencyPolicies(@Nullable
                                                              List<Object> value)

`AWS::GameLift::GameSessionQueue.PlayerLatencyPolicies`.

getPriorityConfiguration

@Stability(value=Stable)
 @Nullable
public Object getPriorityConfiguration()

`AWS::GameLift::GameSessionQueue.PriorityConfiguration`.

setPriorityConfiguration

@Stability(value=Stable)
public void setPriorityConfiguration(@Nullable
                                                              CfnGameSessionQueue.PriorityConfigurationProperty value)

`AWS::GameLift::GameSessionQueue.PriorityConfiguration`.

setPriorityConfiguration

@Stability(value=Stable)
public void setPriorityConfiguration(@Nullable
                                                              IResolvable value)

`AWS::GameLift::GameSessionQueue.PriorityConfiguration`.

getTimeoutInSeconds

@Stability(value=Stable)
 @Nullable
public Number getTimeoutInSeconds()

`AWS::GameLift::GameSessionQueue.TimeoutInSeconds`.

setTimeoutInSeconds

@Stability(value=Stable)
public void setTimeoutInSeconds(@Nullable
                                                         Number value)

`AWS::GameLift::GameSessionQueue.TimeoutInSeconds`.