software.amazon.awssdk.services.gamelift.model

Interface CreateGameServerGroupRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateGameServerGroupRequest.Builder,CreateGameServerGroupRequest>, GameLiftRequest.Builder, SdkBuilder<CreateGameServerGroupRequest.Builder,CreateGameServerGroupRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateGameServerGroupRequest

public static interface CreateGameServerGroupRequest.Builder
extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<CreateGameServerGroupRequest.Builder,CreateGameServerGroupRequest>

Method Summary

Modifier and Type	Method and Description
default CreateGameServerGroupRequest.Builder	autoScalingPolicy(Consumer<GameServerGroupAutoScalingPolicy.Builder> autoScalingPolicy) Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
CreateGameServerGroupRequest.Builder	autoScalingPolicy(GameServerGroupAutoScalingPolicy autoScalingPolicy) Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
CreateGameServerGroupRequest.Builder	balancingStrategy(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.
CreateGameServerGroupRequest.Builder	balancingStrategy(String 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.
CreateGameServerGroupRequest.Builder	gameServerGroupName(String gameServerGroupName) An identifier for the new game server group.
CreateGameServerGroupRequest.Builder	gameServerProtectionPolicy(GameServerProtectionPolicy gameServerProtectionPolicy) A flag that indicates whether instances in the game server group are protected from early termination.
CreateGameServerGroupRequest.Builder	gameServerProtectionPolicy(String gameServerProtectionPolicy) A flag that indicates whether instances in the game server group are protected from early termination.
CreateGameServerGroupRequest.Builder	instanceDefinitions(Collection<InstanceDefinition> instanceDefinitions) A set of EC2 instance types to use when creating instances in the group.
CreateGameServerGroupRequest.Builder	instanceDefinitions(Consumer<InstanceDefinition.Builder>... instanceDefinitions) A set of EC2 instance types to use when creating instances in the group.
CreateGameServerGroupRequest.Builder	instanceDefinitions(InstanceDefinition... instanceDefinitions) A set of EC2 instance types to use when creating instances in the group.
default CreateGameServerGroupRequest.Builder	launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate) The EC2 launch template that contains configuration settings and game server code to be deployed to all instances in the game server group.
CreateGameServerGroupRequest.Builder	launchTemplate(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.
CreateGameServerGroupRequest.Builder	maxSize(Integer maxSize) The maximum number of instances allowed in the EC2 Auto Scaling group.
CreateGameServerGroupRequest.Builder	minSize(Integer minSize) The minimum number of instances allowed in the EC2 Auto Scaling group.
CreateGameServerGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateGameServerGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateGameServerGroupRequest.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
CreateGameServerGroupRequest.Builder	tags(Collection<Tag> tags) A list of labels to assign to the new game server group resource.
CreateGameServerGroupRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of labels to assign to the new game server group resource.
CreateGameServerGroupRequest.Builder	tags(Tag... tags) A list of labels to assign to the new game server group resource.
CreateGameServerGroupRequest.Builder	vpcSubnets(Collection<String> vpcSubnets) A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
CreateGameServerGroupRequest.Builder	vpcSubnets(String... vpcSubnets) A list of virtual private cloud (VPC) subnets to use with instances in the game server group.

Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

gameServerGroupName

CreateGameServerGroupRequest.Builder gameServerGroupName(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.

Parameters:

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:

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

roleArn

CreateGameServerGroupRequest.Builder roleArn(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.

Parameters:

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:

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

minSize

CreateGameServerGroupRequest.Builder minSize(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.

Parameters:

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:

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

maxSize

CreateGameServerGroupRequest.Builder maxSize(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.

Parameters:

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:

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

launchTemplate

CreateGameServerGroupRequest.Builder launchTemplate(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.

Parameters:

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:

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

launchTemplate

default CreateGameServerGroupRequest.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> 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.

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

Parameters:

launchTemplate - a consumer that will call methods on LaunchTemplateSpecification.Builder

Returns:

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

See Also:

launchTemplate(LaunchTemplateSpecification)

instanceDefinitions

CreateGameServerGroupRequest.Builder instanceDefinitions(Collection<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.

Parameters:

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.

Returns:

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

instanceDefinitions

CreateGameServerGroupRequest.Builder instanceDefinitions(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.

Parameters:

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.

Returns:

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

instanceDefinitions

CreateGameServerGroupRequest.Builder instanceDefinitions(Consumer<InstanceDefinition.Builder>... 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.

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

Parameters:

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

Returns:

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

See Also:

#instanceDefinitions(List)

autoScalingPolicy

CreateGameServerGroupRequest.Builder autoScalingPolicy(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.

Parameters:

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:

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

autoScalingPolicy

default CreateGameServerGroupRequest.Builder autoScalingPolicy(Consumer<GameServerGroupAutoScalingPolicy.Builder> 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.

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

Parameters:

autoScalingPolicy - a consumer that will call methods on GameServerGroupAutoScalingPolicy.Builder

Returns:

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

See Also:

autoScalingPolicy(GameServerGroupAutoScalingPolicy)

balancingStrategy

CreateGameServerGroupRequest.Builder balancingStrategy(String 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.

Parameters:

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.

Returns:

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

See Also:

BalancingStrategy, BalancingStrategy

balancingStrategy

CreateGameServerGroupRequest.Builder balancingStrategy(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.

Parameters:

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.

Returns:

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

See Also:

BalancingStrategy, BalancingStrategy

gameServerProtectionPolicy

CreateGameServerGroupRequest.Builder gameServerProtectionPolicy(String gameServerProtectionPolicy)

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running 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.

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

Returns:

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

See Also:

GameServerProtectionPolicy, GameServerProtectionPolicy

gameServerProtectionPolicy

CreateGameServerGroupRequest.Builder gameServerProtectionPolicy(GameServerProtectionPolicy gameServerProtectionPolicy)

A flag that indicates whether instances in the game server group are protected from early termination. Unprotected instances that have active game servers running 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.

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

Returns:

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

See Also:

GameServerProtectionPolicy, GameServerProtectionPolicy

vpcSubnets

CreateGameServerGroupRequest.Builder vpcSubnets(Collection<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.

Parameters:

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.

Returns:

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

vpcSubnets

CreateGameServerGroupRequest.Builder vpcSubnets(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.

Parameters:

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.

Returns:

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

tags

CreateGameServerGroupRequest.Builder tags(Collection<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.

Parameters:

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.

Returns:

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

tags

CreateGameServerGroupRequest.Builder tags(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.

Parameters:

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.

Returns:

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

tags

CreateGameServerGroupRequest.Builder tags(Consumer<Tag.Builder>... 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.

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

Parameters:

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

Returns:

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

See Also:

#tags(List)

overrideConfiguration

CreateGameServerGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateGameServerGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder