com.amazonaws.services.gamelift.model

Class GameServerGroup

java.lang.Object

com.amazonaws.services.gamelift.model.GameServerGroup

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GameServerGroup
extends Object
implements Serializable, Cloneable, StructuredPojo

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Properties that describe a game server group resource. A game server group manages certain properties related to a corresponding Amazon 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, respectively.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GameServerGroup()

Method Summary

Modifier and Type	Method and Description
GameServerGroup	clone()
boolean	equals(Object obj)
String	getAutoScalingGroupArn() A generated unique ID for the Amazon EC2 Auto Scaling group that is associated with this game server group.
String	getBalancingStrategy() Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
Date	getCreationTime() A time stamp indicating when this data object was created.
String	getGameServerGroupArn() A generated unique ID for the game server group.
String	getGameServerGroupName() A developer-defined identifier for the game server group.
String	getGameServerProtectionPolicy() A flag that indicates whether instances in the game server group are protected from early termination.
List<InstanceDefinition>	getInstanceDefinitions() The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
Date	getLastUpdatedTime() A timestamp that indicates when this game server group was last updated.
String	getRoleArn() The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
String	getStatus() The current status of the game server group.
String	getStatusReason() Additional information about the current game server group status.
List<String>	getSuspendedActions() A list of activities that are currently suspended for this game server group.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAutoScalingGroupArn(String autoScalingGroupArn) A generated unique ID for the Amazon EC2 Auto Scaling group that is associated with this game server group.
void	setBalancingStrategy(String balancingStrategy) Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
void	setCreationTime(Date creationTime) A time stamp indicating when this data object was created.
void	setGameServerGroupArn(String gameServerGroupArn) A generated unique ID for the game server group.
void	setGameServerGroupName(String gameServerGroupName) A developer-defined identifier for the game server group.
void	setGameServerProtectionPolicy(String gameServerProtectionPolicy) A flag that indicates whether instances in the game server group are protected from early termination.
void	setInstanceDefinitions(Collection<InstanceDefinition> instanceDefinitions) The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
void	setLastUpdatedTime(Date lastUpdatedTime) A timestamp that indicates when this game server group was last updated.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
void	setStatus(String status) The current status of the game server group.
void	setStatusReason(String statusReason) Additional information about the current game server group status.
void	setSuspendedActions(Collection<String> suspendedActions) A list of activities that are currently suspended for this game server group.
String	toString() Returns a string representation of this object.
GameServerGroup	withAutoScalingGroupArn(String autoScalingGroupArn) A generated unique ID for the Amazon EC2 Auto Scaling group that is associated with this game server group.
GameServerGroup	withBalancingStrategy(BalancingStrategy balancingStrategy) Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
GameServerGroup	withBalancingStrategy(String balancingStrategy) Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
GameServerGroup	withCreationTime(Date creationTime) A time stamp indicating when this data object was created.
GameServerGroup	withGameServerGroupArn(String gameServerGroupArn) A generated unique ID for the game server group.
GameServerGroup	withGameServerGroupName(String gameServerGroupName) A developer-defined identifier for the game server group.
GameServerGroup	withGameServerProtectionPolicy(GameServerProtectionPolicy gameServerProtectionPolicy) A flag that indicates whether instances in the game server group are protected from early termination.
GameServerGroup	withGameServerProtectionPolicy(String gameServerProtectionPolicy) A flag that indicates whether instances in the game server group are protected from early termination.
GameServerGroup	withInstanceDefinitions(Collection<InstanceDefinition> instanceDefinitions) The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
GameServerGroup	withInstanceDefinitions(InstanceDefinition... instanceDefinitions) The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically scaling instances in the corresponding Auto Scaling group.
GameServerGroup	withLastUpdatedTime(Date lastUpdatedTime) A timestamp that indicates when this game server group was last updated.
GameServerGroup	withRoleArn(String roleArn) The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
GameServerGroup	withStatus(GameServerGroupStatus status) The current status of the game server group.
GameServerGroup	withStatus(String status) The current status of the game server group.
GameServerGroup	withStatusReason(String statusReason) Additional information about the current game server group status.
GameServerGroup	withSuspendedActions(Collection<String> suspendedActions) A list of activities that are currently suspended for this game server group.
GameServerGroup	withSuspendedActions(GameServerGroupAction... suspendedActions) A list of activities that are currently suspended for this game server group.
GameServerGroup	withSuspendedActions(String... suspendedActions) A list of activities that are currently suspended for this game server group.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GameServerGroup

public GameServerGroup()

Method Detail

setGameServerGroupName

public void setGameServerGroupName(String gameServerGroupName)

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

Parameters:

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

getGameServerGroupName

public String getGameServerGroupName()

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

Returns:

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

withGameServerGroupName

public GameServerGroup withGameServerGroupName(String gameServerGroupName)

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

Parameters:

gameServerGroupName - A developer-defined identifier for the game server group. 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.

setGameServerGroupArn

public void setGameServerGroupArn(String gameServerGroupArn)

A generated unique ID for the game server group.

Parameters:

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

getGameServerGroupArn

public String getGameServerGroupArn()

A generated unique ID for the game server group.

Returns:

A generated unique ID for the game server group.

withGameServerGroupArn

public GameServerGroup withGameServerGroupArn(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.

setRoleArn

public void setRoleArn(String roleArn)

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

Parameters:

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

getRoleArn

public String getRoleArn()

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

Returns:

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

withRoleArn

public GameServerGroup withRoleArn(String roleArn)

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

Parameters:

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

Returns:

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

getInstanceDefinitions

public List<InstanceDefinition> getInstanceDefinitions()

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

Returns:

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

setInstanceDefinitions

public void setInstanceDefinitions(Collection<InstanceDefinition> instanceDefinitions)

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

Parameters:

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

withInstanceDefinitions

public GameServerGroup withInstanceDefinitions(InstanceDefinition... instanceDefinitions)

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

NOTE: This method appends the values to the existing list (if any). Use setInstanceDefinitions(java.util.Collection) or withInstanceDefinitions(java.util.Collection) if you want to override the existing values.

Parameters:

instanceDefinitions - The set of Amazon EC2 instance types that Amazon 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.

withInstanceDefinitions

public GameServerGroup withInstanceDefinitions(Collection<InstanceDefinition> instanceDefinitions)

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

Parameters:

instanceDefinitions - The set of Amazon EC2 instance types that Amazon 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.

setBalancingStrategy

public void setBalancingStrategy(String balancingStrategy)

Indicates how Amazon 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 Amazon 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.

See Also:

BalancingStrategy

getBalancingStrategy

public String getBalancingStrategy()

Indicates how Amazon 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:

Indicates how Amazon 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.

See Also:

BalancingStrategy

withBalancingStrategy

public GameServerGroup withBalancingStrategy(String balancingStrategy)

Indicates how Amazon 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 Amazon 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

withBalancingStrategy

public GameServerGroup withBalancingStrategy(BalancingStrategy balancingStrategy)

Indicates how Amazon 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 Amazon 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

setGameServerProtectionPolicy

public void setGameServerProtectionPolicy(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 Amazon Web Services 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 Amazon Web Services regardless of protection status.

See Also:

GameServerProtectionPolicy

getGameServerProtectionPolicy

public String getGameServerProtectionPolicy()

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 Amazon Web Services regardless of protection status.

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 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 Amazon Web Services regardless of protection status.

See Also:

GameServerProtectionPolicy

withGameServerProtectionPolicy

public GameServerGroup withGameServerProtectionPolicy(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 Amazon Web Services 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 Amazon Web Services regardless of protection status.

Returns:

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

See Also:

GameServerProtectionPolicy

withGameServerProtectionPolicy

public GameServerGroup withGameServerProtectionPolicy(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 Amazon Web Services 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 Amazon Web Services regardless of protection status.

Returns:

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

See Also:

GameServerProtectionPolicy

setAutoScalingGroupArn

public void setAutoScalingGroupArn(String autoScalingGroupArn)

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

Parameters:

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

getAutoScalingGroupArn

public String getAutoScalingGroupArn()

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

Returns:

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

withAutoScalingGroupArn

public GameServerGroup withAutoScalingGroupArn(String autoScalingGroupArn)

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

Parameters:

autoScalingGroupArn - A generated unique ID for the Amazon 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.

setStatus

public void setStatus(String status)

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

• NEW - Amazon GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - Amazon GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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 - Amazon GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - Amazon GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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.

See Also:

GameServerGroupStatus

getStatus

public String getStatus()

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

• NEW - Amazon GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - Amazon GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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:

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

• NEW - Amazon GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - Amazon GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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.

See Also:

GameServerGroupStatus

withStatus

public GameServerGroup withStatus(String status)

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

• NEW - Amazon GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - Amazon GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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 - Amazon GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - Amazon GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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

withStatus

public GameServerGroup withStatus(GameServerGroupStatus status)

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

• NEW - Amazon GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - Amazon GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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 - Amazon GameLift FleetIQ has validated the CreateGameServerGroup() request.

• ACTIVATING - Amazon GameLift FleetIQ is setting up a game server group, which includes creating an Auto Scaling group in your Amazon Web Services account.

• ACTIVE - The game server group has been successfully created.

• DELETE_SCHEDULED - A request to delete the game server group has been received.

• DELETING - Amazon GameLift FleetIQ has received a valid DeleteGameServerGroup() request and is processing it. Amazon 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

setStatusReason

public void setStatusReason(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.

getStatusReason

public String getStatusReason()

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

Returns:

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

withStatusReason

public GameServerGroup withStatusReason(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.

getSuspendedActions

public List<String> getSuspendedActions()

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

Returns:

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

See Also:

GameServerGroupAction

setSuspendedActions

public void setSuspendedActions(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.

See Also:

GameServerGroupAction

withSuspendedActions

public GameServerGroup withSuspendedActions(String... suspendedActions)

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

NOTE: This method appends the values to the existing list (if any). Use setSuspendedActions(java.util.Collection) or withSuspendedActions(java.util.Collection) if you want to override the existing values.

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.

See Also:

GameServerGroupAction

withSuspendedActions

public GameServerGroup withSuspendedActions(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.

See Also:

GameServerGroupAction

withSuspendedActions

public GameServerGroup withSuspendedActions(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.

See Also:

GameServerGroupAction

setCreationTime

public void setCreationTime(Date 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").

getCreationTime

public Date getCreationTime()

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

withCreationTime

public GameServerGroup withCreationTime(Date 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.

setLastUpdatedTime

public void setLastUpdatedTime(Date 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.

getLastUpdatedTime

public Date getLastUpdatedTime()

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

Returns:

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

withLastUpdatedTime

public GameServerGroup withLastUpdatedTime(Date 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.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GameServerGroup clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.