software.amazon.awssdk.services.gamelift.model

Class GameServerGroup

java.lang.Object

software.amazon.awssdk.services.gamelift.model.GameServerGroup

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GameServerGroup.Builder,GameServerGroup>

@Generated(value="software.amazon.awssdk:codegen")
public final class GameServerGroup
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GameServerGroup.Builder,GameServerGroup>

This data type is part of Amazon GameLift FleetIQ with game server groups, which is in preview release and is subject to change.

Properties describing a game server group resource. A game server group manages certain properties of 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GameServerGroup.Builder

Method Summary

Modifier and Type	Method and Description
String	autoScalingGroupArn() A generated unique ID for the EC2 Auto Scaling group with is associated with this game server group.
BalancingStrategy	balancingStrategy() The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting.
String	balancingStrategyAsString() The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting.
static GameServerGroup.Builder	builder()
Instant	creationTime() A time stamp indicating when this data object was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameServerGroupArn() A generated unique ID for the game server group.
String	gameServerGroupName() A developer-defined identifier for the game server group.
GameServerProtectionPolicy	gameServerProtectionPolicy() A flag that indicates whether instances in the game server group are protected from early termination.
String	gameServerProtectionPolicyAsString() A flag that indicates whether instances in the game server group are protected from early termination.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInstanceDefinitions() Returns true if the InstanceDefinitions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasSuspendedActions() Returns true if the SuspendedActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<InstanceDefinition>	instanceDefinitions() The set of EC2 instance types that GameLift FleetIQ can use when rebalancing and autoscaling instances in the group.
Instant	lastUpdatedTime() A time stamp indicating when this game server group was last updated.
String	roleArn() The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
List<SdkField<?>>	sdkFields()
static Class<? extends GameServerGroup.Builder>	serializableBuilderClass()
GameServerGroupStatus	status() The current status of the game server group.
String	statusAsString() The current status of the game server group.
String	statusReason() Additional information about the current game server group status.
List<GameServerGroupAction>	suspendedActions() A list of activities that are currently suspended for this game server group.
List<String>	suspendedActionsAsStrings() A list of activities that are currently suspended for this game server group.
GameServerGroup.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

gameServerGroupName

public String gameServerGroupName()

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

Returns:

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

gameServerGroupArn

public String gameServerGroupArn()

A generated unique ID for the game server group.

Returns:

A generated unique ID for the game server group.

roleArn

public String roleArn()

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

Returns:

The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

hasInstanceDefinitions

public boolean hasInstanceDefinitions()

Returns true if the InstanceDefinitions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

instanceDefinitions

public List<InstanceDefinition> instanceDefinitions()

The set of EC2 instance types that GameLift FleetIQ can use when rebalancing and autoscaling instances in the group.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasInstanceDefinitions() to see if a value was sent in this field.

Returns:

The set of EC2 instance types that GameLift FleetIQ can use when rebalancing and autoscaling instances in the group.

balancingStrategy

public BalancingStrategy balancingStrategy()

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

• SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

• SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

If the service returns an enum value that is not available in the current SDK version, balancingStrategy will return BalancingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from balancingStrategyAsString().

Returns:

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

• SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

• SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

See Also:

BalancingStrategy

balancingStrategyAsString

public String balancingStrategyAsString()

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

• SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

• SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

If the service returns an enum value that is not available in the current SDK version, balancingStrategy will return BalancingStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from balancingStrategyAsString().

Returns:

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

• SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

• SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

See Also:

BalancingStrategy

gameServerProtectionPolicy

public 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 may 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 DeleteGameServerGroup). An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status.

If the service returns an enum value that is not available in the current SDK version, gameServerProtectionPolicy will return GameServerProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gameServerProtectionPolicyAsString().

Returns:

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running may 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 DeleteGameServerGroup). An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status.

See Also:

GameServerProtectionPolicy

gameServerProtectionPolicyAsString

public String gameServerProtectionPolicyAsString()

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running may 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 DeleteGameServerGroup). An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status.

If the service returns an enum value that is not available in the current SDK version, gameServerProtectionPolicy will return GameServerProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from gameServerProtectionPolicyAsString().

Returns:

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running may 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 DeleteGameServerGroup). An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status.

See Also:

GameServerProtectionPolicy

autoScalingGroupArn

public String autoScalingGroupArn()

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

Returns:

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

status

public 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 autoscaling 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 autoscaling 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.

If the service returns an enum value that is not available in the current SDK version, status will return GameServerGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

GameServerGroupStatus

statusAsString

public String statusAsString()

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

If the service returns an enum value that is not available in the current SDK version, status will return GameServerGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

GameServerGroupStatus

statusReason

public String statusReason()

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

Returns:

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

suspendedActions

public List<GameServerGroupAction> suspendedActions()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSuspendedActions() to see if a value was sent in this field.

Returns:

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

hasSuspendedActions

public boolean hasSuspendedActions()

Returns true if the SuspendedActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

suspendedActionsAsStrings

public List<String> suspendedActionsAsStrings()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSuspendedActions() to see if a value was sent in this field.

Returns:

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

creationTime

public 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").

Returns:

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

lastUpdatedTime

public Instant lastUpdatedTime()

A time stamp indicating when this game server group was last updated.

Returns:

A time stamp indicating when this game server group was last updated.

toBuilder

public GameServerGroup.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GameServerGroup.Builder,GameServerGroup>

builder

public static GameServerGroup.Builder builder()

serializableBuilderClass

public static Class<? extends GameServerGroup.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo