@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
| Modifier and Type | Class and Description |
|---|---|
static interface |
FleetAttributes.Builder |
| Modifier and Type | Method and Description |
|---|---|
AnywhereConfiguration |
anywhereConfiguration()
Returns the value of the AnywhereConfiguration property for this object.
|
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()
Returns the value of the CertificateConfiguration property for this object.
|
ComputeType |
computeType()
The type of compute resource used to host your game servers.
|
String |
computeTypeAsString()
The type of compute resource used to host your game servers.
|
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) |
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()
Indicates whether to use On-Demand or Spot instances for this fleet.
|
String |
fleetTypeAsString()
Indicates whether to use On-Demand or Spot instances for this fleet.
|
<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 IAM role that manages access to your Amazon Web Services services.
|
EC2InstanceType |
instanceType()
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.
|
String |
instanceTypeAsString()
The Amazon 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()
Returns the value of the ResourceCreationLimitPolicy property for this object.
|
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 runtime
configuration .
|
String |
serverLaunchPath()
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration .
|
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() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String fleetId()
A unique identifier for the fleet.
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.
arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a
GameLift fleet ARN, the resource ID matches the FleetId value.public final FleetType fleetType()
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
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().
ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.FleetTypepublic final String fleetTypeAsString()
Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to
ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
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().
ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.FleetTypepublic final EC2InstanceType instanceType()
The Amazon 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 Elastic Compute Cloud 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().
EC2InstanceTypepublic final String instanceTypeAsString()
The Amazon 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 Elastic Compute Cloud 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().
EC2InstanceTypepublic final String description()
A human-readable description of the fleet.
public final String name()
A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
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").
"1469498468.057").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").
"1469498468.057").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().
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.
FleetStatuspublic 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().
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.
FleetStatuspublic final String buildId()
A unique identifier for the build resource that is deployed on instances in this fleet.
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.
BuildId value.public final String scriptId()
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
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.
ScriptId value.public final String serverLaunchPath()
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration . Requests that use this parameter instead continue to be valid.
public final String serverLaunchParameters()
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration . Requests that use this parameter instead continue to be valid.
public final boolean hasLogPaths()
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.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.
ProcessReady() logParameters. See more information in the Server API Reference.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().
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.
ProtectionPolicypublic 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().
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.
ProtectionPolicypublic 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().
OperatingSystempublic 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().
OperatingSystempublic final ResourceCreationLimitPolicy resourceCreationLimitPolicy()
public final boolean hasMetricGroups()
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.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.
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.
public final boolean hasStoppedActions()
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.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.
public final String instanceRoleArn()
A unique identifier for an IAM role that manages access to your Amazon Web Services 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 Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.
public final CertificateConfiguration certificateConfiguration()
public final ComputeType computeType()
The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
If the service returns an enum value that is not available in the current SDK version, computeType will
return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
computeTypeAsString().
ComputeTypepublic final String computeTypeAsString()
The type of compute resource used to host your game servers. You can use your own compute resources with GameLift Anywhere or use Amazon EC2 instances with managed GameLift.
If the service returns an enum value that is not available in the current SDK version, computeType will
return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
computeTypeAsString().
ComputeTypepublic final AnywhereConfiguration anywhereConfiguration()
public FleetAttributes.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<FleetAttributes.Builder,FleetAttributes>public static FleetAttributes.Builder builder()
public static Class<? extends FleetAttributes.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2022. All rights reserved.