software.amazon.awssdk.services.gamelift.model

Class CreateGameServerGroupRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateGameServerGroupRequest.Builder,CreateGameServerGroupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateGameServerGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
GameServerGroupAutoScalingPolicy	autoScalingPolicy() Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
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 CreateGameServerGroupRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gameServerGroupName() An identifier for the new 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	hasTags() Returns true if the Tags 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	hasVpcSubnets() Returns true if the VpcSubnets 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() A set of EC2 instance types to use when creating instances in the group.
LaunchTemplateSpecification	launchTemplate() The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
Integer	maxSize() The maximum number of instances allowed in the EC2 Auto Scaling group.
Integer	minSize() The minimum number of instances allowed in the EC2 Auto Scaling 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 CreateGameServerGroupRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of labels to assign to the new game server group resource.
CreateGameServerGroupRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	vpcSubnets() A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

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

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

Returns:

An identifier for the new game server group. This value is used to generate unique ARN identifiers for the EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per AWS account.

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.

minSize

public Integer minSize()

The minimum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1.

Returns:

The minimum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1.

maxSize

public Integer maxSize()

The maximum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.

Returns:

The maximum number of instances allowed in the EC2 Auto Scaling group. During autoscaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.

launchTemplate

public LaunchTemplateSpecification launchTemplate()

The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

Returns:

The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group. You can specify the template using either the template name or ID. For help with creating a launch template, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

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

A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. 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:

A set of EC2 instance types to use when creating instances in the group. The instance definitions must specify at least two different instance types that are supported by GameLift FleetIQ. For more information on instance types, see EC2 Instance Types in the Amazon EC2 User Guide.

autoScalingPolicy

public GameServerGroupAutoScalingPolicy autoScalingPolicy()

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. Once the game server and Auto Scaling groups are created, you can update the scaling policy settings directly in Auto Scaling Groups.

Returns:

Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting. The scaling policy uses the metric "PercentUtilizedGameServers" to maintain a buffer of idle game servers that can immediately accommodate new games and players. Once the game server and Auto Scaling groups are created, you can update the scaling policy settings directly in Auto Scaling Groups.

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

hasVpcSubnets

public boolean hasVpcSubnets()

Returns true if the VpcSubnets 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.

vpcSubnets

public List<String> vpcSubnets()

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

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

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

Returns:

A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all GameLift FleetIQ-supported availability zones are used; this parameter allows you to specify VPCs that you've set up.

hasTags

public boolean hasTags()

Returns true if the Tags 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.

tags

public List<Tag> tags()

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

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

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

Returns:

A list of labels to assign to the new game server group resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

toBuilder

public CreateGameServerGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateGameServerGroupRequest.Builder,CreateGameServerGroupRequest>

Specified by:

toBuilder in class GameLiftRequest

builder

public static CreateGameServerGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateGameServerGroupRequest.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