software.amazon.awssdk.services.gamelift.model

Interface RegisterGameServerRequest.Builder

All Superinterfaces:

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

Enclosing class:

RegisterGameServerRequest

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

Method Summary

Modifier and Type	Method and Description
RegisterGameServerRequest.Builder	connectionInfo(String connectionInfo) Information needed to make inbound client connections to the game server.
RegisterGameServerRequest.Builder	customSortKey(String customSortKey) A game server tag that can be used to request sorted lists of game servers using ListGameServers.
RegisterGameServerRequest.Builder	gameServerData(String gameServerData) A set of custom game server properties, formatted as a single string value.
RegisterGameServerRequest.Builder	gameServerGroupName(String gameServerGroupName) An identifier for the game server group where the game server is running.
RegisterGameServerRequest.Builder	gameServerId(String gameServerId) A custom string that uniquely identifies the new game server.
RegisterGameServerRequest.Builder	instanceId(String instanceId) The unique identifier for the instance where the game server is running.
RegisterGameServerRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
RegisterGameServerRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
RegisterGameServerRequest.Builder	tags(Collection<Tag> tags) A list of labels to assign to the new game server resource.
RegisterGameServerRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of labels to assign to the new game server resource.
RegisterGameServerRequest.Builder	tags(Tag... tags) A list of labels to assign to the new game server resource.

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

RegisterGameServerRequest.Builder gameServerGroupName(String gameServerGroupName)

An identifier for the game server group where the game server is running. You can use either the GameServerGroup name or ARN value.

Parameters:

gameServerGroupName - An identifier for the game server group where the game server is running. You can use either the GameServerGroup name or ARN value.

Returns:

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

gameServerId

RegisterGameServerRequest.Builder gameServerId(String gameServerId)

A custom string that uniquely identifies the new game server. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.

Parameters:

gameServerId - A custom string that uniquely identifies the new game server. Game server IDs are developer-defined and must be unique across all game server groups in your AWS account.

Returns:

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

instanceId

RegisterGameServerRequest.Builder instanceId(String instanceId)

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata.

Parameters:

instanceId - The unique identifier for the instance where the game server is running. This ID is available in the instance metadata.

Returns:

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

connectionInfo

RegisterGameServerRequest.Builder connectionInfo(String connectionInfo)

Information needed to make inbound client connections to the game server. This might include IP address and port, DNS name, etc.

Parameters:

connectionInfo - Information needed to make inbound client connections to the game server. This might include IP address and port, DNS name, etc.

Returns:

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

gameServerData

RegisterGameServerRequest.Builder gameServerData(String gameServerData)

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on a game servers using ListGameServers or ClaimGameServer.

Parameters:

gameServerData - A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on a game servers using ListGameServers or ClaimGameServer.

Returns:

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

customSortKey

RegisterGameServerRequest.Builder customSortKey(String customSortKey)

A game server tag that can be used to request sorted lists of game servers using ListGameServers. Custom sort keys are developer-defined based on how you want to organize the retrieved game server information.

Parameters:

customSortKey - A game server tag that can be used to request sorted lists of game servers using ListGameServers. Custom sort keys are developer-defined based on how you want to organize the retrieved game server information.

Returns:

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

tags

RegisterGameServerRequest.Builder tags(Collection<Tag> tags)

A list of labels to assign to the new game server resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Parameters:

tags - A list of labels to assign to the new game server resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

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

tags

RegisterGameServerRequest.Builder tags(Tag... tags)

A list of labels to assign to the new game server resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Parameters:

tags - A list of labels to assign to the new game server resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Returns:

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

tags

RegisterGameServerRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of labels to assign to the new game server resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management, and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

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 #tags(List).

Parameters:

tags - 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:

#tags(List)

overrideConfiguration

RegisterGameServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder