software.amazon.awssdk.services.gamelift.model

Interface UpdateGameServerGroupRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateGameServerGroupRequest

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

Method Summary

Modifier and Type	Method and Description
UpdateGameServerGroupRequest.Builder	balancingStrategy(BalancingStrategy balancingStrategy) Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
UpdateGameServerGroupRequest.Builder	balancingStrategy(String balancingStrategy) Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the game server group.
UpdateGameServerGroupRequest.Builder	gameServerGroupName(String gameServerGroupName) A unique identifier for the game server group.
UpdateGameServerGroupRequest.Builder	gameServerProtectionPolicy(GameServerProtectionPolicy gameServerProtectionPolicy) A flag that indicates whether instances in the game server group are protected from early termination.
UpdateGameServerGroupRequest.Builder	gameServerProtectionPolicy(String gameServerProtectionPolicy) A flag that indicates whether instances in the game server group are protected from early termination.
UpdateGameServerGroupRequest.Builder	instanceDefinitions(Collection<InstanceDefinition> instanceDefinitions) An updated list of Amazon EC2 instance types to use in the Auto Scaling group.
UpdateGameServerGroupRequest.Builder	instanceDefinitions(Consumer<InstanceDefinition.Builder>... instanceDefinitions) An updated list of Amazon EC2 instance types to use in the Auto Scaling group.
UpdateGameServerGroupRequest.Builder	instanceDefinitions(InstanceDefinition... instanceDefinitions) An updated list of Amazon EC2 instance types to use in the Auto Scaling group.
UpdateGameServerGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateGameServerGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateGameServerGroupRequest.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.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

gameServerGroupName

UpdateGameServerGroupRequest.Builder gameServerGroupName(String gameServerGroupName)

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Parameters:

gameServerGroupName - A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Returns:

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

roleArn

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

Parameters:

roleArn - The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.

Returns:

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

instanceDefinitions

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

Parameters:

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

Returns:

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

instanceDefinitions

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

Parameters:

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

Returns:

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

instanceDefinitions

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

This is a convenience method that creates an instance of the InstanceDefinition.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).

Parameters:

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

Returns:

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

See Also:

#instanceDefinitions(java.util.Collection)

gameServerProtectionPolicy

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

Parameters:

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

Returns:

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

See Also:

GameServerProtectionPolicy, GameServerProtectionPolicy

gameServerProtectionPolicy

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

Parameters:

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

Returns:

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

See Also:

GameServerProtectionPolicy, GameServerProtectionPolicy

balancingStrategy

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

Parameters:

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.

Returns:

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

See Also:

BalancingStrategy, BalancingStrategy

balancingStrategy

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

Parameters:

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.

Returns:

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

See Also:

BalancingStrategy, BalancingStrategy

overrideConfiguration

UpdateGameServerGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder