/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.gamelift.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class UpdateGameServerGroupRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* A unique identifier for the game server group. Use either the name or ARN value. *
*/ private String gameServerGroupName; /** ** The Amazon Resource Name (ARN) * for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. *
*/ private String roleArn; /** ** An updated list of Amazon EC2 instance types 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. This updated list * replaces the entire current list of instance definitions for the game server group. For more information on * instance types, see EC2 * Instance Types in the Amazon EC2 User Guide. 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. *
*/ private java.util.List
* 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.
*
* 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.
*
* A unique identifier for the game server group. Use either the name or ARN value. *
* * @param gameServerGroupName * A unique identifier for the game server group. Use either the name or ARN value. */ public void setGameServerGroupName(String gameServerGroupName) { this.gameServerGroupName = gameServerGroupName; } /** ** A unique identifier for the game server group. Use either the name or ARN value. *
* * @return A unique identifier for the game server group. Use either the name or ARN value. */ public String getGameServerGroupName() { return this.gameServerGroupName; } /** ** A unique identifier for the game server group. Use either the name or ARN value. *
* * @param gameServerGroupName * A unique identifier for the game server group. Use either the name or ARN value. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateGameServerGroupRequest withGameServerGroupName(String gameServerGroupName) { setGameServerGroupName(gameServerGroupName); return this; } /** ** The Amazon Resource Name (ARN) * for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. *
* * @param roleArn * The Amazon Resource Name (ARN) for an IAM role that * allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. */ public void setRoleArn(String roleArn) { this.roleArn = roleArn; } /** ** The Amazon Resource Name (ARN) * for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. *
* * @return The Amazon Resource Name (ARN) for an IAM role that * allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. */ public String getRoleArn() { return this.roleArn; } /** ** The Amazon Resource Name (ARN) * for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. *
* * @param roleArn * The Amazon Resource Name (ARN) for an IAM role that * allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateGameServerGroupRequest withRoleArn(String roleArn) { setRoleArn(roleArn); return this; } /** ** An updated list of Amazon EC2 instance types 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. This updated list * replaces the entire current list of instance definitions for the game server group. For more information on * instance types, see EC2 * Instance Types in the Amazon EC2 User Guide. 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. *
* * @return An updated list of Amazon EC2 instance types 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. This * updated list replaces the entire current list of instance definitions for the game server group. For more * information on instance types, see EC2 Instance Types in * the Amazon EC2 User Guide. 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 java.util.List* An updated list of Amazon EC2 instance types 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. This updated list * replaces the entire current list of instance definitions for the game server group. For more information on * instance types, see EC2 * Instance Types in the Amazon EC2 User Guide. 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. *
* * @param instanceDefinitions * An updated list of Amazon EC2 instance types 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. This * updated list replaces the entire current list of instance definitions for the game server group. For more * information on instance types, see EC2 Instance Types in * the Amazon EC2 User Guide. 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(java.util.Collection* An updated list of Amazon EC2 instance types 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. This updated list * replaces the entire current list of instance definitions for the game server group. For more information on * instance types, see EC2 * Instance Types in the Amazon EC2 User Guide. 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 * {@link #setInstanceDefinitions(java.util.Collection)} or {@link #withInstanceDefinitions(java.util.Collection)} * if you want to override the existing values. *
* * @param instanceDefinitions * An updated list of Amazon EC2 instance types 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. This * updated list replaces the entire current list of instance definitions for the game server group. For more * information on instance types, see EC2 Instance Types in * the Amazon EC2 User Guide. 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateGameServerGroupRequest withInstanceDefinitions(InstanceDefinition... instanceDefinitions) { if (this.instanceDefinitions == null) { setInstanceDefinitions(new java.util.ArrayList* An updated list of Amazon EC2 instance types 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. This updated list * replaces the entire current list of instance definitions for the game server group. For more information on * instance types, see EC2 * Instance Types in the Amazon EC2 User Guide. 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. *
* * @param instanceDefinitions * An updated list of Amazon EC2 instance types 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. This * updated list replaces the entire current list of instance definitions for the game server group. For more * information on instance types, see EC2 Instance Types in * the Amazon EC2 User Guide. 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. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateGameServerGroupRequest withInstanceDefinitions(java.util.Collection
* 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.
* @see GameServerProtectionPolicy
*/
public void setGameServerProtectionPolicy(String gameServerProtectionPolicy) {
this.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.
*
NO_PROTECTION
by default.
* @see GameServerProtectionPolicy
*/
public String getGameServerProtectionPolicy() {
return this.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.
*
NO_PROTECTION
by default.
* @return Returns a reference to this object so that method calls can be chained together.
* @see GameServerProtectionPolicy
*/
public UpdateGameServerGroupRequest withGameServerProtectionPolicy(String gameServerProtectionPolicy) {
setGameServerProtectionPolicy(gameServerProtectionPolicy);
return this;
}
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see GameServerProtectionPolicy
*/
public UpdateGameServerGroupRequest withGameServerProtectionPolicy(GameServerProtectionPolicy gameServerProtectionPolicy) {
this.gameServerProtectionPolicy = gameServerProtectionPolicy.toString();
return this;
}
/**
* * 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.
*
* 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.
*
* 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.
*
* 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.
*