Package software.amazon.awssdk.services.gamelift.model

Interface FleetAttributes.Builder

All Superinterfaces:

CopyableBuilder<FleetAttributes.Builder,FleetAttributes>, SdkBuilder<FleetAttributes.Builder,FleetAttributes>

Enclosing class:

FleetAttributes

public static interface FleetAttributes.Builder
extends CopyableBuilder<FleetAttributes.Builder,FleetAttributes>

Method Summary

Modifier and Type	Method	Description
FleetAttributes.Builder	buildId(String buildId)	Unique identifier for a build.
FleetAttributes.Builder	creationTime(Date creationTime)	Time stamp indicating when this data object was created.
FleetAttributes.Builder	description(String description)	Human-readable description of the fleet.
FleetAttributes.Builder	fleetArn(String fleetArn)	Identifier for a fleet that is unique across all regions.
FleetAttributes.Builder	fleetId(String fleetId)	Unique identifier for a fleet.
FleetAttributes.Builder	logPaths(String... logPaths)	Location of default log files.
FleetAttributes.Builder	logPaths(Collection<String> logPaths)	Location of default log files.
FleetAttributes.Builder	metricGroups(String... metricGroups)	Names of metric groups that this fleet is included in.
FleetAttributes.Builder	metricGroups(Collection<String> metricGroups)	Names of metric groups that this fleet is included in.
FleetAttributes.Builder	name(String name)	Descriptive label that is associated with a fleet.
FleetAttributes.Builder	newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)	Type of game session protection to set for all new instances started in the fleet.
FleetAttributes.Builder	newGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)	Type of game session protection to set for all new instances started in the fleet.
FleetAttributes.Builder	operatingSystem(String operatingSystem)	Operating system of the fleet's computing resources.
FleetAttributes.Builder	operatingSystem(OperatingSystem operatingSystem)	Operating system of the fleet's computing resources.
FleetAttributes.Builder	resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)	Fleet policy to limit the number of game sessions an individual player can create over a span of time.
FleetAttributes.Builder	serverLaunchParameters(String serverLaunchParameters)	Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v.
FleetAttributes.Builder	serverLaunchPath(String serverLaunchPath)	Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS SDK v.
FleetAttributes.Builder	status(String status)	Current status of the fleet.
FleetAttributes.Builder	status(FleetStatus status)	Current status of the fleet.
FleetAttributes.Builder	terminationTime(Date terminationTime)	Time stamp indicating when this data object was terminated.

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

copy

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

apply, build

Method Detail

fleetId

FleetAttributes.Builder fleetId(String fleetId)

Unique identifier for a fleet.

Parameters:

fleetId - Unique identifier for a fleet.

Returns:

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

fleetArn

FleetAttributes.Builder fleetArn(String fleetArn)

Identifier for a fleet that is unique across all regions.

Parameters:

fleetArn - Identifier for a fleet that is unique across all regions.

Returns:

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

description

FleetAttributes.Builder description(String description)

Human-readable description of the fleet.

Parameters:

description - Human-readable description of the fleet.

Returns:

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

name

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

creationTime

FleetAttributes.Builder creationTime(Date creationTime)

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

creationTime - Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

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

terminationTime

FleetAttributes.Builder terminationTime(Date terminationTime)

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Parameters:

terminationTime - Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

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

status

FleetAttributes.Builder status(String status)

Current status of the fleet.

Possible fleet statuses include the following:

• NEW – A new fleet has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.

• ACTIVE – Hosts can now accept game sessions.

• ERROR – An error occurred when downloading, validating, building, or activating the fleet.

• DELETING – Hosts are responding to a delete fleet request.

• TERMINATED – The fleet no longer exists.

Parameters:

status - Current status of the fleet.

Possible fleet statuses include the following:

• NEW – A new fleet has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.

• ACTIVE – Hosts can now accept game sessions.

• ERROR – An error occurred when downloading, validating, building, or activating the fleet.

• DELETING – Hosts are responding to a delete fleet request.

• TERMINATED – The fleet no longer exists.

Returns:

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

See Also:

FleetStatus

status

FleetAttributes.Builder status(FleetStatus status)

Current status of the fleet.

Possible fleet statuses include the following:

• NEW – A new fleet has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.

• ACTIVE – Hosts can now accept game sessions.

• ERROR – An error occurred when downloading, validating, building, or activating the fleet.

• DELETING – Hosts are responding to a delete fleet request.

• TERMINATED – The fleet no longer exists.

Parameters:

status - Current status of the fleet.

Possible fleet statuses include the following:

• NEW – A new fleet has been defined and desired instances is set to 1.

• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING – Amazon GameLift is setting up the new fleet, creating new instances with the game build and starting server processes.

• ACTIVE – Hosts can now accept game sessions.

• ERROR – An error occurred when downloading, validating, building, or activating the fleet.

• DELETING – Hosts are responding to a delete fleet request.

• TERMINATED – The fleet no longer exists.

Returns:

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

See Also:

FleetStatus

buildId

FleetAttributes.Builder buildId(String buildId)

Unique identifier for a build.

Parameters:

buildId - Unique identifier for a build.

Returns:

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

serverLaunchPath

FleetAttributes.Builder serverLaunchPath(String serverLaunchPath)

Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Parameters:

serverLaunchPath - Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Returns:

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

serverLaunchParameters

FleetAttributes.Builder serverLaunchParameters(String serverLaunchParameters)

Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Parameters:

serverLaunchParameters - Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

Returns:

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

logPaths

FleetAttributes.Builder logPaths(Collection<String> logPaths)

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift will automatically upload logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Parameters:

logPaths - Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift will automatically upload logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Returns:

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

logPaths

FleetAttributes.Builder logPaths(String... logPaths)

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift will automatically upload logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

NOTE: This method appends the values to the existing list (if any). Use #setLogPaths(java.util.Collection) or #withLogPaths(java.util.Collection) if you want to override the existing values.

Parameters:

logPaths - Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift will automatically upload logs that are stored on each instance at C:\game\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

Returns:

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

newGameSessionProtectionPolicy

FleetAttributes.Builder newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)

Type of game session protection to set for all new instances started in the fleet.

• 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 - Type of game session protection to set for all new instances started in the fleet.

• 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

newGameSessionProtectionPolicy

FleetAttributes.Builder newGameSessionProtectionPolicy(ProtectionPolicy newGameSessionProtectionPolicy)

Type of game session protection to set for all new instances started in the fleet.

• 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 - Type of game session protection to set for all new instances started in the fleet.

• 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

operatingSystem

FleetAttributes.Builder operatingSystem(String operatingSystem)

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Parameters:

operatingSystem - Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Returns:

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

See Also:

OperatingSystem

operatingSystem

FleetAttributes.Builder operatingSystem(OperatingSystem operatingSystem)

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Parameters:

operatingSystem - Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

Returns:

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

See Also:

OperatingSystem

resourceCreationLimitPolicy

FleetAttributes.Builder resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Parameters:

resourceCreationLimitPolicy - Fleet policy to limit the number of game sessions an individual player can create over a span of time.

Returns:

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

metricGroups

FleetAttributes.Builder metricGroups(Collection<String> metricGroups)

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for a fleets that are in a fleet metric group. Currently, a fleet can be included in only one metric group at a time.

Parameters:

metricGroups - Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for a fleets that are in a fleet metric group. Currently, a fleet can be included in only one metric group at a time.

Returns:

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

metricGroups

FleetAttributes.Builder metricGroups(String... metricGroups)

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for a fleets that are in a fleet metric group. Currently, a fleet can be included in only one metric group at a time.

NOTE: This method appends the values to the existing list (if any). Use #setMetricGroups(java.util.Collection) or #withMetricGroups(java.util.Collection) if you want to override the existing values.

Parameters:

metricGroups - Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for a fleets that are in a fleet metric group. Currently, a fleet can be included in only one metric group at a time.

Returns:

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