public static interface CreateGameServerGroupRequest.Builder extends GameLiftRequest.Builder, SdkPojo, CopyableBuilder<CreateGameServerGroupRequest.Builder,CreateGameServerGroupRequest>
| 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)
Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server
group.
|
CreateGameServerGroupRequest.Builder |
balancingStrategy(String balancingStrategy)
Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server
group.
|
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)
The Amazon EC2 instance types and sizes to use in the Auto Scaling group.
|
CreateGameServerGroupRequest.Builder |
instanceDefinitions(Consumer<InstanceDefinition.Builder>... instanceDefinitions)
The Amazon EC2 instance types and sizes to use in the Auto Scaling group.
|
CreateGameServerGroupRequest.Builder |
instanceDefinitions(InstanceDefinition... instanceDefinitions)
The Amazon EC2 instance types and sizes to use in the Auto Scaling group.
|
default CreateGameServerGroupRequest.Builder |
launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate)
The Amazon 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 Amazon 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 Amazon EC2 Auto Scaling group.
|
CreateGameServerGroupRequest.Builder |
minSize(Integer minSize)
The minimum number of instances allowed in the Amazon 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 Amazon 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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateGameServerGroupRequest.Builder gameServerGroupName(String gameServerGroupName)
An identifier for the new game server group. This value is used to generate unique ARN identifiers for the Amazon EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.
gameServerGroupName - An identifier for the new game server group. This value is used to generate unique ARN identifiers for
the Amazon EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name must be unique
per Region per Amazon Web Services account.CreateGameServerGroupRequest.Builder roleArn(String roleArn)
The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
roleArn - The Amazon Resource Name (ARN) for an IAM role
that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.CreateGameServerGroupRequest.Builder minSize(Integer minSize)
The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production, this value should be set to at least 1. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.
minSize - The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling
events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this minimum. In production,
this value should be set to at least 1. After the Auto Scaling group is created, update this value
directly in the Auto Scaling group using the Amazon Web Services console or APIs.CreateGameServerGroupRequest.Builder maxSize(Integer maxSize)
The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.
maxSize - The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling
events, GameLift FleetIQ and EC2 do not scale up the group above this maximum. After the Auto Scaling
group is created, update this value directly in the Auto Scaling group using the Amazon Web Services
console or APIs.CreateGameServerGroupRequest.Builder launchTemplate(LaunchTemplateSpecification launchTemplate)
The Amazon 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 Elastic Compute Cloud Auto Scaling User Guide. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.
If you specify network interfaces in your launch template, you must explicitly set the property
AssociatePublicIpAddress to "true". If no network interface is specified in the launch template,
GameLift FleetIQ uses your account's default VPC.
launchTemplate - The Amazon 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 Elastic Compute Cloud Auto Scaling User
Guide. After the Auto Scaling group is created, update this value directly in the Auto Scaling
group using the Amazon Web Services console or APIs.
If you specify network interfaces in your launch template, you must explicitly set the property
AssociatePublicIpAddress to "true". If no network interface is specified in the launch
template, GameLift FleetIQ uses your account's default VPC.
default CreateGameServerGroupRequest.Builder launchTemplate(Consumer<LaunchTemplateSpecification.Builder> launchTemplate)
The Amazon 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 Elastic Compute Cloud Auto Scaling User Guide. After the Auto Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.
If you specify network interfaces in your launch template, you must explicitly set the property
AssociatePublicIpAddress to "true". If no network interface is specified in the launch template,
GameLift FleetIQ uses your account's default VPC.
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).
launchTemplate - a consumer that will call methods on LaunchTemplateSpecification.BuilderlaunchTemplate(LaunchTemplateSpecification)CreateGameServerGroupRequest.Builder instanceDefinitions(Collection<InstanceDefinition> instanceDefinitions)
The Amazon EC2 instance types and sizes to use in the Auto Scaling 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 Elastic Compute Cloud User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
instanceDefinitions - The Amazon EC2 instance types and sizes to use in the Auto Scaling 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 Elastic Compute Cloud User Guide. You can optionally specify capacity weighting
for each instance type. If no weight value is specified for an instance type, it is set to the default
value "1". For more information about capacity weighting, see Instance
Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.CreateGameServerGroupRequest.Builder instanceDefinitions(InstanceDefinition... instanceDefinitions)
The Amazon EC2 instance types and sizes to use in the Auto Scaling 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 Elastic Compute Cloud User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
instanceDefinitions - The Amazon EC2 instance types and sizes to use in the Auto Scaling 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 Elastic Compute Cloud User Guide. You can optionally specify capacity weighting
for each instance type. If no weight value is specified for an instance type, it is set to the default
value "1". For more information about capacity weighting, see Instance
Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.CreateGameServerGroupRequest.Builder instanceDefinitions(Consumer<InstanceDefinition.Builder>... instanceDefinitions)
The Amazon EC2 instance types and sizes to use in the Auto Scaling 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 Elastic Compute Cloud User Guide. You can optionally specify capacity weighting for each instance type. If no weight value is specified for an instance type, it is set to the default value "1". For more information about capacity weighting, see Instance Weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience method that creates an instance of theInstanceDefinition.Builder avoiding the need to create
one manually via InstanceDefinition.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #instanceDefinitions(List.
instanceDefinitions - a consumer that will call methods on
InstanceDefinition.Builder#instanceDefinitions(java.util.Collection) 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. After the Auto Scaling group is
created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.
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. After the Auto
Scaling group is created, update this value directly in the Auto Scaling group using the Amazon Web
Services console or APIs.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. After the Auto Scaling group is
created, update this value directly in the Auto Scaling group using the Amazon Web Services console or APIs.
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).
autoScalingPolicy - a consumer that will call methods on GameServerGroupAutoScalingPolicy.BuilderautoScalingPolicy(GameServerGroupAutoScalingPolicy)CreateGameServerGroupRequest.Builder balancingStrategy(String balancingStrategy)
Indicates how 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.
balancingStrategy - Indicates how 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.
BalancingStrategy,
BalancingStrategyCreateGameServerGroupRequest.Builder balancingStrategy(BalancingStrategy balancingStrategy)
Indicates how 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.
balancingStrategy - Indicates how 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.
BalancingStrategy,
BalancingStrategyCreateGameServerGroupRequest.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 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. This
property is set to NO_PROTECTION by default.
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. This property is set to NO_PROTECTION by default.GameServerProtectionPolicy,
GameServerProtectionPolicyCreateGameServerGroupRequest.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 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. This
property is set to NO_PROTECTION by default.
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. This property is set to NO_PROTECTION by default.GameServerProtectionPolicy,
GameServerProtectionPolicyCreateGameServerGroupRequest.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. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.
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. You can use this parameter to
specify VPCs that you've set up. This property cannot be updated after the game server group is
created, and the corresponding Auto Scaling group will always use the property value that is set with
this request, even if the Auto Scaling group is updated directly.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. You can use this parameter to specify VPCs that you've set up. This property cannot be updated after the game server group is created, and the corresponding Auto Scaling group will always use the property value that is set with this request, even if the Auto Scaling group is updated directly.
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. You can use this parameter to
specify VPCs that you've set up. This property cannot be updated after the game server group is
created, and the corresponding Auto Scaling group will always use the property value that is set with
this request, even if the Auto Scaling group is updated directly.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 Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
tags - A list of labels to assign to the new game server group resource. Tags are developer-defined key-value
pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and
cost allocation. For more information, see Tagging Amazon Web Services
Resources in the Amazon Web Services General Reference.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 Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
tags - A list of labels to assign to the new game server group resource. Tags are developer-defined key-value
pairs. Tagging Amazon Web Services resources is useful for resource management, access management, and
cost allocation. For more information, see Tagging Amazon Web Services
Resources in the Amazon Web Services General Reference.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 Amazon Web Services resources is useful for resource management, access management, and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
This is a convenience method that creates an instance of theTag.Builder avoiding the need to create one manually
via Tag.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #tags(List.
tags - a consumer that will call methods on
Tag.Builder#tags(java.util.Collection) CreateGameServerGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateGameServerGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.