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.

• CreateFleet

• ListFleets

• DeleteFleet

• DescribeFleetAttributes

• UpdateFleetAttributes

• StartFleetActions or 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
String	buildArn() The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet.
static FleetAttributes.Builder	builder()
String	buildId() A unique identifier for a build.
CertificateConfiguration	certificateConfiguration() Indicates whether a TLS/SSL certificate was generated for the fleet.
Instant	creationTime() Time stamp indicating when this data object was created.
String	description() Human-readable description of the fleet.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	fleetArn() The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it.
String	fleetId() A 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()
boolean	hasLogPaths() Returns true if the LogPaths property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasMetricGroups() Returns true if the MetricGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasStoppedActions() Returns true if the StoppedActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	instanceRoleArn() A unique identifier for an AWS IAM role that manages access to your AWS services.
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() A descriptive label that is associated with a fleet.
ProtectionPolicy	newGameSessionProtectionPolicy() The type of game session protection to set for all new instances started in the fleet.
String	newGameSessionProtectionPolicyAsString() The 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.
String	scriptArn() The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet.
String	scriptId() A unique identifier for a Realtime script.
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 activity that have been suspended using StopFleetActions.
List<String>	stoppedActionsAsStrings() List of fleet activity that have been suspended using StopFleetActions.
Instant	terminationTime() Time stamp indicating when this data object was terminated.
FleetAttributes.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

fleetId

public final String fleetId()

A unique identifier for a fleet.

Returns:

A unique identifier for a fleet.

fleetArn

public final String fleetArn()

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

Returns:

The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift fleet ARN, the resource ID matches the FleetId value.

fleetType

public final 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 final 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 final 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 final 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 final String description()

Human-readable description of the fleet.

Returns:

Human-readable description of the fleet.

name

public final String name()

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

Returns:

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

creationTime

public final 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 final 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 final 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 or Realtime script 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 or Realtime script 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 final 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 or Realtime script 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 or Realtime script 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 final String buildId()

A unique identifier for a build.

Returns:

A unique identifier for a build.

buildArn

public final String buildArn()

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

Returns:

The Amazon Resource Name (ARN) associated with the GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the BuildId value.

scriptId

public final String scriptId()

A unique identifier for a Realtime script.

Returns:

A unique identifier for a Realtime script.

scriptArn

public final String scriptArn()

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

Returns:

The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.

serverLaunchPath

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

hasLogPaths

public final boolean hasLogPaths()

Returns true if the LogPaths property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

logPaths

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

You can use hasLogPaths() to see if a value was sent in this field.

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 final ProtectionPolicy newGameSessionProtectionPolicy()

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

The 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 final String newGameSessionProtectionPolicyAsString()

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

The 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 final 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 final 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 final 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.

hasMetricGroups

public final boolean hasMetricGroups()

Returns true if the MetricGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

metricGroups

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

You can use hasMetricGroups() to see if a value was sent in this field.

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 final List<FleetAction> stoppedActions()

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

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

You can use hasStoppedActions() to see if a value was sent in this field.

Returns:

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

hasStoppedActions

public final boolean hasStoppedActions()

Returns true if the StoppedActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

stoppedActionsAsStrings

public final List<String> stoppedActionsAsStrings()

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

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

You can use hasStoppedActions() to see if a value was sent in this field.

Returns:

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

instanceRoleArn

public final String instanceRoleArn()

A unique identifier for an AWS IAM role that manages access to your AWS services.

Returns:

A unique identifier for an AWS IAM role that manages access to your AWS services.

certificateConfiguration

public final CertificateConfiguration certificateConfiguration()

Indicates whether a TLS/SSL certificate was generated for the fleet.

Returns:

Indicates whether a TLS/SSL certificate was generated for the fleet.

toBuilder

public FleetAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FleetAttributes.Builder,FleetAttributes>

builder

public static FleetAttributes.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo