Struct aws_sdk_gamelift::input::UpdateGameServerGroupInput [−][src]
#[non_exhaustive]pub struct UpdateGameServerGroupInput {
pub game_server_group_name: Option<String>,
pub role_arn: Option<String>,
pub instance_definitions: Option<Vec<InstanceDefinition>>,
pub game_server_protection_policy: Option<GameServerProtectionPolicy>,
pub balancing_strategy: Option<BalancingStrategy>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.game_server_group_name: Option<String>
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
role_arn: Option<String>
The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
instance_definitions: Option<Vec<InstanceDefinition>>
An updated list of 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 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.
game_server_protection_policy: Option<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 AWS regardless of protection status. This property is set to NO_PROTECTION
by default.
balancing_strategy: Option<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.
Implementations
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<UpdateGameServerGroup, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<UpdateGameServerGroup, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<UpdateGameServerGroup
>
Creates a new builder-style object to manufacture UpdateGameServerGroupInput
A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.
The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups.
An updated list of 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 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.
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 AWS regardless of protection status. This property is set to NO_PROTECTION
by default.
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.
Trait Implementations
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for UpdateGameServerGroupInput
impl Send for UpdateGameServerGroupInput
impl Sync for UpdateGameServerGroupInput
impl Unpin for UpdateGameServerGroupInput
impl UnwindSafe for UpdateGameServerGroupInput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more