Class: AWSCDK::GameLift::CfnGameSessionQueue

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSGamelift::IGameSessionQueueRef
Defined in:
game_lift/cfn_game_session_queue.rb

Overview

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 .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnGameSessionQueue

Create a new AWS::GameLift::GameSessionQueue.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::GameLift::CfnGameSessionQueueProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'game_lift/cfn_game_session_queue.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::GameLift::CfnGameSessionQueueProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuR2FtZVNlc3Npb25RdWV1ZVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_game_session_queue(resource) ⇒ String

Parameters:

Returns:

  • (String) 


83
84
85
86
 
# File 'game_lift/cfn_game_session_queue.rb', line 83

def self.arn_for_game_session_queue(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19nYW1lbGlmdC5JR2FtZVNlc3Npb25RdWV1ZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnGameSessionQueue", "arnForGameSessionQueue", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


216
217
218
 
# File 'game_lift/cfn_game_session_queue.rb', line 216

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_gamelift.CfnGameSessionQueue", "CFN_RESOURCE_TYPE_NAME")
end

.from_game_session_queue_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSGamelift::IGameSessionQueueRef

Creates a new IGameSessionQueueRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



94
95
96
97
98
99
 
# File 'game_lift/cfn_game_session_queue.rb', line 94

def self.from_game_session_queue_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnGameSessionQueue", "fromGameSessionQueueArn", [scope, id, arn])
end

.from_game_session_queue_name(scope, id, game_session_queue_name) ⇒ AWSCDK::Interfaces::AWSGamelift::IGameSessionQueueRef

Creates a new IGameSessionQueueRef from a gameSessionQueueName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • game_session_queue_name (String)

Returns:



107
108
109
110
111
112
 
# File 'game_lift/cfn_game_session_queue.rb', line 107

def self.from_game_session_queue_name(scope, id, game_session_queue_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(game_session_queue_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gameSessionQueueName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnGameSessionQueue", "fromGameSessionQueueName", [scope, id, game_session_queue_name])
end

.is_cfn_game_session_queue(x) ⇒ Boolean

Checks whether the given object is a CfnGameSessionQueue.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


118
119
120
121
 
# File 'game_lift/cfn_game_session_queue.rb', line 118

def self.is_cfn_game_session_queue(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnGameSessionQueue", "isCfnGameSessionQueue", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'game_lift/cfn_game_session_queue.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :game_session_queue_ref => { kind: :property, name: "gameSessionQueueRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :custom_event_data => { kind: :property, name: "customEventData", is_optional: true },
    :destinations => { kind: :property, name: "destinations", is_optional: true },
    :filter_configuration => { kind: :property, name: "filterConfiguration", is_optional: true },
    :notification_target => { kind: :property, name: "notificationTarget", is_optional: true },
    :player_latency_policies => { kind: :property, name: "playerLatencyPolicies", is_optional: true },
    :priority_configuration => { kind: :property, name: "priorityConfiguration", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :timeout_in_seconds => { kind: :property, name: "timeoutInSeconds", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



397
398
399
400
 
# File 'game_lift/cfn_game_session_queue.rb', line 397

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



409
410
411
412
 
# File 'game_lift/cfn_game_session_queue.rb', line 409

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



419
420
421
422
 
# File 'game_lift/cfn_game_session_queue.rb', line 419

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



430
431
432
433
434
 
# File 'game_lift/cfn_game_session_queue.rb', line 430

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


487
488
489
490
491
 
# File 'game_lift/cfn_game_session_queue.rb', line 487

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



497
498
499
500
 
# File 'game_lift/cfn_game_session_queue.rb', line 497

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



509
510
511
512
513
 
# File 'game_lift/cfn_game_session_queue.rb', line 509

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



522
523
524
525
 
# File 'game_lift/cfn_game_session_queue.rb', line 522

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



544
545
546
547
548
549
 
# File 'game_lift/cfn_game_session_queue.rb', line 544

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The unique Amazon Resource Name (ARN) for the GameSessionQueue .

Returns:

  • (String) 


223
224
225
 
# File 'game_lift/cfn_game_session_queue.rb', line 223

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_name ⇒ String

A descriptive label that is associated with a game session queue.

Names are unique within each Region.

Returns:

  • (String) 


232
233
234
 
# File 'game_lift/cfn_game_session_queue.rb', line 232

def attr_name()
  jsii_get_property("attrName")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



169
170
171
 
# File 'game_lift/cfn_game_session_queue.rb', line 169

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


174
175
176
 
# File 'game_lift/cfn_game_session_queue.rb', line 174

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


553
554
555
556
 
# File 'game_lift/cfn_game_session_queue.rb', line 553

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


179
180
181
 
# File 'game_lift/cfn_game_session_queue.rb', line 179

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


186
187
188
 
# File 'game_lift/cfn_game_session_queue.rb', line 186

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


131
132
133
 
# File 'game_lift/cfn_game_session_queue.rb', line 131

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_event_data ⇒ String?

Information to be added to all events that are related to this game session queue.

Returns:

  • (String, nil) 


265
266
267
 
# File 'game_lift/cfn_game_session_queue.rb', line 265

def custom_event_data()
  jsii_get_property("customEventData")
end

#custom_event_data=(value) ⇒ Object 



269
270
271
272
 
# File 'game_lift/cfn_game_session_queue.rb', line 269

def custom_event_data=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customEventData") unless value.nil?
  jsii_set_property("customEventData", value)
end

#destinations ⇒ AWSCDK::IResolvable, ...

A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.

Returns:



277
278
279
 
# File 'game_lift/cfn_game_session_queue.rb', line 277

def destinations()
  jsii_get_property("destinations")
end

#destinations=(value) ⇒ Object 



281
282
283
284
 
# File 'game_lift/cfn_game_session_queue.rb', line 281

def destinations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuR2FtZVNlc3Npb25RdWV1ZS5EZXN0aW5hdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "destinations") unless value.nil?
  jsii_set_property("destinations", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



191
192
193
 
# File 'game_lift/cfn_game_session_queue.rb', line 191

def env()
  jsii_get_property("env")
end

#filter_configuration ⇒ AWSCDK::IResolvable, ...

A list of locations where a queue is allowed to place new game sessions.

Returns:



289
290
291
 
# File 'game_lift/cfn_game_session_queue.rb', line 289

def filter_configuration()
  jsii_get_property("filterConfiguration")
end

#filter_configuration=(value) ⇒ Object 



293
294
295
296
297
 
# File 'game_lift/cfn_game_session_queue.rb', line 293

def filter_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GameLift::CfnGameSessionQueue::FilterConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5HYW1lU2Vzc2lvblF1ZXVlLkZpbHRlckNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "filterConfiguration") unless value.nil?
  jsii_set_property("filterConfiguration", value)
end

#game_session_queue_ref ⇒ AWSCDK::Interfaces::AWSGamelift::GameSessionQueueReference

A reference to a GameSessionQueue resource.

Returns:



239
240
241
 
# File 'game_lift/cfn_game_session_queue.rb', line 239

def game_session_queue_ref()
  jsii_get_property("gameSessionQueueRef")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



566
567
568
569
570
 
# File 'game_lift/cfn_game_session_queue.rb', line 566

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



577
578
579
580
 
# File 'game_lift/cfn_game_session_queue.rb', line 577

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



647
648
649
650
 
# File 'game_lift/cfn_game_session_queue.rb', line 647

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


143
144
145
 
# File 'game_lift/cfn_game_session_queue.rb', line 143

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

A descriptive label that is associated with game session queue.

Returns:

  • (String) 


253
254
255
 
# File 'game_lift/cfn_game_session_queue.rb', line 253

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



257
258
259
260
 
# File 'game_lift/cfn_game_session_queue.rb', line 257

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


126
127
128
 
# File 'game_lift/cfn_game_session_queue.rb', line 126

def node()
  jsii_get_property("node")
end

#notification_target ⇒ String?

An SNS topic ARN that is set up to receive game session placement notifications.

Returns:

  • (String, nil) 


302
303
304
 
# File 'game_lift/cfn_game_session_queue.rb', line 302

def notification_target()
  jsii_get_property("notificationTarget")
end

#notification_target=(value) ⇒ Object 



306
307
308
309
 
# File 'game_lift/cfn_game_session_queue.rb', line 306

def notification_target=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notificationTarget") unless value.nil?
  jsii_set_property("notificationTarget", value)
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



588
589
590
 
# File 'game_lift/cfn_game_session_queue.rb', line 588

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



595
596
597
 
# File 'game_lift/cfn_game_session_queue.rb', line 595

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



388
389
390
391
 
# File 'game_lift/cfn_game_session_queue.rb', line 388

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#player_latency_policies ⇒ AWSCDK::IResolvable, ...

A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.

Returns:



314
315
316
 
# File 'game_lift/cfn_game_session_queue.rb', line 314

def player_latency_policies()
  jsii_get_property("playerLatencyPolicies")
end

#player_latency_policies=(value) ⇒ Object 



318
319
320
321
 
# File 'game_lift/cfn_game_session_queue.rb', line 318

def player_latency_policies=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuR2FtZVNlc3Npb25RdWV1ZS5QbGF5ZXJMYXRlbmN5UG9saWN5UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "playerLatencyPolicies") unless value.nil?
  jsii_set_property("playerLatencyPolicies", value)
end

#priority_configuration ⇒ AWSCDK::IResolvable, ...

Custom settings to use when prioritizing destinations and locations for game session placements.

Returns:



326
327
328
 
# File 'game_lift/cfn_game_session_queue.rb', line 326

def priority_configuration()
  jsii_get_property("priorityConfiguration")
end

#priority_configuration=(value) ⇒ Object 



330
331
332
333
334
 
# File 'game_lift/cfn_game_session_queue.rb', line 330

def priority_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GameLift::CfnGameSessionQueue::PriorityConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5HYW1lU2Vzc2lvblF1ZXVlLlByaW9yaXR5Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "priorityConfiguration") unless value.nil?
  jsii_set_property("priorityConfiguration", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


162
163
164
 
# File 'game_lift/cfn_game_session_queue.rb', line 162

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



606
607
608
609
 
# File 'game_lift/cfn_game_session_queue.rb', line 606

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


613
614
615
616
 
# File 'game_lift/cfn_game_session_queue.rb', line 613

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



623
624
625
626
627
 
# File 'game_lift/cfn_game_session_queue.rb', line 623

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



632
633
634
 
# File 'game_lift/cfn_game_session_queue.rb', line 632

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



152
153
154
 
# File 'game_lift/cfn_game_session_queue.rb', line 152

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



246
247
248
 
# File 'game_lift/cfn_game_session_queue.rb', line 246

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A list of labels to assign to the new game session queue resource.

Returns:



339
340
341
 
# File 'game_lift/cfn_game_session_queue.rb', line 339

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



343
344
345
346
347
 
# File 'game_lift/cfn_game_session_queue.rb', line 343

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#timeout_in_seconds ⇒ Numeric?

The maximum time, in seconds, that a new game session placement request remains in the queue.

Returns:

  • (Numeric, nil) 


352
353
354
 
# File 'game_lift/cfn_game_session_queue.rb', line 352

def timeout_in_seconds()
  jsii_get_property("timeoutInSeconds")
end

#timeout_in_seconds=(value) ⇒ Object 



356
357
358
359
 
# File 'game_lift/cfn_game_session_queue.rb', line 356

def timeout_in_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "timeoutInSeconds") unless value.nil?
  jsii_set_property("timeoutInSeconds", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



364
365
366
 
# File 'game_lift/cfn_game_session_queue.rb', line 364

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


199
200
201
 
# File 'game_lift/cfn_game_session_queue.rb', line 199

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


209
210
211
 
# File 'game_lift/cfn_game_session_queue.rb', line 209

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


638
639
640
641
 
# File 'game_lift/cfn_game_session_queue.rb', line 638

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


377
378
379
380
381
382
 
# File 'game_lift/cfn_game_session_queue.rb', line 377

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end