Class: Aws::GameLift::Types::GameServerGroup
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::GameServerGroup
- Defined in:
- gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb
Overview
This data type is used with the Amazon GameLift FleetIQ and game server groups.
Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding EC2 Auto Scaling group.
A game server group is created by a successful call to
CreateGameServerGroup
and deleted by calling
DeleteGameServerGroup
. Game server group activity can be temporarily
suspended and resumed by calling SuspendGameServerGroup
and
ResumeGameServerGroup
, respectively.
CreateGameServerGroup
ListGameServerGroups
DescribeGameServerGroup
UpdateGameServerGroup
DeleteGameServerGroup
ResumeGameServerGroup
SuspendGameServerGroup
DescribeGameServerInstances
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#auto_scaling_group_arn ⇒ String
A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
-
#balancing_strategy ⇒ String
Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
-
#creation_time ⇒ Time
A timestamp that indicates when this data object was created.
-
#game_server_group_arn ⇒ String
A generated unique ID for the game server group.
-
#game_server_group_name ⇒ String
A developer-defined identifier for the game server group.
-
#game_server_protection_policy ⇒ String
A flag that indicates whether instances in the game server group are protected from early termination.
-
#instance_definitions ⇒ Array<Types::InstanceDefinition>
The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
-
#last_updated_time ⇒ Time
A timestamp that indicates when this game server group was last updated.
-
#role_arn ⇒ String
The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
-
#status ⇒ String
The current status of the game server group.
-
#status_reason ⇒ String
Additional information about the current game server group status.
-
#suspended_actions ⇒ Array<String>
A list of activities that are currently suspended for this game server group.
Instance Attribute Details
#auto_scaling_group_arn ⇒ String
A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#balancing_strategy ⇒ String
Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group. Method options include the following:
SPOT_ONLY
- Only Spot Instances are used in the game server group. If Spot Instances are unavailable or not viable for game hosting, the game server group provides no hosting capacity until Spot Instances can again be used. Until then, no new instances are started, and the existing nonviable Spot Instances are terminated (after current gameplay ends) and are not replaced.SPOT_PREFERRED
- (default value) Spot Instances are used whenever available in the game server group. If Spot Instances are unavailable, the game server group continues to provide hosting capacity by falling back to On-Demand Instances. Existing nonviable Spot Instances are terminated (after current gameplay ends) and are replaced with new On-Demand Instances.ON_DEMAND_ONLY
- Only On-Demand Instances are used in the game server group. No Spot Instances are used, even when available, while this balancing strategy is in force.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#creation_time ⇒ Time
A timestamp that indicates when this data object was created. Format
is a number expressed in Unix time as milliseconds (for example
"1469498468.057"
).
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#game_server_group_arn ⇒ String
A generated unique ID for the game server group.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#game_server_group_name ⇒ String
A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#game_server_protection_policy ⇒ String
A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running might be terminated during a scale-down event, causing players to be dropped from the game. Protected instances cannot be terminated while there are active game servers running except in the event of a forced game server group deletion (see ). An exception to this is with Spot Instances, which can be terminated by AWS regardless of protection status.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#instance_definitions ⇒ Array<Types::InstanceDefinition>
The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#last_updated_time ⇒ Time
A timestamp that indicates when this game server group was last updated.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The current status of the game server group. Possible statuses include:
NEW
- GameLift FleetIQ has validated theCreateGameServerGroup()
request.ACTIVATING
- GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your AWS account.ACTIVE
- The game server group has been successfully created.DELETE_SCHEDULED
- A request to delete the game server group has been received.DELETING
- GameLift FleetIQ has received a validDeleteGameServerGroup()
request and is processing it. GameLift FleetIQ must first complete and release hosts before it deletes the Auto Scaling group and the game server group.DELETED
- The game server group has been successfully deleted.ERROR
- The asynchronous processes of activating or deleting a game server group has failed, resulting in an error state.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#status_reason ⇒ String
Additional information about the current game server group status.
This information might provide additional insight on groups that are
in ERROR
status.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |
#suspended_actions ⇒ Array<String>
A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.
4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 |
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4542 class GameServerGroup < Struct.new( :game_server_group_name, :game_server_group_arn, :role_arn, :instance_definitions, :balancing_strategy, :game_server_protection_policy, :auto_scaling_group_arn, :status, :status_reason, :suspended_actions, :creation_time, :last_updated_time) SENSITIVE = [] include Aws::Structure end |