Class FleetAttributes
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FleetAttributes.Builder,
FleetAttributes>
Describes a Amazon GameLift fleet of game hosting resources.
Related actions
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AnywhereConfiguration
Returns the value of the AnywhereConfiguration property for this object.final String
buildArn()
The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet.static FleetAttributes.Builder
builder()
final String
buildId()
A unique identifier for the build resource that is deployed on instances in this fleet.final CertificateConfiguration
Returns the value of the CertificateConfiguration property for this object.final ComputeType
The type of compute resource used to host your game servers.final String
The type of compute resource used to host your game servers.final Instant
A time stamp indicating when this data object was created.final String
A human-readable description of the fleet.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
fleetArn()
The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.final String
fleetId()
A unique identifier for the fleet.final FleetType
Indicates whether to use On-Demand or Spot instances for this fleet.final String
Indicates whether to use On-Demand or Spot instances for this fleet.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the LogPaths property.final boolean
For responses, this returns true if the service returned a value for the MetricGroups property.final boolean
For responses, this returns true if the service returned a value for the StoppedActions property.final String
A unique identifier for an IAM role with access permissions to other Amazon Web Services services.Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
.final String
Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn
.final EC2InstanceType
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.final String
The Amazon EC2 instance type that determines the computing resources of each instance in the fleet.logPaths()
This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server APIProcessReady()
logParameters
.Name of a metric group that metrics for this fleet are added to.final String
name()
A descriptive label that is associated with a fleet.final ProtectionPolicy
The type of game session protection to set on all new instances that are started in the fleet.final String
The type of game session protection to set on all new instances that are started in the fleet.final OperatingSystem
The operating system of the fleet's computing resources.final String
The operating system of the fleet's computing resources.Returns the value of the ResourceCreationLimitPolicy property for this object.final String
The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet.final String
scriptId()
A unique identifier for the Realtime script resource that is deployed on instances in this fleet.static Class
<? extends FleetAttributes.Builder> final String
This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration .final String
This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration .final FleetStatus
status()
Current status of the fleet.final String
Current status of the fleet.final List
<FleetAction> A list of fleet activity that has been suspended using StopFleetActions .A list of fleet activity that has been suspended using StopFleetActions .final Instant
A time stamp indicating when this data object was terminated.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
fleetId
A unique identifier for the fleet.
- Returns:
- A unique identifier for the fleet.
-
fleetArn
The Amazon Resource Name (ARN) that is assigned to a Amazon 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 theFleetId
value.- Returns:
- The Amazon Resource Name (ARN) that is assigned to a
Amazon 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 theFleetId
value.
-
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 fleet property can't 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 returnFleetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfleetTypeAsString()
.- Returns:
- 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 fleet property can't be changed after the fleet is created. - See Also:
-
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 fleet property can't 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 returnFleetType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfleetTypeAsString()
.- Returns:
- 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 fleet property can't be changed after the fleet is created. - See Also:
-
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 returnEC2InstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- 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.
- See Also:
-
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 returnEC2InstanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTypeAsString()
.- Returns:
- 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.
- See Also:
-
description
A human-readable description of the fleet.
- Returns:
- A human-readable description of the fleet.
-
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
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
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
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 returnFleetStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
-
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 returnFleetStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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:
-
-
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
The Amazon Resource Name (ARN) associated with the Amazon 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
Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the
resource ID matches the
BuildId
value.
-
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
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
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.
- Returns:
- 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.
-
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.
- Returns:
- 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.
-
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 theisEmpty()
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
This parameter is no longer used. Game session log paths are now defined using the Amazon 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 Amazon GameLift
server API
ProcessReady()
logParameters
. See more information in the Server API Reference.
-
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 returnProtectionPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnewGameSessionProtectionPolicyAsString()
.- 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:
-
-
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 returnProtectionPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnewGameSessionProtectionPolicyAsString()
.- 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:
-
-
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 returnOperatingSystem.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatingSystemAsString()
.- 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:
-
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 returnOperatingSystem.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatingSystemAsString()
.- 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:
-
resourceCreationLimitPolicy
Returns the value of the ResourceCreationLimitPolicy property for this object.- Returns:
- The value of the ResourceCreationLimitPolicy property for this object.
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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
A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets.
- Returns:
- A unique identifier for an IAM role with access permissions to other Amazon Web Services services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with Amazon Web Services resources that you own or have access to. For more information about using the role with your game server builds, see Communicate with other Amazon Web Services resources from your fleets.
-
certificateConfiguration
Returns the value of the CertificateConfiguration property for this object.- Returns:
- The value of the CertificateConfiguration property for this object.
-
computeType
The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
If the service returns an enum value that is not available in the current SDK version,
computeType
will returnComputeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomputeTypeAsString()
.- Returns:
- The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
- See Also:
-
computeTypeAsString
The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
If the service returns an enum value that is not available in the current SDK version,
computeType
will returnComputeType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomputeTypeAsString()
.- Returns:
- The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
- See Also:
-
anywhereConfiguration
Returns the value of the AnywhereConfiguration property for this object.- Returns:
- The value of the AnywhereConfiguration property for this object.
-
instanceRoleCredentialsProvider
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn
. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.If the service returns an enum value that is not available in the current SDK version,
instanceRoleCredentialsProvider
will returnInstanceRoleCredentialsProvider.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceRoleCredentialsProviderAsString()
.- Returns:
- Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn
. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets. - See Also:
-
instanceRoleCredentialsProviderAsString
Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn
. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets.If the service returns an enum value that is not available in the current SDK version,
instanceRoleCredentialsProvider
will returnInstanceRoleCredentialsProvider.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceRoleCredentialsProviderAsString()
.- Returns:
- Indicates that fleet instances maintain a shared credentials file for the IAM role defined in
InstanceRoleArn
. Shared credentials allow applications that are deployed with the game server executable to communicate with other Amazon Web Services resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see Communicate with other Amazon Web Services resources from your fleets. - See Also:
-
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 interfaceToCopyableBuilder<FleetAttributes.Builder,
FleetAttributes> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-