software.amazon.awssdk.services.gamelift.model

Interface CreateFleetRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>, GameLiftRequest.Builder, SdkBuilder<CreateFleetRequest.Builder,CreateFleetRequest>, SdkRequest.Builder

Enclosing class:

CreateFleetRequest

public static interface CreateFleetRequest.Builder
extends GameLiftRequest.Builder, CopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

Method Summary

Modifier and Type	Method and Description
CreateFleetRequest.Builder	buildId(String buildId) Unique identifier for a build to be deployed on the new fleet.
CreateFleetRequest.Builder	description(String description) Human-readable description of a fleet.
CreateFleetRequest.Builder	ec2InboundPermissions(Collection<IpPermission> ec2InboundPermissions) Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet.
CreateFleetRequest.Builder	ec2InboundPermissions(Consumer<IpPermission.Builder>... ec2InboundPermissions) Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet.
CreateFleetRequest.Builder	ec2InboundPermissions(IpPermission... ec2InboundPermissions) Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet.
CreateFleetRequest.Builder	ec2InstanceType(EC2InstanceType ec2InstanceType) Name of an EC2 instance type that is supported in Amazon GameLift.
CreateFleetRequest.Builder	ec2InstanceType(String ec2InstanceType) Name of an EC2 instance type that is supported in Amazon GameLift.
CreateFleetRequest.Builder	logPaths(Collection<String> logPaths) This parameter is no longer used.
CreateFleetRequest.Builder	logPaths(String... logPaths) This parameter is no longer used.
CreateFleetRequest.Builder	metricGroups(Collection<String> metricGroups) Names of metric groups to add this fleet to.
CreateFleetRequest.Builder	metricGroups(String... metricGroups) Names of metric groups to add this fleet to.
CreateFleetRequest.Builder	name(String name) Descriptive label that is associated with a fleet.
CreateFleetRequest.Builder	newGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy) Game session protection policy to apply to all instances in this fleet.
CreateFleetRequest.Builder	newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy) Game session protection policy to apply to all instances in this fleet.
CreateFleetRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateFleetRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateFleetRequest.Builder	peerVpcAwsAccountId(String peerVpcAwsAccountId) Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with.
CreateFleetRequest.Builder	peerVpcId(String peerVpcId) Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet.
default CreateFleetRequest.Builder	resourceCreationLimitPolicy(Consumer<ResourceCreationLimitPolicy.Builder> resourceCreationLimitPolicy) Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
CreateFleetRequest.Builder	resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy) Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.
default CreateFleetRequest.Builder	runtimeConfiguration(Consumer<RuntimeConfiguration.Builder> runtimeConfiguration) Instructions for launching server processes on each instance in the fleet.
CreateFleetRequest.Builder	runtimeConfiguration(RuntimeConfiguration runtimeConfiguration) Instructions for launching server processes on each instance in the fleet.
CreateFleetRequest.Builder	serverLaunchParameters(String serverLaunchParameters) This parameter is no longer used.
CreateFleetRequest.Builder	serverLaunchPath(String serverLaunchPath) This parameter is no longer used.

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.utils.builder.CopyableBuilder

copy

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

applyMutation, build

Method Detail

name

CreateFleetRequest.Builder name(String name)

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Parameters:

name - Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

Returns:

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

description

CreateFleetRequest.Builder description(String description)

Human-readable description of a fleet.

Parameters:

description - Human-readable description of a fleet.

Returns:

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

buildId

CreateFleetRequest.Builder buildId(String buildId)

Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

Parameters:

buildId - Unique identifier for a build to be deployed on the new fleet. The build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

Returns:

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

serverLaunchPath

CreateFleetRequest.Builder serverLaunchPath(String serverLaunchPath)

This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Parameters:

serverLaunchPath - This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Returns:

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

serverLaunchParameters

CreateFleetRequest.Builder serverLaunchParameters(String serverLaunchParameters)

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Parameters:

serverLaunchParameters - This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

Returns:

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

logPaths

CreateFleetRequest.Builder logPaths(Collection<String> logPaths)

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

Parameters:

logPaths - This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

Returns:

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

logPaths

CreateFleetRequest.Builder logPaths(String... logPaths)

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

Parameters:

logPaths - This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

Returns:

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

ec2InstanceType

CreateFleetRequest.Builder ec2InstanceType(String ec2InstanceType)

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Parameters:

ec2InstanceType - Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Returns:

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

See Also:

EC2InstanceType, EC2InstanceType

ec2InstanceType

CreateFleetRequest.Builder ec2InstanceType(EC2InstanceType ec2InstanceType)

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Parameters:

ec2InstanceType - Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

Returns:

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

See Also:

EC2InstanceType, EC2InstanceType

ec2InboundPermissions

CreateFleetRequest.Builder ec2InboundPermissions(Collection<IpPermission> ec2InboundPermissions)

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

Parameters:

ec2InboundPermissions - Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

Returns:

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

ec2InboundPermissions

CreateFleetRequest.Builder ec2InboundPermissions(IpPermission... ec2InboundPermissions)

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

Parameters:

ec2InboundPermissions - Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

Returns:

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

ec2InboundPermissions

CreateFleetRequest.Builder ec2InboundPermissions(Consumer<IpPermission.Builder>... ec2InboundPermissions)

Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.

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

Parameters:

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

#ec2InboundPermissions(List)

newGameSessionProtectionPolicy

CreateFleetRequest.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Parameters:

newGameSessionProtectionPolicy - Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Returns:

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

See Also:

ProtectionPolicy, ProtectionPolicy

newGameSessionProtectionPolicy

CreateFleetRequest.Builder newGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Parameters:

newGameSessionProtectionPolicy - Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

• NoProtection -- The game session can be terminated during a scale-down event.

• FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Returns:

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

See Also:

ProtectionPolicy, ProtectionPolicy

runtimeConfiguration

CreateFleetRequest.Builder runtimeConfiguration(RuntimeConfiguration runtimeConfiguration)

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

Parameters:

runtimeConfiguration - Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

Returns:

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

runtimeConfiguration

default CreateFleetRequest.Builder runtimeConfiguration(Consumer<RuntimeConfiguration.Builder> runtimeConfiguration)

Instructions for launching server processes on each instance in the fleet. The run-time configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration; otherwise the request fails with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a run-time configuration will continue to work.)

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

Parameters:

runtimeConfiguration - a consumer that will call methods on RuntimeConfiguration.Builder

Returns:

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

See Also:

runtimeConfiguration(RuntimeConfiguration)

resourceCreationLimitPolicy

CreateFleetRequest.Builder resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

Parameters:

resourceCreationLimitPolicy - Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

Returns:

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

resourceCreationLimitPolicy

default CreateFleetRequest.Builder resourceCreationLimitPolicy(Consumer<ResourceCreationLimitPolicy.Builder> resourceCreationLimitPolicy)

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

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

Parameters:

resourceCreationLimitPolicy - a consumer that will call methods on ResourceCreationLimitPolicy.Builder

Returns:

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

See Also:

resourceCreationLimitPolicy(ResourceCreationLimitPolicy)

metricGroups

CreateFleetRequest.Builder metricGroups(Collection<String> metricGroups)

Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Parameters:

metricGroups - Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Returns:

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

metricGroups

CreateFleetRequest.Builder metricGroups(String... metricGroups)

Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Parameters:

metricGroups - Names of metric groups to add this fleet to. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

Returns:

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

peerVpcAwsAccountId

CreateFleetRequest.Builder peerVpcAwsAccountId(String peerVpcAwsAccountId)

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

Parameters:

peerVpcAwsAccountId - Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

Returns:

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

peerVpcId

CreateFleetRequest.Builder peerVpcId(String peerVpcId)

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

Parameters:

peerVpcId - Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. To get VPC information, including IDs, use the Virtual Private Cloud service tools, including the VPC Dashboard in the AWS Management Console.

Returns:

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

overrideConfiguration

CreateFleetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.