FleetAttributes (AWS SDK for Java

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>
```
Describes a GameLift fleet of game hosting resources.

Related actions

CreateFleet | DescribeFleetAttributes

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FleetAttributes.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FleetAttributes.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 the build resource that is deployed on instances in this fleet.
`CertificateConfiguration`	`certificateConfiguration()` Indicates whether a TLS/SSL certificate was generated for the fleet.
`Instant`	`creationTime()` A time stamp indicating when this data object was created.
`String`	`description()` A human-readable description of the fleet.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`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 the fleet.
`FleetType`	`fleetType()` The kind of instances, On-Demand or Spot, that this fleet uses.
`String`	`fleetTypeAsString()` The kind of instances, On-Demand or Spot, that this fleet uses.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLogPaths()` For responses, this returns true if the service returned a value for the LogPaths property.
`boolean`	`hasMetricGroups()` For responses, this returns true if the service returned a value for the MetricGroups property.
`boolean`	`hasStoppedActions()` For responses, this returns true if the service returned a value for the StoppedActions property.
`String`	`instanceRoleArn()` A unique identifier for an AWS IAM role that manages access to your AWS services.
`EC2InstanceType`	`instanceType()` The EC2 instance type that determines the computing resources of each instance in the fleet.
`String`	`instanceTypeAsString()` The EC2 instance type that determines the computing resources of each instance in the fleet.
`List<String>`	`logPaths()` This parameter is no longer used. Game session log paths are now defined using the GameLift server API `ProcessReady()` `logParameters`.
`List<String>`	`metricGroups()` Name of a metric group that metrics for this fleet are added to.
`String`	`name()` A descriptive label that is associated with a fleet.
`ProtectionPolicy`	`newGameSessionProtectionPolicy()` The type of game session protection to set on all new instances that are started in the fleet.
`String`	`newGameSessionProtectionPolicyAsString()` The type of game session protection to set on all new instances that are started in the fleet.
`OperatingSystem`	`operatingSystem()` The operating system of the fleet's computing resources.
`String`	`operatingSystemAsString()` The operating system of the fleet's computing resources.
`ResourceCreationLimitPolicy`	`resourceCreationLimitPolicy()` The fleet policy that limits 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 the Realtime script resource that is deployed on instances in this fleet.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FleetAttributes.Builder>`	`serializableBuilderClass()`
`String`	`serverLaunchParameters()` This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter.
`String`	`serverLaunchPath()` This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter.
`FleetStatus`	`status()` Current status of the fleet.
`String`	`statusAsString()` Current status of the fleet.
`List<FleetAction>`	`stoppedActions()` A list of fleet activity that has been suspended using StopFleetActions.
`List<String>`	`stoppedActionsAsStrings()` A list of fleet activity that has been suspended using StopFleetActions.
`Instant`	`terminationTime()` A 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()` Returns a string representation of this object.

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 final String fleetId()
```
    A unique identifier for the fleet.
    
    Returns:
    
    A unique identifier for the 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. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. 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. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.
  - fleetType
```
public final FleetType fleetType()
```
    The kind of instances, On-Demand or Spot, that this fleet uses.
    
    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:
    
    The kind of instances, On-Demand or Spot, that this fleet uses.
    
    See Also:
    
    FleetType
  - fleetTypeAsString
```
public final String fleetTypeAsString()
```
    The kind of instances, On-Demand or Spot, that this fleet uses.
    
    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:
    
    The kind of instances, On-Demand or Spot, that this fleet uses.
    
    See Also:
    
    FleetType
  - instanceType
```
public final EC2InstanceType instanceType()
```
    The EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the 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:
    
    The EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.
    
    See Also:
    
    EC2InstanceType
  - instanceTypeAsString
```
public final String instanceTypeAsString()
```
    The EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the 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:
    
    The EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.
    
    See Also:
    
    EC2InstanceType
  - description
```
public final String description()
```
    A human-readable description of the fleet.
    
    Returns:
    
    A 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()
```
    A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    A 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()
```
    A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
    
    Returns:
    
    A 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 -- 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 -- 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 -- 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 -- 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 the build resource that is deployed on instances in this fleet.
    
    Returns:
    
    A unique identifier for the build resource that is deployed on instances in this fleet.
  - 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 the Realtime script resource that is deployed on instances in this fleet.
    
    Returns:
    
    A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
  - 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()
```
    This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
    
    Returns:
    
    This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
  - serverLaunchParameters
```
public final String serverLaunchParameters()
```
    This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
    
    Returns:
    
    This parameter is no longer used. Server launch parameters are now defined using the fleet's RuntimeConfiguration parameter. Requests that use this parameter instead continue to be valid.
  - hasLogPaths
```
public final boolean hasLogPaths()
```
    For responses, this returns true if the service returned a value for the LogPaths property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - logPaths
```
public final List<String> logPaths()
```
    This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogPaths() method.
    
    Returns:
    
    This parameter is no longer used. Game session log paths are now defined using the GameLift server API ProcessReady() logParameters. See more information in the Server API Reference.
  - newGameSessionProtectionPolicy
```
public final ProtectionPolicy newGameSessionProtectionPolicy()
```
    The type of game session protection to set on all new instances that are 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 on all new instances that are 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 on all new instances that are 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 on all new instances that are 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()
```
    The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script 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:
    
    The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
    
    See Also:
    
    OperatingSystem
  - operatingSystemAsString
```
public final String operatingSystemAsString()
```
    The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script 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:
    
    The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
    
    See Also:
    
    OperatingSystem
  - resourceCreationLimitPolicy
```
public final ResourceCreationLimitPolicy resourceCreationLimitPolicy()
```
    The fleet policy that limits the number of game sessions an individual player can create over a span of time.
    
    Returns:
    
    The fleet policy that limits the number of game sessions an individual player can create over a span of time.
  - hasMetricGroups
```
public final boolean hasMetricGroups()
```
    For responses, this returns true if the service returned a value for the MetricGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - metricGroups
```
public final List<String> metricGroups()
```
    Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricGroups() method.
    
    Returns:
    
    Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.
  - stoppedActions
```
public final List<FleetAction> stoppedActions()
```
    A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStoppedActions() method.
    
    Returns:
    
    A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.
  - hasStoppedActions
```
public final boolean hasStoppedActions()
```
    For responses, this returns true if the service returned a value for the StoppedActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - stoppedActionsAsStrings
```
public final List<String> stoppedActionsAsStrings()
```
    A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStoppedActions() method.
    
    Returns:
    
    A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling.
  - instanceRoleArn
```
public final String instanceRoleArn()
```
    A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.
    
    Returns:
    
    A unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.
  - 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()
```
    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 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.62

Class FleetAttributes

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

fleetId

fleetArn

fleetType

fleetTypeAsString

instanceType

instanceTypeAsString

description

name

creationTime

terminationTime

status

statusAsString

buildId

buildArn

scriptId

scriptArn

serverLaunchPath

serverLaunchParameters

hasLogPaths

logPaths

newGameSessionProtectionPolicy

newGameSessionProtectionPolicyAsString

operatingSystem

operatingSystemAsString

resourceCreationLimitPolicy

hasMetricGroups

metricGroups

stoppedActions

hasStoppedActions

stoppedActionsAsStrings

instanceRoleArn

certificateConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields