Class: AWSCDK::GameLift::CfnFleet

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSGamelift::IFleetRef
Defined in:
game_lift/cfn_fleet.rb

Overview

The AWS::GameLift::Fleet resource creates an Amazon GameLift (GameLift) fleet to host custom game server or Realtime Servers.

A fleet is a set of EC2 instances, configured with instructions to run game servers on each instance.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFleet

Create a new AWS::GameLift::Fleet.

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

    Resource properties.



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

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

Class Method Details

.arn_for_fleet(resource) ⇒ String

Parameters:

Returns:

  • (String) 


104
105
106
107
 
# File 'game_lift/cfn_fleet.rb', line 104

def self.arn_for_fleet(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19nYW1lbGlmdC5JRmxlZXRSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnFleet", "arnForFleet", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


237
238
239
 
# File 'game_lift/cfn_fleet.rb', line 237

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

.from_fleet_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSGamelift::IFleetRef

Creates a new IFleetRef from an ARN.

Parameters:

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

Returns:



115
116
117
118
119
120
 
# File 'game_lift/cfn_fleet.rb', line 115

def self.from_fleet_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.CfnFleet", "fromFleetArn", [scope, id, arn])
end

.from_fleet_id(scope, id, fleet_id) ⇒ AWSCDK::Interfaces::AWSGamelift::IFleetRef

Creates a new IFleetRef from a fleetId.

Parameters:

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

Returns:



128
129
130
131
132
133
 
# File 'game_lift/cfn_fleet.rb', line 128

def self.from_fleet_id(scope, id, fleet_id)
  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(fleet_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fleetId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnFleet", "fromFleetId", [scope, id, fleet_id])
end

.is_cfn_fleet(x) ⇒ Boolean

Checks whether the given object is a CfnFleet.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


139
140
141
142
 
# File 'game_lift/cfn_fleet.rb', line 139

def self.is_cfn_fleet(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_gamelift.CfnFleet", "isCfnFleet", [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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'game_lift/cfn_fleet.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_fleet_arn => { kind: :property, name: "attrFleetArn", is_optional: false },
    :attr_fleet_id => { kind: :property, name: "attrFleetId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :fleet_ref => { kind: :property, name: "fleetRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :anywhere_configuration => { kind: :property, name: "anywhereConfiguration", is_optional: true },
    :apply_capacity => { kind: :property, name: "applyCapacity", is_optional: true },
    :build_id => { kind: :property, name: "buildId", is_optional: true },
    :certificate_configuration => { kind: :property, name: "certificateConfiguration", is_optional: true },
    :compute_type => { kind: :property, name: "computeType", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :desired_ec2_instances => { kind: :property, name: "desiredEc2Instances", is_optional: true },
    :ec2_inbound_permissions => { kind: :property, name: "ec2InboundPermissions", is_optional: true },
    :ec2_instance_type => { kind: :property, name: "ec2InstanceType", is_optional: true },
    :fleet_type => { kind: :property, name: "fleetType", is_optional: true },
    :instance_role_arn => { kind: :property, name: "instanceRoleArn", is_optional: true },
    :instance_role_credentials_provider => { kind: :property, name: "instanceRoleCredentialsProvider", is_optional: true },
    :locations => { kind: :property, name: "locations", is_optional: true },
    :log_paths => { kind: :property, name: "logPaths", is_optional: true },
    :max_size => { kind: :property, name: "maxSize", is_optional: true },
    :metric_groups => { kind: :property, name: "metricGroups", is_optional: true },
    :min_size => { kind: :property, name: "minSize", is_optional: true },
    :new_game_session_protection_policy => { kind: :property, name: "newGameSessionProtectionPolicy", is_optional: true },
    :peer_vpc_aws_account_id => { kind: :property, name: "peerVpcAwsAccountId", is_optional: true },
    :peer_vpc_id => { kind: :property, name: "peerVpcId", is_optional: true },
    :player_gateway_configuration => { kind: :property, name: "playerGatewayConfiguration", is_optional: true },
    :player_gateway_mode => { kind: :property, name: "playerGatewayMode", is_optional: true },
    :resource_creation_limit_policy => { kind: :property, name: "resourceCreationLimitPolicy", is_optional: true },
    :runtime_configuration => { kind: :property, name: "runtimeConfiguration", is_optional: true },
    :scaling_policies => { kind: :property, name: "scalingPolicies", is_optional: true },
    :script_id => { kind: :property, name: "scriptId", is_optional: true },
    :server_launch_parameters => { kind: :property, name: "serverLaunchParameters", is_optional: true },
    :server_launch_path => { kind: :property, name: "serverLaunchPath", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



677
678
679
680
 
# File 'game_lift/cfn_fleet.rb', line 677

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:



689
690
691
692
 
# File 'game_lift/cfn_fleet.rb', line 689

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:



699
700
701
702
 
# File 'game_lift/cfn_fleet.rb', line 699

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:



710
711
712
713
714
 
# File 'game_lift/cfn_fleet.rb', line 710

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.


767
768
769
770
771
 
# File 'game_lift/cfn_fleet.rb', line 767

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.



777
778
779
780
 
# File 'game_lift/cfn_fleet.rb', line 777

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.



789
790
791
792
793
 
# File 'game_lift/cfn_fleet.rb', line 789

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

#anywhere_configuration ⇒ AWSCDK::IResolvable, ...

Amazon GameLift Servers Anywhere configuration options.

Returns:



284
285
286
 
# File 'game_lift/cfn_fleet.rb', line 284

def anywhere_configuration()
  jsii_get_property("anywhereConfiguration")
end

#anywhere_configuration=(value) ⇒ Object 



288
289
290
291
292
 
# File 'game_lift/cfn_fleet.rb', line 288

def anywhere_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::AnywhereConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5Bbnl3aGVyZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "anywhereConfiguration") unless value.nil?
  jsii_set_property("anywhereConfiguration", value)
end

#apply_capacity ⇒ String?

Current resource capacity settings for managed EC2 fleets and managed container fleets.

Returns:

  • (String, nil) 


297
298
299
 
# File 'game_lift/cfn_fleet.rb', line 297

def apply_capacity()
  jsii_get_property("applyCapacity")
end

#apply_capacity=(value) ⇒ Object 



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

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



802
803
804
805
 
# File 'game_lift/cfn_fleet.rb', line 802

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:



824
825
826
827
828
829
 
# File 'game_lift/cfn_fleet.rb', line 824

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

The Amazon Resource Name ( ARN ) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . In a GameLift fleet ARN, the resource ID matches the FleetId value.

Returns:

  • (String) 


244
245
246
 
# File 'game_lift/cfn_fleet.rb', line 244

def attr_fleet_arn()
  jsii_get_property("attrFleetArn")
end

#attr_fleet_id ⇒ String

A unique identifier for the fleet.

Returns:

  • (String) 


251
252
253
 
# File 'game_lift/cfn_fleet.rb', line 251

def attr_fleet_id()
  jsii_get_property("attrFleetId")
end

#build_id ⇒ String?

A unique identifier for a build to be deployed on the new fleet.

Returns:

  • (String, nil) 


309
310
311
 
# File 'game_lift/cfn_fleet.rb', line 309

def build_id()
  jsii_get_property("buildId")
end

#build_id=(value) ⇒ Object 



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

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#certificate_configuration ⇒ AWSCDK::IResolvable, ...

Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet.

Returns:



321
322
323
 
# File 'game_lift/cfn_fleet.rb', line 321

def certificate_configuration()
  jsii_get_property("certificateConfiguration")
end

#certificate_configuration=(value) ⇒ Object 



325
326
327
328
329
 
# File 'game_lift/cfn_fleet.rb', line 325

def certificate_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::CertificateConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5DZXJ0aWZpY2F0ZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "certificateConfiguration") unless value.nil?
  jsii_set_property("certificateConfiguration", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



190
191
192
 
# File 'game_lift/cfn_fleet.rb', line 190

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


195
196
197
 
# File 'game_lift/cfn_fleet.rb', line 195

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


833
834
835
836
 
# File 'game_lift/cfn_fleet.rb', line 833

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


200
201
202
 
# File 'game_lift/cfn_fleet.rb', line 200

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


207
208
209
 
# File 'game_lift/cfn_fleet.rb', line 207

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#compute_type ⇒ String?

The type of compute resource used to host your game servers.

Returns:

  • (String, nil) 


334
335
336
 
# File 'game_lift/cfn_fleet.rb', line 334

def compute_type()
  jsii_get_property("computeType")
end

#compute_type=(value) ⇒ Object 



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

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description for the fleet.

Returns:

  • (String, nil) 


346
347
348
 
# File 'game_lift/cfn_fleet.rb', line 346

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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

#desired_ec2_instances ⇒ Numeric?

Deprecated.

this property has been deprecated

[DEPRECATED] The number of EC2 instances that you want this fleet to host.

Returns:

  • (Numeric, nil) 


359
360
361
 
# File 'game_lift/cfn_fleet.rb', line 359

def desired_ec2_instances()
  jsii_get_property("desiredEc2Instances")
end

#desired_ec2_instances=(value) ⇒ Object 



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

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

#ec2_inbound_permissions ⇒ AWSCDK::IResolvable, ...

The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet.

Returns:



371
372
373
 
# File 'game_lift/cfn_fleet.rb', line 371

def ec2_inbound_permissions()
  jsii_get_property("ec2InboundPermissions")
end

#ec2_inbound_permissions=(value) ⇒ Object 



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

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

#ec2_instance_type ⇒ String?

The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets.

Returns:

  • (String, nil) 


383
384
385
 
# File 'game_lift/cfn_fleet.rb', line 383

def ec2_instance_type()
  jsii_get_property("ec2InstanceType")
end

#ec2_instance_type=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



212
213
214
 
# File 'game_lift/cfn_fleet.rb', line 212

def env()
  jsii_get_property("env")
end

#fleet_ref ⇒ AWSCDK::Interfaces::AWSGamelift::FleetReference

A reference to a Fleet resource.

Returns:



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

def fleet_ref()
  jsii_get_property("fleetRef")
end

#fleet_type ⇒ String?

Indicates whether to use On-Demand or Spot instances for this fleet.

Returns:

  • (String, nil) 


395
396
397
 
# File 'game_lift/cfn_fleet.rb', line 395

def fleet_type()
  jsii_get_property("fleetType")
end

#fleet_type=(value) ⇒ Object 



399
400
401
402
 
# File 'game_lift/cfn_fleet.rb', line 399

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



846
847
848
849
850
 
# File 'game_lift/cfn_fleet.rb', line 846

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:



857
858
859
860
 
# File 'game_lift/cfn_fleet.rb', line 857

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:



927
928
929
930
 
# File 'game_lift/cfn_fleet.rb', line 927

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

#instance_role_arn ⇒ String?

A unique identifier for an IAM role that manages access to your AWS services.

Returns:

  • (String, nil) 


407
408
409
 
# File 'game_lift/cfn_fleet.rb', line 407

def instance_role_arn()
  jsii_get_property("instanceRoleArn")
end

#instance_role_arn=(value) ⇒ Object 



411
412
413
414
 
# File 'game_lift/cfn_fleet.rb', line 411

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

#instance_role_credentials_provider ⇒ String?

Indicates that fleet instances maintain a shared credentials file for the IAM role defined in InstanceRoleArn .

Returns:

  • (String, nil) 


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

def instance_role_credentials_provider()
  jsii_get_property("instanceRoleCredentialsProvider")
end

#instance_role_credentials_provider=(value) ⇒ Object 



423
424
425
426
 
# File 'game_lift/cfn_fleet.rb', line 423

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

#locations ⇒ AWSCDK::IResolvable, ...

A set of remote locations to deploy additional instances to and manage as a multi-location fleet.

Returns:



431
432
433
 
# File 'game_lift/cfn_fleet.rb', line 431

def locations()
  jsii_get_property("locations")
end

#locations=(value) ⇒ Object 



435
436
437
438
 
# File 'game_lift/cfn_fleet.rb', line 435

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

#log_paths ⇒ Array<String>?

Deprecated.

this property has been deprecated

This parameter is no longer used.

Returns:

  • (Array<String>, nil) 


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

def log_paths()
  jsii_get_property("logPaths")
end

#log_paths=(value) ⇒ Object 



448
449
450
451
 
# File 'game_lift/cfn_fleet.rb', line 448

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


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

def logical_id()
  jsii_get_property("logicalId")
end

#max_size ⇒ Numeric?

Deprecated.

this property has been deprecated

[DEPRECATED] The maximum value that is allowed for the fleet's instance count.

Returns:

  • (Numeric, nil) 


457
458
459
 
# File 'game_lift/cfn_fleet.rb', line 457

def max_size()
  jsii_get_property("maxSize")
end

#max_size=(value) ⇒ Object 



461
462
463
464
 
# File 'game_lift/cfn_fleet.rb', line 461

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

#metric_groups ⇒ Array<String>?

The name of an AWS CloudWatch metric group to add this fleet to.

Returns:

  • (Array<String>, nil) 


469
470
471
 
# File 'game_lift/cfn_fleet.rb', line 469

def metric_groups()
  jsii_get_property("metricGroups")
end

#metric_groups=(value) ⇒ Object 



473
474
475
476
 
# File 'game_lift/cfn_fleet.rb', line 473

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

#min_size ⇒ Numeric?

Deprecated.

this property has been deprecated

[DEPRECATED] The minimum value allowed for the fleet's instance count.

Returns:

  • (Numeric, nil) 


482
483
484
 
# File 'game_lift/cfn_fleet.rb', line 482

def min_size()
  jsii_get_property("minSize")
end

#min_size=(value) ⇒ Object 



486
487
488
489
 
# File 'game_lift/cfn_fleet.rb', line 486

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

#name ⇒ String

A descriptive label that is associated with a fleet.

Returns:

  • (String) 


272
273
274
 
# File 'game_lift/cfn_fleet.rb', line 272

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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

#new_game_session_protection_policy ⇒ String?

The status of termination protection for active game sessions on the fleet.

Returns:

  • (String, nil) 


494
495
496
 
# File 'game_lift/cfn_fleet.rb', line 494

def new_game_session_protection_policy()
  jsii_get_property("newGameSessionProtectionPolicy")
end

#new_game_session_protection_policy=(value) ⇒ Object 



498
499
500
501
 
# File 'game_lift/cfn_fleet.rb', line 498

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


147
148
149
 
# File 'game_lift/cfn_fleet.rb', line 147

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:



868
869
870
 
# File 'game_lift/cfn_fleet.rb', line 868

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:



875
876
877
 
# File 'game_lift/cfn_fleet.rb', line 875

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.



668
669
670
671
 
# File 'game_lift/cfn_fleet.rb', line 668

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

#peer_vpc_aws_account_id ⇒ String?

Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC.

Returns:

  • (String, nil) 


506
507
508
 
# File 'game_lift/cfn_fleet.rb', line 506

def ()
  jsii_get_property("peerVpcAwsAccountId")
end

#peer_vpc_aws_account_id=(value) ⇒ Object 



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

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

#peer_vpc_id ⇒ String?

A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet.

Returns:

  • (String, nil) 


518
519
520
 
# File 'game_lift/cfn_fleet.rb', line 518

def peer_vpc_id()
  jsii_get_property("peerVpcId")
end

#peer_vpc_id=(value) ⇒ Object 



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

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

#player_gateway_configuration ⇒ AWSCDK::IResolvable, ...

Configuration for player gateway.

Returns:



530
531
532
 
# File 'game_lift/cfn_fleet.rb', line 530

def player_gateway_configuration()
  jsii_get_property("playerGatewayConfiguration")
end

#player_gateway_configuration=(value) ⇒ Object 



534
535
536
537
538
 
# File 'game_lift/cfn_fleet.rb', line 534

def player_gateway_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::PlayerGatewayConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5QbGF5ZXJHYXRld2F5Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "playerGatewayConfiguration") unless value.nil?
  jsii_set_property("playerGatewayConfiguration", value)
end

#player_gateway_mode ⇒ String?

The player gateway mode for the fleet.

Returns:

  • (String, nil) 


543
544
545
 
# File 'game_lift/cfn_fleet.rb', line 543

def player_gateway_mode()
  jsii_get_property("playerGatewayMode")
end

#player_gateway_mode=(value) ⇒ Object 



547
548
549
550
 
# File 'game_lift/cfn_fleet.rb', line 547

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


183
184
185
 
# File 'game_lift/cfn_fleet.rb', line 183

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:



886
887
888
889
 
# File 'game_lift/cfn_fleet.rb', line 886

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


893
894
895
896
 
# File 'game_lift/cfn_fleet.rb', line 893

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:



903
904
905
906
907
 
# File 'game_lift/cfn_fleet.rb', line 903

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

#resource_creation_limit_policy ⇒ AWSCDK::IResolvable, ...

A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.

Returns:



555
556
557
 
# File 'game_lift/cfn_fleet.rb', line 555

def resource_creation_limit_policy()
  jsii_get_property("resourceCreationLimitPolicy")
end

#resource_creation_limit_policy=(value) ⇒ Object 



559
560
561
562
563
 
# File 'game_lift/cfn_fleet.rb', line 559

def resource_creation_limit_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::ResourceCreationLimitPolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5SZXNvdXJjZUNyZWF0aW9uTGltaXRQb2xpY3lQcm9wZXJ0eSJ9XX19")), "resourceCreationLimitPolicy") unless value.nil?
  jsii_set_property("resourceCreationLimitPolicy", value)
end

#runtime_configuration ⇒ AWSCDK::IResolvable, ...

Instructions for how to launch and maintain server processes on instances in the fleet.

Returns:



568
569
570
 
# File 'game_lift/cfn_fleet.rb', line 568

def runtime_configuration()
  jsii_get_property("runtimeConfiguration")
end

#runtime_configuration=(value) ⇒ Object 



572
573
574
575
576
 
# File 'game_lift/cfn_fleet.rb', line 572

def runtime_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::RuntimeConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5SdW50aW1lQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "runtimeConfiguration") unless value.nil?
  jsii_set_property("runtimeConfiguration", value)
end

#scaling_policies ⇒ AWSCDK::IResolvable, ...

Rule that controls how a fleet is scaled.

Returns:



581
582
583
 
# File 'game_lift/cfn_fleet.rb', line 581

def scaling_policies()
  jsii_get_property("scalingPolicies")
end

#scaling_policies=(value) ⇒ Object 



585
586
587
588
 
# File 'game_lift/cfn_fleet.rb', line 585

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

#script_id ⇒ String?

The unique identifier for a Realtime configuration script to be deployed on fleet instances.

Returns:

  • (String, nil) 


593
594
595
 
# File 'game_lift/cfn_fleet.rb', line 593

def script_id()
  jsii_get_property("scriptId")
end

#script_id=(value) ⇒ Object 



597
598
599
600
 
# File 'game_lift/cfn_fleet.rb', line 597

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

#server_launch_parameters ⇒ String?

Deprecated.

this property has been deprecated

This parameter is no longer used but is retained for backward compatibility.

Returns:

  • (String, nil) 


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

def server_launch_parameters()
  jsii_get_property("serverLaunchParameters")
end

#server_launch_parameters=(value) ⇒ Object 



610
611
612
613
 
# File 'game_lift/cfn_fleet.rb', line 610

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

#server_launch_path ⇒ String?

Deprecated.

this property has been deprecated

This parameter is no longer used.

Returns:

  • (String, nil) 


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

def server_launch_path()
  jsii_get_property("serverLaunchPath")
end

#server_launch_path=(value) ⇒ Object 



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

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



912
913
914
 
# File 'game_lift/cfn_fleet.rb', line 912

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:



173
174
175
 
# File 'game_lift/cfn_fleet.rb', line 173

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs to apply to this resource.

Returns:



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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



635
636
637
638
639
 
# File 'game_lift/cfn_fleet.rb', line 635

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



644
645
646
 
# File 'game_lift/cfn_fleet.rb', line 644

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


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

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


230
231
232
 
# File 'game_lift/cfn_fleet.rb', line 230

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


918
919
920
921
 
# File 'game_lift/cfn_fleet.rb', line 918

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) 


657
658
659
660
661
662
 
# File 'game_lift/cfn_fleet.rb', line 657

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