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) The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting.
UpdateGameServerGroupRequest.Builder	balancingStrategy(String balancingStrategy) The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting.
UpdateGameServerGroupRequest.Builder	gameServerGroupName(String gameServerGroupName) The unique identifier of the game server group to update.
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 EC2 instance types to use when creating instances in the group.
UpdateGameServerGroupRequest.Builder	instanceDefinitions(Consumer<InstanceDefinition.Builder>... instanceDefinitions) An updated list of EC2 instance types to use when creating instances in the group.
UpdateGameServerGroupRequest.Builder	instanceDefinitions(InstanceDefinition... instanceDefinitions) An updated list of EC2 instance types to use when creating instances in the 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 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)

The unique identifier of the game server group to update. Use either the GameServerGroup name or ARN value.

Parameters:

gameServerGroupName - The unique identifier of the game server group to update. 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 EC2 Auto Scaling groups. The submitted role is validated to ensure that it contains the necessary permissions for game server groups.

Parameters:

roleArn - The Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access your EC2 Auto Scaling groups. The submitted role is validated to ensure that it contains the necessary permissions for game server 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 EC2 instance types to use when creating instances in the group. The instance definition must specify instance types that are supported by GameLift FleetIQ, and must include at least two instance types. 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..

Parameters:

instanceDefinitions - An updated list of EC2 instance types to use when creating instances in the group. The instance definition must specify instance types that are supported by GameLift FleetIQ, and must include at least two instance types. 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..

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 EC2 instance types to use when creating instances in the group. The instance definition must specify instance types that are supported by GameLift FleetIQ, and must include at least two instance types. 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..

Parameters:

instanceDefinitions - An updated list of EC2 instance types to use when creating instances in the group. The instance definition must specify instance types that are supported by GameLift FleetIQ, and must include at least two instance types. 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..

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 EC2 instance types to use when creating instances in the group. The instance definition must specify instance types that are supported by GameLift FleetIQ, and must include at least two instance types. 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..

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #instanceDefinitions(List).

Parameters:

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

Returns:

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

See Also:

#instanceDefinitions(List)

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 may by 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. An exception to this is Spot Instances, which may be terminated by AWS 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 may by 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. An exception to this is Spot Instances, which may be terminated by AWS 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 may by 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. An exception to this is Spot Instances, which may be terminated by AWS 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 may by 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. An exception to this is Spot Instances, which may be terminated by AWS 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)

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

• SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

• SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

Parameters:

balancingStrategy - The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

• SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

• SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

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)

The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

• SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

• SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

Parameters:

balancingStrategy - The fallback balancing method to use for the game server group when Spot instances in a Region become unavailable or are not viable for game hosting. Once triggered, this method remains active until Spot instances can once again be used. Method options include:

• SPOT_ONLY -- If Spot instances are unavailable, the game server group provides no hosting capacity. No new instances are started, and the existing nonviable Spot instances are terminated (once current gameplay ends) and not replaced.

• SPOT_PREFERRED -- If Spot instances are unavailable, the game server group continues to provide hosting capacity by using On-Demand instances. Existing nonviable Spot instances are terminated (once current gameplay ends) and replaced with new On-Demand instances.

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