AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::DeleteGameServerGroupInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteGameServerGroupInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  game_server_group_name: "GameServerGroupNameOrArn", # required
  delete_option: "SAFE_DELETE", # accepts SAFE_DELETE, FORCE_DELETE, RETAIN
}

Instance Attribute Summary collapse

Instance Attribute Details

#delete_optionString

The type of delete to perform. Options include the following:

  • SAFE_DELETE – Terminates the game server group and EC2 Auto Scaling group only when it has no game servers that are in UTILIZED status.

  • FORCE_DELETE – Terminates the game server group, including all active game servers regardless of their utilization status, and the EC2 Auto Scaling group.

  • RETAIN – Does a safe delete of the game server group but retains the EC2 Auto Scaling group as is.

    Possible values:

    • SAFE_DELETE
    • FORCE_DELETE
    • RETAIN

Returns:

  • (String)

    The type of delete to perform.

#game_server_group_nameString

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Returns:

  • (String)

    A unique identifier for the game server group.