software.amazon.awssdk.services.gamelift.model

Interface GameServerInstance.Builder

All Superinterfaces:

Buildable, CopyableBuilder<GameServerInstance.Builder,GameServerInstance>, SdkBuilder<GameServerInstance.Builder,GameServerInstance>, SdkPojo

Enclosing class:

GameServerInstance

public static interface GameServerInstance.Builder
extends SdkPojo, CopyableBuilder<GameServerInstance.Builder,GameServerInstance>

Method Summary

Modifier and Type	Method and Description
GameServerInstance.Builder	gameServerGroupArn(String gameServerGroupArn) A generated unique identifier for the game server group that includes the game server instance.
GameServerInstance.Builder	gameServerGroupName(String gameServerGroupName) A developer-defined identifier for the game server group that includes the game server instance.
GameServerInstance.Builder	instanceId(String instanceId) The unique identifier for the instance where the game server is running.
GameServerInstance.Builder	instanceStatus(GameServerInstanceStatus instanceStatus) Current status of the game server instance.
GameServerInstance.Builder	instanceStatus(String instanceStatus) Current status of the game server instance.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

gameServerGroupName

GameServerInstance.Builder gameServerGroupName(String gameServerGroupName)

A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.

Parameters:

gameServerGroupName - A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account.

Returns:

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

gameServerGroupArn

GameServerInstance.Builder gameServerGroupArn(String gameServerGroupArn)

A generated unique identifier for the game server group that includes the game server instance.

Parameters:

gameServerGroupArn - A generated unique identifier for the game server group that includes the game server instance.

Returns:

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

instanceId

GameServerInstance.Builder instanceId(String instanceId)

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Parameters:

instanceId - The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Returns:

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

instanceStatus

GameServerInstance.Builder instanceStatus(String instanceStatus)

Current status of the game server instance.

• ACTIVE -- The instance is viable for hosting game servers.

• DRAINING -- The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

• SPOT_TERMINATING -- The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

Parameters:

instanceStatus - Current status of the game server instance.

• ACTIVE -- The instance is viable for hosting game servers.

• DRAINING -- The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

• SPOT_TERMINATING -- The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

Returns:

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

See Also:

GameServerInstanceStatus, GameServerInstanceStatus

instanceStatus

GameServerInstance.Builder instanceStatus(GameServerInstanceStatus instanceStatus)

Current status of the game server instance.

• ACTIVE -- The instance is viable for hosting game servers.

• DRAINING -- The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

• SPOT_TERMINATING -- The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

Parameters:

instanceStatus - Current status of the game server instance.

• ACTIVE -- The instance is viable for hosting game servers.

• DRAINING -- The instance is not viable for hosting game servers. Existing game servers are in the process of ending, and new game servers are not started on this instance unless no other resources are available. When the instance is put in DRAINING, a new instance is started up to replace it. Once the instance has no UTILIZED game servers, it will be terminated in favor of the new instance.

• SPOT_TERMINATING -- The instance is in the process of shutting down due to a Spot instance interruption. No new game servers are started on this instance.

Returns:

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

See Also:

GameServerInstanceStatus, GameServerInstanceStatus