software.amazon.awssdk.services.gamelift.model

Class FleetAttributes

java.lang.Object

software.amazon.awssdk.services.gamelift.model.FleetAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FleetAttributes.Builder,FleetAttributes>

@Generated(value="software.amazon.awssdk:codegen")
public final class FleetAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<FleetAttributes.Builder,FleetAttributes>

General properties describing a fleet.

Fleet-related operations include:

• CreateFleet

• ListFleets

• DeleteFleet

• Describe fleets:

  • DescribeFleetAttributes

  • DescribeFleetCapacity

  • DescribeFleetPortSettings

  • DescribeFleetUtilization

  • DescribeRuntimeConfiguration

  • DescribeEC2InstanceLimits

  • DescribeFleetEvents

• Update fleets:

  • UpdateFleetAttributes

  • UpdateFleetCapacity

  • UpdateFleetPortSettings

  • UpdateRuntimeConfiguration

• Manage fleet actions:

  • StartFleetActions

  • StopFleetActions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FleetAttributes.Builder

Method Summary

Modifier and Type	Method and Description
static FleetAttributes.Builder	builder()
String	buildId() Unique identifier for a build.
Instant	creationTime() Time stamp indicating when this data object was created.
String	description() Human-readable description of the fleet.
boolean	equals(Object obj)
String	fleetArn() Identifier for a fleet that is unique across all regions.
String	fleetId() Unique identifier for a fleet.
FleetType	fleetType() Indicates whether the fleet uses on-demand or spot instances.
String	fleetTypeAsString() Indicates whether the fleet uses on-demand or spot instances.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
EC2InstanceType	instanceType() EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity.
String	instanceTypeAsString() EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity.
List<String>	logPaths() Location of default log files.
List<String>	metricGroups() Names of metric groups that this fleet is included in.
String	name() Descriptive label that is associated with a fleet.
ProtectionPolicy	newGameSessionProtectionPolicy() Type of game session protection to set for all new instances started in the fleet.
String	newGameSessionProtectionPolicyAsString() Type of game session protection to set for all new instances started in the fleet.
OperatingSystem	operatingSystem() Operating system of the fleet's computing resources.
String	operatingSystemAsString() Operating system of the fleet's computing resources.
ResourceCreationLimitPolicy	resourceCreationLimitPolicy() Fleet policy to limit the number of game sessions an individual player can create over a span of time.
List<SdkField<?>>	sdkFields()
static Class<? extends FleetAttributes.Builder>	serializableBuilderClass()
String	serverLaunchParameters() Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v.
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.
FleetStatus	status() Current status of the fleet.
String	statusAsString() Current status of the fleet.
List<FleetAction>	stoppedActions() List of fleet actions that have been suspended using StopFleetActions.
List<String>	stoppedActionsAsStrings() List of fleet actions that have been suspended using StopFleetActions.
Instant	terminationTime() Time stamp indicating when this data object was terminated.
FleetAttributes.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

fleetId

public String fleetId()

Unique identifier for a fleet.

Returns:

Unique identifier for a fleet.

fleetArn

public String fleetArn()

Identifier for a fleet that is unique across all regions.

Returns:

Identifier for a fleet that is unique across all regions.

fleetType

public FleetType fleetType()

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

If the service returns an enum value that is not available in the current SDK version, fleetType will return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetTypeAsString().

Returns:

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

See Also:

FleetType

fleetTypeAsString

public String fleetTypeAsString()

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

If the service returns an enum value that is not available in the current SDK version, fleetType will return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetTypeAsString().

Returns:

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

See Also:

FleetType

instanceType

public EC2InstanceType instanceType()

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

If the service returns an enum value that is not available in the current SDK version, instanceType will return EC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

See Also:

EC2InstanceType

instanceTypeAsString

public String instanceTypeAsString()

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

If the service returns an enum value that is not available in the current SDK version, instanceType will return EC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

Returns:

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

See Also:

EC2InstanceType

description

public String description()

Human-readable description of the fleet.

Returns:

Human-readable description of the fleet.

name

public String name()

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

Returns:

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

creationTime

public 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").

Returns:

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

terminationTime

public 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").

Returns:

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

status

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

If the service returns an enum value that is not available in the current SDK version, status will return FleetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

FleetStatus

statusAsString

public String statusAsString()

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.

If the service returns an enum value that is not available in the current SDK version, status will return FleetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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.

See Also:

FleetStatus

buildId

public String buildId()

Unique identifier for a build.

Returns:

Unique identifier for a build.

serverLaunchPath

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

Returns:

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.

serverLaunchParameters

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

Returns:

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.

logPaths

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

newGameSessionProtectionPolicy

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

If the service returns an enum value that is not available in the current SDK version, newGameSessionProtectionPolicy will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from newGameSessionProtectionPolicyAsString().

Returns:

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.

See Also:

ProtectionPolicy

newGameSessionProtectionPolicyAsString

public String newGameSessionProtectionPolicyAsString()

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.

If the service returns an enum value that is not available in the current SDK version, newGameSessionProtectionPolicy will return ProtectionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from newGameSessionProtectionPolicyAsString().

Returns:

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.

See Also:

ProtectionPolicy

operatingSystem

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

If the service returns an enum value that is not available in the current SDK version, operatingSystem will return OperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatingSystemAsString().

Returns:

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.

See Also:

OperatingSystem

operatingSystemAsString

public String operatingSystemAsString()

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.

If the service returns an enum value that is not available in the current SDK version, operatingSystem will return OperatingSystem.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatingSystemAsString().

Returns:

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.

See Also:

OperatingSystem

resourceCreationLimitPolicy

public ResourceCreationLimitPolicy resourceCreationLimitPolicy()

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

Returns:

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

metricGroups

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

stoppedActions

public List<FleetAction> stoppedActions()

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

stoppedActionsAsStrings

public List<String> stoppedActionsAsStrings()

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

toBuilder

public FleetAttributes.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<FleetAttributes.Builder,FleetAttributes>

Returns:

a builder for type T

builder

public static FleetAttributes.Builder builder()

serializableBuilderClass

public static Class<? extends FleetAttributes.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.