Package software.amazon.awssdk.services.gamelift.model

Interface DeleteGameServerGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DeleteGameServerGroupRequest.Builder,DeleteGameServerGroupRequest>, GameLiftRequest.Builder, SdkBuilder<DeleteGameServerGroupRequest.Builder,DeleteGameServerGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DeleteGameServerGroupRequest
public static interface DeleteGameServerGroupRequest.Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<DeleteGameServerGroupRequest.Builder,DeleteGameServerGroupRequest>

  • Method Details

    • gameServerGroupName

      DeleteGameServerGroupRequest.Builder gameServerGroupName(String gameServerGroupName)

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

      Parameters:
      gameServerGroupName - A unique identifier for the game server group. Use either the name or ARN value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deleteOption

      DeleteGameServerGroupRequest.Builder deleteOption(String deleteOption)

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

      • SAFE_DELETE – (default) Terminates the game server group and Amazon 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 Amazon EC2 Auto Scaling group.

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

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

      • SAFE_DELETE – (default) Terminates the game server group and Amazon 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 Amazon EC2 Auto Scaling group.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deleteOption

      DeleteGameServerGroupRequest.Builder deleteOption(GameServerGroupDeleteOption deleteOption)

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

      • SAFE_DELETE – (default) Terminates the game server group and Amazon 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 Amazon EC2 Auto Scaling group.

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

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

      • SAFE_DELETE – (default) Terminates the game server group and Amazon 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 Amazon EC2 Auto Scaling group.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      DeleteGameServerGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DeleteGameServerGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.