software.amazon.awssdk.services.gamelift.model

Class UpdateGameServerGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.gamelift.model.GameLiftRequest

software.amazon.awssdk.services.gamelift.model.UpdateGameServerGroupRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateGameServerGroupRequest.Builder,UpdateGameServerGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateGameServerGroupRequest
extends GameLiftRequest
implements ToCopyableBuilder<UpdateGameServerGroupRequest.Builder,UpdateGameServerGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateGameServerGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
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 UpdateGameServerGroupRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameServerGroupName() The unique identifier of the game server group to update.
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).
List<InstanceDefinition>	instanceDefinitions() An updated list of EC2 instance types to use when creating instances in the group.
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 UpdateGameServerGroupRequest.Builder>	serializableBuilderClass()
UpdateGameServerGroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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()

The unique identifier of the game server group to update. Use either the GameServerGroup name or ARN value.

Returns:

The unique identifier of the game server group to update. Use either the GameServerGroup name or ARN value.

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()

An updated list of EC2 instance types to use when creating instances in the group. The instance definition must specify instance types that are supported by GameLift FleetIQ, and must include at least two instance types. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide..

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:

An updated list of EC2 instance types to use when creating instances in the group. The instance definition must specify instance types that are supported by GameLift FleetIQ, and must include at least two instance types. This updated list replaces the entire current list of instance definitions for the game server group. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide..

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 by 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. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

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 by 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. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

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 by 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. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

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 by 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. An exception to this is Spot Instances, which may be terminated by AWS regardless of protection status. This property is set to NO_PROTECTION by default.

See Also:

GameServerProtectionPolicy

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

toBuilder

public UpdateGameServerGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateGameServerGroupRequest.Builder,UpdateGameServerGroupRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static UpdateGameServerGroupRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo