public static interface FleetAttributes.Builder extends CopyableBuilder<FleetAttributes.Builder,FleetAttributes>
Modifier and Type | Method and Description |
---|---|
FleetAttributes.Builder |
buildId(String buildId)
Unique identifier for a build.
|
FleetAttributes.Builder |
creationTime(Instant 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(Collection<String> logPaths)
Location of default log files.
|
FleetAttributes.Builder |
logPaths(String... logPaths)
Location of default log files.
|
FleetAttributes.Builder |
metricGroups(Collection<String> metricGroups)
Names of metric groups that this fleet is included in.
|
FleetAttributes.Builder |
metricGroups(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(ProtectionPolicy newGameSessionProtectionPolicy)
Type of game session protection to set for all new instances started in the fleet.
|
FleetAttributes.Builder |
newGameSessionProtectionPolicy(String newGameSessionProtectionPolicy)
Type of game session protection to set for all new instances started in the fleet.
|
FleetAttributes.Builder |
operatingSystem(OperatingSystem operatingSystem)
Operating system of the fleet's computing resources.
|
FleetAttributes.Builder |
operatingSystem(String operatingSystem)
Operating system of the fleet's computing resources.
|
default FleetAttributes.Builder |
resourceCreationLimitPolicy(Consumer<ResourceCreationLimitPolicy.Builder> resourceCreationLimitPolicy)
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
|
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 before 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 before 2016-08-04 (or AWS
SDK v.
|
FleetAttributes.Builder |
status(FleetStatus status)
Current status of the fleet.
|
FleetAttributes.Builder |
status(String status)
Current status of the fleet.
|
FleetAttributes.Builder |
terminationTime(Instant terminationTime)
Time stamp indicating when this data object was terminated.
|
copy
apply, build
FleetAttributes.Builder fleetId(String fleetId)
Unique identifier for a fleet.
fleetId
- Unique identifier for a fleet.FleetAttributes.Builder fleetArn(String fleetArn)
Identifier for a fleet that is unique across all regions.
fleetArn
- Identifier for a fleet that is unique across all regions.FleetAttributes.Builder description(String description)
Human-readable description of the fleet.
description
- Human-readable description of the fleet.FleetAttributes.Builder name(String name)
Descriptive label that is associated with a fleet. Fleet names do not need to be unique.
name
- Descriptive label that is associated with a fleet. Fleet names do not need to be unique.FleetAttributes.Builder creationTime(Instant creationTime)
Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
creationTime
- Time stamp indicating when this data object was created. Format is a number expressed in Unix time as
milliseconds (for example "1469498468.057").FleetAttributes.Builder terminationTime(Instant terminationTime)
Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
terminationTime
- Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time
as milliseconds (for example "1469498468.057").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.
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.
FleetStatus
,
FleetStatus
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.
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.
FleetStatus
,
FleetStatus
FleetAttributes.Builder buildId(String buildId)
Unique identifier for a build.
buildId
- Unique identifier for a build.FleetAttributes.Builder serverLaunchPath(String serverLaunchPath)
Path to a game server executable in the fleet's build, specified for fleets created before 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.
serverLaunchPath
- Path to a game server executable in the fleet's build, specified for fleets created before 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.FleetAttributes.Builder serverLaunchParameters(String serverLaunchParameters)
Game server launch parameters specified for fleets created before 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.
serverLaunchParameters
- Game server launch parameters specified for fleets created before 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.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
automatically uploads 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.
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
automatically uploads 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.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
automatically uploads 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.
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
automatically uploads 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.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.
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.
ProtectionPolicy
,
ProtectionPolicy
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.
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.
ProtectionPolicy
,
ProtectionPolicy
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.
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.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.
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.OperatingSystem
,
OperatingSystem
FleetAttributes.Builder resourceCreationLimitPolicy(ResourceCreationLimitPolicy resourceCreationLimitPolicy)
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
resourceCreationLimitPolicy
- Fleet policy to limit the number of game sessions an individual player can create over a span of time.default FleetAttributes.Builder resourceCreationLimitPolicy(Consumer<ResourceCreationLimitPolicy.Builder> resourceCreationLimitPolicy)
Fleet policy to limit the number of game sessions an individual player can create over a span of time.
This is a convenience that creates an instance of theResourceCreationLimitPolicy.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)
.resourceCreationLimitPolicy
- a consumer that will call methods on ResourceCreationLimitPolicy.Builder
resourceCreationLimitPolicy(ResourceCreationLimitPolicy)
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 fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.
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 fleets that are in a fleet metric group. A fleet can be
included in only one metric group at a time.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 fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.
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 fleets that are in a fleet metric group. A fleet can be
included in only one metric group at a time.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.