Class: AWSCDK::GameLift::CfnGameServerGroup

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

Overview

This operation is used with the Amazon GameLift FleetIQ solution and game server groups..

Creates a GameLift FleetIQ game server group for managing game hosting on a collection of Amazon EC2 instances for game hosting. This operation creates the game server group, creates an Auto Scaling group in your AWS account , and establishes a link between the two groups. You can view the status of your game server groups in the GameLift console. Game server group metrics and events are emitted to Amazon CloudWatch.

Before creating a new game server group, you must have the following:

  • An Amazon EC2 launch template that specifies how to launch Amazon EC2 instances with your game server build. For more information, see Launching an Instance from a Launch Template in the Amazon EC2 User Guide .
  • An IAM role that extends limited access to your AWS account to allow GameLift FleetIQ to create and interact with the Auto Scaling group. For more information, see Create IAM roles for cross-service interaction in the GameLift FleetIQ Developer Guide .

To create a new game server group, specify a unique group name, IAM role and Amazon EC2 launch template, and provide a list of instance types that can be used in the group. You must also set initial maximum and minimum limits on the group's instance count. You can optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ metric.

Once the game server group and corresponding Auto Scaling group are created, you have full access to change the Auto Scaling group's configuration as needed. Several properties that are set when creating a game server group, including maximum/minimum size and auto-scaling policy settings, must be updated directly in the Auto Scaling group. Keep in mind that some Auto Scaling group properties are periodically updated by GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.

Learn more

GameLift FleetIQ Guide

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnGameServerGroup

Create a new AWS::GameLift::GameServerGroup.

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::CfnGameServerGroupProps) —

    Resource properties.



33
34
35
36
37
38
39
 
# File 'game_lift/cfn_game_server_group.rb', line 33

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::GameLift::CfnGameServerGroupProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuR2FtZVNlcnZlckdyb3VwUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_game_server_group(resource) ⇒ String

Parameters:

Returns:

  • (String) 


99
100
101
102
 
# File 'game_lift/cfn_game_server_group.rb', line 99

def self.arn_for_game_server_group(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19nYW1lbGlmdC5JR2FtZVNlcnZlckdyb3VwUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnGameServerGroup", "arnForGameServerGroup", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


206
207
208
 
# File 'game_lift/cfn_game_server_group.rb', line 206

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

.is_cfn_game_server_group(x) ⇒ Boolean

Checks whether the given object is a CfnGameServerGroup.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


108
109
110
111
 
# File 'game_lift/cfn_game_server_group.rb', line 108

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

.jsii_overridable_methods ⇒ Object 



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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'game_lift/cfn_game_server_group.rb', line 41

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_auto_scaling_group_arn => { kind: :property, name: "attrAutoScalingGroupArn", is_optional: false },
    :attr_game_server_group_arn => { kind: :property, name: "attrGameServerGroupArn", is_optional: false },
    :game_server_group_ref => { kind: :property, name: "gameServerGroupRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :game_server_group_name => { kind: :property, name: "gameServerGroupName", is_optional: false },
    :instance_definitions => { kind: :property, name: "instanceDefinitions", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :auto_scaling_policy => { kind: :property, name: "autoScalingPolicy", is_optional: true },
    :balancing_strategy => { kind: :property, name: "balancingStrategy", is_optional: true },
    :delete_option => { kind: :property, name: "deleteOption", is_optional: true },
    :game_server_protection_policy => { kind: :property, name: "gameServerProtectionPolicy", is_optional: true },
    :launch_template => { kind: :property, name: "launchTemplate", is_optional: true },
    :max_size => { kind: :property, name: "maxSize", is_optional: true },
    :min_size => { kind: :property, name: "minSize", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :vpc_subnets => { kind: :property, name: "vpcSubnets", 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.



421
422
423
424
 
# File 'game_lift/cfn_game_server_group.rb', line 421

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:



433
434
435
436
 
# File 'game_lift/cfn_game_server_group.rb', line 433

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:



443
444
445
446
 
# File 'game_lift/cfn_game_server_group.rb', line 443

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:



454
455
456
457
458
 
# File 'game_lift/cfn_game_server_group.rb', line 454

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.


511
512
513
514
515
 
# File 'game_lift/cfn_game_server_group.rb', line 511

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.



521
522
523
524
 
# File 'game_lift/cfn_game_server_group.rb', line 521

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.



533
534
535
536
537
 
# File 'game_lift/cfn_game_server_group.rb', line 533

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:



546
547
548
549
 
# File 'game_lift/cfn_game_server_group.rb', line 546

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:



568
569
570
571
572
573
 
# File 'game_lift/cfn_game_server_group.rb', line 568

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_auto_scaling_group_arn ⇒ String

A unique identifier for the auto scaling group.

Returns:

  • (String) 


213
214
215
 
# File 'game_lift/cfn_game_server_group.rb', line 213

def attr_auto_scaling_group_arn()
  jsii_get_property("attrAutoScalingGroupArn")
end

#attr_game_server_group_arn ⇒ String

A unique identifier for the game server group.

Returns:

  • (String) 


220
221
222
 
# File 'game_lift/cfn_game_server_group.rb', line 220

def attr_game_server_group_arn()
  jsii_get_property("attrGameServerGroupArn")
end

#auto_scaling_policy ⇒ AWSCDK::IResolvable, ...

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.

Returns:



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

def auto_scaling_policy()
  jsii_get_property("autoScalingPolicy")
end

#auto_scaling_policy=(value) ⇒ Object 



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

def auto_scaling_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GameLift::CfnGameServerGroup::AutoScalingPolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5HYW1lU2VydmVyR3JvdXAuQXV0b1NjYWxpbmdQb2xpY3lQcm9wZXJ0eSJ9XX19")), "autoScalingPolicy") unless value.nil?
  jsii_set_property("autoScalingPolicy", value)
end

#balancing_strategy ⇒ String?

Indicates how Amazon GameLift Servers FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.

Returns:

  • (String, nil) 


290
291
292
 
# File 'game_lift/cfn_game_server_group.rb', line 290

def balancing_strategy()
  jsii_get_property("balancingStrategy")
end

#balancing_strategy=(value) ⇒ Object 



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

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



159
160
161
 
# File 'game_lift/cfn_game_server_group.rb', line 159

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


164
165
166
 
# File 'game_lift/cfn_game_server_group.rb', line 164

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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}) 


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


176
177
178
 
# File 'game_lift/cfn_game_server_group.rb', line 176

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


121
122
123
 
# File 'game_lift/cfn_game_server_group.rb', line 121

def creation_stack()
  jsii_get_property("creationStack")
end

#delete_option ⇒ String?

The type of delete to perform.

Returns:

  • (String, nil) 


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

def delete_option()
  jsii_get_property("deleteOption")
end

#delete_option=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



181
182
183
 
# File 'game_lift/cfn_game_server_group.rb', line 181

def env()
  jsii_get_property("env")
end

#game_server_group_name ⇒ String

A developer-defined identifier for the game server group.

Returns:

  • (String) 


241
242
243
 
# File 'game_lift/cfn_game_server_group.rb', line 241

def game_server_group_name()
  jsii_get_property("gameServerGroupName")
end

#game_server_group_name=(value) ⇒ Object 



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

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

#game_server_group_ref ⇒ AWSCDK::Interfaces::AWSGamelift::GameServerGroupReference

A reference to a GameServerGroup resource.

Returns:



227
228
229
 
# File 'game_lift/cfn_game_server_group.rb', line 227

def game_server_group_ref()
  jsii_get_property("gameServerGroupRef")
end

#game_server_protection_policy ⇒ String?

A flag that indicates whether instances in the game server group are protected from early termination.

Returns:

  • (String, nil) 


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

def game_server_protection_policy()
  jsii_get_property("gameServerProtectionPolicy")
end

#game_server_protection_policy=(value) ⇒ Object 



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

def game_server_protection_policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gameServerProtectionPolicy") unless value.nil?
  jsii_set_property("gameServerProtectionPolicy", value)
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:



590
591
592
593
594
 
# File 'game_lift/cfn_game_server_group.rb', line 590

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:



601
602
603
604
 
# File 'game_lift/cfn_game_server_group.rb', line 601

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:



671
672
673
674
 
# File 'game_lift/cfn_game_server_group.rb', line 671

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

#instance_definitions ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::GameLift::CfnGameServerGroup::InstanceDefinitionProperty>

The set of Amazon EC2 instance types that Amazon GameLift Servers FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Returns:



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

def instance_definitions()
  jsii_get_property("instanceDefinitions")
end

#instance_definitions=(value) ⇒ Object 



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

def instance_definitions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZ2FtZWxpZnQuQ2ZuR2FtZVNlcnZlckdyb3VwLkluc3RhbmNlRGVmaW5pdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "instanceDefinitions")
  jsii_set_property("instanceDefinitions", value)
end

#launch_template ⇒ AWSCDK::IResolvable, ...

The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.

Returns:



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

def launch_template()
  jsii_get_property("launchTemplate")
end

#launch_template=(value) ⇒ Object 



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

def launch_template=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GameLift::CfnGameServerGroup::LaunchTemplateProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5HYW1lU2VydmVyR3JvdXAuTGF1bmNoVGVtcGxhdGVQcm9wZXJ0eSJ9XX19")), "launchTemplate") unless value.nil?
  jsii_set_property("launchTemplate", value)
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) 


133
134
135
 
# File 'game_lift/cfn_game_server_group.rb', line 133

def logical_id()
  jsii_get_property("logicalId")
end

#max_size ⇒ Numeric?

The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.

Returns:

  • (Numeric, nil) 


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

def max_size()
  jsii_get_property("maxSize")
end

#max_size=(value) ⇒ Object 



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

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

#min_size ⇒ Numeric?

The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.

Returns:

  • (Numeric, nil) 


351
352
353
 
# File 'game_lift/cfn_game_server_group.rb', line 351

def min_size()
  jsii_get_property("minSize")
end

#min_size=(value) ⇒ Object 



355
356
357
358
 
# File 'game_lift/cfn_game_server_group.rb', line 355

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


116
117
118
 
# File 'game_lift/cfn_game_server_group.rb', line 116

def node()
  jsii_get_property("node")
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:



612
613
614
 
# File 'game_lift/cfn_game_server_group.rb', line 612

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:



619
620
621
 
# File 'game_lift/cfn_game_server_group.rb', line 619

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.



412
413
414
415
 
# File 'game_lift/cfn_game_server_group.rb', line 412

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

#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) 


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

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:



630
631
632
633
 
# File 'game_lift/cfn_game_server_group.rb', line 630

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}) 


637
638
639
640
 
# File 'game_lift/cfn_game_server_group.rb', line 637

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:



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

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

#role_arn ⇒ String

The Amazon Resource Name ( ARN ) for an IAM role that allows Amazon GameLift Servers to access your Amazon EC2 Auto Scaling groups.

Returns:

  • (String) 


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

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



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

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", value)
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.



656
657
658
 
# File 'game_lift/cfn_game_server_group.rb', line 656

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:



142
143
144
 
# File 'game_lift/cfn_game_server_group.rb', line 142

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



234
235
236
 
# File 'game_lift/cfn_game_server_group.rb', line 234

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A list of labels to assign to the new game server group resource.

Returns:



363
364
365
 
# File 'game_lift/cfn_game_server_group.rb', line 363

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



367
368
369
370
371
 
# File 'game_lift/cfn_game_server_group.rb', line 367

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



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

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}) 


189
190
191
 
# File 'game_lift/cfn_game_server_group.rb', line 189

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}) 


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


662
663
664
665
 
# File 'game_lift/cfn_game_server_group.rb', line 662

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

#vpc_subnets ⇒ Array<String>?

A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

Returns:

  • (Array<String>, nil) 


376
377
378
 
# File 'game_lift/cfn_game_server_group.rb', line 376

def vpc_subnets()
  jsii_get_property("vpcSubnets")
end

#vpc_subnets=(value) ⇒ Object 



380
381
382
383
 
# File 'game_lift/cfn_game_server_group.rb', line 380

def vpc_subnets=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "vpcSubnets") unless value.nil?
  jsii_set_property("vpcSubnets", value)
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) 


401
402
403
404
405
406
 
# File 'game_lift/cfn_game_server_group.rb', line 401

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