@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateGameServerGroupRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateGameServerGroupRequest() |
Modifier and Type | Method and Description |
---|---|
CreateGameServerGroupRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
GameServerGroupAutoScalingPolicy |
getAutoScalingPolicy()
Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
|
String |
getBalancingStrategy()
Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game
server group.
|
String |
getGameServerGroupName()
An identifier for the new 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 Amazon EC2 instance types and sizes to use in the Auto Scaling group.
|
LaunchTemplateSpecification |
getLaunchTemplate()
The Amazon EC2 launch template that contains configuration settings and game server code to be deployed to all
instances in the game server group.
|
Integer |
getMaxSize()
The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
|
Integer |
getMinSize()
The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
|
String |
getRoleArn()
The Amazon Resource Name (ARN)
for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
|
List<Tag> |
getTags()
A list of labels to assign to the new game server group resource.
|
List<String> |
getVpcSubnets()
A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
|
int |
hashCode() |
void |
setAutoScalingPolicy(GameServerGroupAutoScalingPolicy autoScalingPolicy)
Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
|
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 |
setGameServerGroupName(String gameServerGroupName)
An identifier for the new 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 Amazon EC2 instance types and sizes to use in the Auto Scaling group.
|
void |
setLaunchTemplate(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.
|
void |
setMaxSize(Integer maxSize)
The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
|
void |
setMinSize(Integer minSize)
The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
|
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 |
setTags(Collection<Tag> tags)
A list of labels to assign to the new game server group resource.
|
void |
setVpcSubnets(Collection<String> vpcSubnets)
A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
|
String |
toString()
Returns a string representation of this object.
|
CreateGameServerGroupRequest |
withAutoScalingPolicy(GameServerGroupAutoScalingPolicy autoScalingPolicy)
Configuration settings to define a scaling policy for the Auto Scaling group that is optimized for game hosting.
|
CreateGameServerGroupRequest |
withBalancingStrategy(BalancingStrategy balancingStrategy)
Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game
server group.
|
CreateGameServerGroupRequest |
withBalancingStrategy(String balancingStrategy)
Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game
server group.
|
CreateGameServerGroupRequest |
withGameServerGroupName(String gameServerGroupName)
An identifier for the new game server group.
|
CreateGameServerGroupRequest |
withGameServerProtectionPolicy(GameServerProtectionPolicy gameServerProtectionPolicy)
A flag that indicates whether instances in the game server group are protected from early termination.
|
CreateGameServerGroupRequest |
withGameServerProtectionPolicy(String gameServerProtectionPolicy)
A flag that indicates whether instances in the game server group are protected from early termination.
|
CreateGameServerGroupRequest |
withInstanceDefinitions(Collection<InstanceDefinition> instanceDefinitions)
The Amazon EC2 instance types and sizes to use in the Auto Scaling group.
|
CreateGameServerGroupRequest |
withInstanceDefinitions(InstanceDefinition... instanceDefinitions)
The Amazon EC2 instance types and sizes to use in the Auto Scaling group.
|
CreateGameServerGroupRequest |
withLaunchTemplate(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 |
withMaxSize(Integer maxSize)
The maximum number of instances allowed in the Amazon EC2 Auto Scaling group.
|
CreateGameServerGroupRequest |
withMinSize(Integer minSize)
The minimum number of instances allowed in the Amazon EC2 Auto Scaling group.
|
CreateGameServerGroupRequest |
withRoleArn(String roleArn)
The Amazon Resource Name (ARN)
for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
|
CreateGameServerGroupRequest |
withTags(Collection<Tag> tags)
A list of labels to assign to the new game server group resource.
|
CreateGameServerGroupRequest |
withTags(Tag... tags)
A list of labels to assign to the new game server group resource.
|
CreateGameServerGroupRequest |
withVpcSubnets(Collection<String> vpcSubnets)
A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
|
CreateGameServerGroupRequest |
withVpcSubnets(String... vpcSubnets)
A list of virtual private cloud (VPC) subnets to use with instances in the game server group.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setGameServerGroupName(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 Amazon 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 Amazon GameLift FleetIQ game server group. The name must be unique
per Region per Amazon Web Services account.public String getGameServerGroupName()
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 Amazon GameLift FleetIQ game server group. The name must be unique per Region per Amazon Web Services account.
public CreateGameServerGroupRequest withGameServerGroupName(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 Amazon 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 Amazon GameLift FleetIQ game server group. The name must be unique
per Region per Amazon Web Services account.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.
roleArn
- The Amazon Resource Name (ARN) for an IAM role that
allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.public String getRoleArn()
The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.
public CreateGameServerGroupRequest withRoleArn(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.public void setMinSize(Integer minSize)
The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon 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, Amazon 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.public Integer getMinSize()
The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon 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.
public CreateGameServerGroupRequest withMinSize(Integer minSize)
The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon 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, Amazon 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.public void setMaxSize(Integer maxSize)
The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon 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, Amazon 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.public Integer getMaxSize()
The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon 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.
public CreateGameServerGroupRequest withMaxSize(Integer maxSize)
The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During automatic scaling events, Amazon 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, Amazon 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.public void setLaunchTemplate(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,
Amazon 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, Amazon GameLift FleetIQ uses your account's default VPC.
public LaunchTemplateSpecification getLaunchTemplate()
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,
Amazon GameLift FleetIQ uses your account's default VPC.
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, Amazon GameLift FleetIQ uses your account's default VPC.
public CreateGameServerGroupRequest withLaunchTemplate(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,
Amazon 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, Amazon GameLift FleetIQ uses your account's default VPC.
public List<InstanceDefinition> getInstanceDefinitions()
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 Amazon 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.
public void setInstanceDefinitions(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 Amazon 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 Amazon 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.public CreateGameServerGroupRequest withInstanceDefinitions(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 Amazon 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.
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.
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 Amazon 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.public CreateGameServerGroupRequest withInstanceDefinitions(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 Amazon 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 Amazon 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.public void setAutoScalingPolicy(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.public GameServerGroupAutoScalingPolicy getAutoScalingPolicy()
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.
"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.public CreateGameServerGroupRequest withAutoScalingPolicy(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.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.
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.
BalancingStrategy
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.
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
public CreateGameServerGroupRequest 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.
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.
BalancingStrategy
public CreateGameServerGroupRequest 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.
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.
BalancingStrategy
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. 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
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. This property is
set to NO_PROTECTION
by default.
NO_PROTECTION
by default.GameServerProtectionPolicy
public CreateGameServerGroupRequest 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. 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
public CreateGameServerGroupRequest 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. 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
public List<String> getVpcSubnets()
A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon 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.
public void setVpcSubnets(Collection<String> vpcSubnets)
A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon 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 Amazon 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.public CreateGameServerGroupRequest withVpcSubnets(String... vpcSubnets)
A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon 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.
NOTE: This method appends the values to the existing list (if any). Use
setVpcSubnets(java.util.Collection)
or withVpcSubnets(java.util.Collection)
if you want to
override the existing values.
vpcSubnets
- A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default,
all Amazon 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.public CreateGameServerGroupRequest withVpcSubnets(Collection<String> vpcSubnets)
A list of virtual private cloud (VPC) subnets to use with instances in the game server group. By default, all Amazon 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 Amazon 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.public List<Tag> getTags()
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.
public void setTags(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.public CreateGameServerGroupRequest withTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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.public CreateGameServerGroupRequest withTags(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.public String toString()
toString
in class Object
Object.toString()
public CreateGameServerGroupRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()