Class: AWSCDK::GameLift::CfnFleet::LocationConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
game_lift/cfn_fleet.rb

Overview

A remote location where a multi-location fleet can deploy game servers for game hosting.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(location:, location_capacity: nil, player_gateway_status: nil) ⇒ LocationConfigurationProperty

Returns a new instance of LocationConfigurationProperty.

Parameters:

  • location (String) —

    An AWS Region code, such as us-west-2 .

  • location_capacity (AWSCDK::IResolvable, AWSCDK::GameLift::CfnFleet::LocationCapacityProperty, nil) (defaults to: nil) —

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

  • player_gateway_status (String, nil) (defaults to: nil) —

    The player gateway status for the location.



1168
1169
1170
1171
1172
1173
1174
1175
 
# File 'game_lift/cfn_fleet.rb', line 1168

def initialize(location:, location_capacity: nil, player_gateway_status: nil)
  @location = location
  Jsii::Type.check_type(@location, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "location")
  @location_capacity = location_capacity.is_a?(Hash) ? ::AWSCDK::GameLift::CfnFleet::LocationCapacityProperty.new(**location_capacity.transform_keys(&:to_sym)) : location_capacity
  Jsii::Type.check_type(@location_capacity, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19nYW1lbGlmdC5DZm5GbGVldC5Mb2NhdGlvbkNhcGFjaXR5UHJvcGVydHkifV19fQ==")), "locationCapacity") unless @location_capacity.nil?
  @player_gateway_status = player_gateway_status
  Jsii::Type.check_type(@player_gateway_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "playerGatewayStatus") unless @player_gateway_status.nil?
end

Instance Attribute Details

#location ⇒ String (readonly)

An AWS Region code, such as us-west-2 .

For a list of supported Regions and Local Zones, see Amazon GameLift Servers service locations for managed hosting.

Returns:

  • (String)

See Also:



1183
1184
1185
 
# File 'game_lift/cfn_fleet.rb', line 1183

def location
  @location
end

#location_capacity ⇒ AWSCDK::IResolvable, ... (readonly)

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

For multi-location fleets, location values might refer to a fleet's remote location or its home Region.

Returned by: DescribeFleetCapacity , DescribeFleetLocationCapacity , UpdateFleetCapacity

Returns:

See Also:



1192
1193
1194
 
# File 'game_lift/cfn_fleet.rb', line 1192

def location_capacity
  @location_capacity
end

#player_gateway_status ⇒ String? (readonly)

The player gateway status for the location.

Returns:

  • (String, nil)

See Also:



1197
1198
1199
 
# File 'game_lift/cfn_fleet.rb', line 1197

def player_gateway_status
  @player_gateway_status
end

Class Method Details

.jsii_properties ⇒ Object 



1199
1200
1201
1202
1203
1204
1205
 
# File 'game_lift/cfn_fleet.rb', line 1199

def self.jsii_properties
  {
    :location => "location",
    :location_capacity => "locationCapacity",
    :player_gateway_status => "playerGatewayStatus",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1207
1208
1209
1210
1211
1212
1213
1214
1215
 
# File 'game_lift/cfn_fleet.rb', line 1207

def to_jsii
  result = {}
  result.merge!({
    "location" => @location,
    "locationCapacity" => @location_capacity,
    "playerGatewayStatus" => @player_gateway_status,
  })
  result.compact
end