software.amazon.awssdk.services.gamelift.model

Interface GameServerGroup.Builder

All Superinterfaces:

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

Enclosing class:

GameServerGroup

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

Method Summary

Modifier and Type	Method and Description
GameServerGroup.Builder	autoScalingGroupArn(String autoScalingGroupArn) A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.
GameServerGroup.Builder	balancingStrategy(BalancingStrategy balancingStrategy) Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
GameServerGroup.Builder	balancingStrategy(String balancingStrategy) Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
GameServerGroup.Builder	creationTime(Instant creationTime) A time stamp indicating when this data object was created.
GameServerGroup.Builder	gameServerGroupArn(String gameServerGroupArn) A generated unique ID for the game server group.
GameServerGroup.Builder	gameServerGroupName(String gameServerGroupName) A developer-defined identifier for the game server group.
GameServerGroup.Builder	gameServerProtectionPolicy(GameServerProtectionPolicy gameServerProtectionPolicy) A flag that indicates whether instances in the game server group are protected from early termination.
GameServerGroup.Builder	gameServerProtectionPolicy(String gameServerProtectionPolicy) A flag that indicates whether instances in the game server group are protected from early termination.
GameServerGroup.Builder	instanceDefinitions(Collection<InstanceDefinition> instanceDefinitions) The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
GameServerGroup.Builder	instanceDefinitions(Consumer<InstanceDefinition.Builder>... instanceDefinitions) The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
GameServerGroup.Builder	instanceDefinitions(InstanceDefinition... instanceDefinitions) The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
GameServerGroup.Builder	lastUpdatedTime(Instant lastUpdatedTime) A timestamp that indicates when this game server group was last updated.
GameServerGroup.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
GameServerGroup.Builder	status(GameServerGroupStatus status) The current status of the game server group.
GameServerGroup.Builder	status(String status) The current status of the game server group.
GameServerGroup.Builder	statusReason(String statusReason) Additional information about the current game server group status.
GameServerGroup.Builder	suspendedActions(Collection<GameServerGroupAction> suspendedActions) A list of activities that are currently suspended for this game server group.
GameServerGroup.Builder	suspendedActions(GameServerGroupAction... suspendedActions) A list of activities that are currently suspended for this game server group.
GameServerGroup.Builder	suspendedActionsWithStrings(Collection<String> suspendedActions) A list of activities that are currently suspended for this game server group.
GameServerGroup.Builder	suspendedActionsWithStrings(String... suspendedActions) A list of activities that are currently suspended for this game server group.

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

GameServerGroup.Builder gameServerGroupName(String gameServerGroupName)

A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

Parameters:

gameServerGroupName - A developer-defined identifier for the game server group. The name is unique for each Region in each AWS account.

Returns:

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

gameServerGroupArn

GameServerGroup.Builder gameServerGroupArn(String gameServerGroupArn)

A generated unique ID for the game server group.

Parameters:

gameServerGroupArn - A generated unique ID for the game server group.

Returns:

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

roleArn

GameServerGroup.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Parameters:

roleArn - The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.

Returns:

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

instanceDefinitions

GameServerGroup.Builder instanceDefinitions(Collection<InstanceDefinition> instanceDefinitions)

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Parameters:

instanceDefinitions - The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Returns:

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

instanceDefinitions

GameServerGroup.Builder instanceDefinitions(InstanceDefinition... instanceDefinitions)

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Parameters:

instanceDefinitions - The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

Returns:

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

instanceDefinitions

GameServerGroup.Builder instanceDefinitions(Consumer<InstanceDefinition.Builder>... instanceDefinitions)

The set of EC2 instance types that GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #instanceDefinitions(List).

Parameters:

instanceDefinitions - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#instanceDefinitions(List)

balancingStrategy

GameServerGroup.Builder balancingStrategy(String balancingStrategy)

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.

Parameters:

balancingStrategy - 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.

Returns:

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

See Also:

BalancingStrategy, BalancingStrategy

balancingStrategy

GameServerGroup.Builder balancingStrategy(BalancingStrategy balancingStrategy)

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.

Parameters:

balancingStrategy - 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.

Returns:

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

See Also:

BalancingStrategy, BalancingStrategy

gameServerProtectionPolicy

GameServerGroup.Builder gameServerProtectionPolicy(String gameServerProtectionPolicy)

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.

Parameters:

gameServerProtectionPolicy - 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.

Returns:

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

See Also:

GameServerProtectionPolicy, GameServerProtectionPolicy

gameServerProtectionPolicy

GameServerGroup.Builder gameServerProtectionPolicy(GameServerProtectionPolicy gameServerProtectionPolicy)

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.

Parameters:

gameServerProtectionPolicy - 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.

Returns:

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

See Also:

GameServerProtectionPolicy, GameServerProtectionPolicy

autoScalingGroupArn

GameServerGroup.Builder autoScalingGroupArn(String autoScalingGroupArn)

A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

Parameters:

autoScalingGroupArn - A generated unique ID for the EC2 Auto Scaling group that is associated with this game server group.

Returns:

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

status

GameServerGroup.Builder status(String status)

The current status of the game server group. Possible statuses include:

• NEW - GameLift FleetIQ has validated the CreateGameServerGroup() 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 valid DeleteGameServerGroup() 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.

Parameters:

status - The current status of the game server group. Possible statuses include:

• NEW - GameLift FleetIQ has validated the CreateGameServerGroup() 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 valid DeleteGameServerGroup() 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.

Returns:

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

See Also:

GameServerGroupStatus, GameServerGroupStatus

status

GameServerGroup.Builder status(GameServerGroupStatus status)

The current status of the game server group. Possible statuses include:

• NEW - GameLift FleetIQ has validated the CreateGameServerGroup() 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 valid DeleteGameServerGroup() 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.

Parameters:

status - The current status of the game server group. Possible statuses include:

• NEW - GameLift FleetIQ has validated the CreateGameServerGroup() 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 valid DeleteGameServerGroup() 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.

Returns:

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

See Also:

GameServerGroupStatus, GameServerGroupStatus

statusReason

GameServerGroup.Builder statusReason(String statusReason)

Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

Parameters:

statusReason - Additional information about the current game server group status. This information might provide additional insight on groups that are in ERROR status.

Returns:

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

suspendedActionsWithStrings

GameServerGroup.Builder suspendedActionsWithStrings(Collection<String> suspendedActions)

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Parameters:

suspendedActions - A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Returns:

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

suspendedActionsWithStrings

GameServerGroup.Builder suspendedActionsWithStrings(String... suspendedActions)

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Parameters:

suspendedActions - A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Returns:

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

suspendedActions

GameServerGroup.Builder suspendedActions(Collection<GameServerGroupAction> suspendedActions)

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Parameters:

suspendedActions - A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Returns:

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

suspendedActions

GameServerGroup.Builder suspendedActions(GameServerGroupAction... suspendedActions)

A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Parameters:

suspendedActions - A list of activities that are currently suspended for this game server group. If this property is empty, all activities are occurring.

Returns:

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

creationTime

GameServerGroup.Builder creationTime(Instant creationTime)

A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

creationTime - A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

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

lastUpdatedTime

GameServerGroup.Builder lastUpdatedTime(Instant lastUpdatedTime)

A timestamp that indicates when this game server group was last updated.

Parameters:

lastUpdatedTime - A timestamp that indicates when this game server group was last updated.

Returns:

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