Class FleetAttributes
- java.lang.Object
-
- software.amazon.awssdk.services.gamelift.model.FleetAttributes
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FleetAttributes.Builder,FleetAttributes>
@Generated("software.amazon.awssdk:codegen") public final class FleetAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FleetAttributes.Builder,FleetAttributes>
This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.
Describes an Amazon GameLift fleet of game hosting resources. Attributes differ based on the fleet's compute type, as follows:
-
EC2 fleet attributes identify a
Buildresource (for fleets with customer game server builds) or aScriptresource (for Realtime Servers fleets). -
Container fleets have
ContainerGroupsAttributes, which identify the fleet'sContainerGroupDefinitionresources. -
Amazon GameLift Anywhere fleets have an abbreviated set of attributes, because most fleet configurations are set directly on the fleet's computes. Attributes include fleet identifiers and descriptive properties, creation/termination time, and fleet status.
Returned by: DescribeFleetAttributes
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFleetAttributes.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AnywhereConfigurationanywhereConfiguration()This property is used with the Amazon GameLift containers feature, which is currently in public preview. A set of attributes that describe the container groups that are deployed on the fleet.StringbuildArn()The Amazon Resource Name (ARN) associated with the Amazon GameLift build resource that is deployed on instances in this fleet.static FleetAttributes.Builderbuilder()StringbuildId()A unique identifier for the build resource that is deployed on instances in this fleet.CertificateConfigurationcertificateConfiguration()Determines whether a TLS/SSL certificate is generated for a fleet.ComputeTypecomputeType()The type of compute resource used to host your game servers.StringcomputeTypeAsString()The type of compute resource used to host your game servers.ContainerGroupsAttributescontainerGroupsAttributes()A set of properties that describe the container groups that are deployed to the fleet.InstantcreationTime()A time stamp indicating when this data object was created.Stringdescription()A human-readable description of the fleet.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringfleetArn()The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.StringfleetId()A unique identifier for the fleet.FleetTypefleetType()Indicates whether the fleet uses On-Demand or Spot instances.StringfleetTypeAsString()Indicates whether the fleet uses On-Demand or Spot instances.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasLogPaths()For responses, this returns true if the service returned a value for the LogPaths property.booleanhasMetricGroups()For responses, this returns true if the service returned a value for the MetricGroups property.booleanhasStoppedActions()For responses, this returns true if the service returned a value for the StoppedActions property.StringinstanceRoleArn()A unique identifier for an IAM role with access permissions to other Amazon Web Services services.InstanceRoleCredentialsProviderinstanceRoleCredentialsProvider()Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn.StringinstanceRoleCredentialsProviderAsString()Indicates that fleet instances maintain a shared credentials file for the IAM role defined inInstanceRoleArn.EC2InstanceTypeinstanceType()The Amazon EC2 instance type that the fleet uses.StringinstanceTypeAsString()The Amazon EC2 instance type that the fleet uses.List<String>logPaths()This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server APIProcessReady()logParameters.List<String>metricGroups()Name of a metric group that metrics for this fleet are added to.Stringname()A descriptive label that is associated with a fleet.ProtectionPolicynewGameSessionProtectionPolicy()The type of game session protection to set on all new instances that are started in the fleet.StringnewGameSessionProtectionPolicyAsString()The type of game session protection to set on all new instances that are started in the fleet.OperatingSystemoperatingSystem()The operating system of the fleet's computing resources.StringoperatingSystemAsString()The operating system of the fleet's computing resources.ResourceCreationLimitPolicyresourceCreationLimitPolicy()Returns the value of the ResourceCreationLimitPolicy property for this object.StringscriptArn()The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet.StringscriptId()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()StringserverLaunchParameters()This parameter is no longer used. Server launch parameters are now defined using the fleet's runtime configuration.StringserverLaunchPath()This parameter is no longer used. Server launch paths are now defined using the fleet's RuntimeConfiguration.FleetStatusstatus()Current status of the fleet.StringstatusAsString()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.InstantterminationTime()A time stamp indicating when this data object was terminated.FleetAttributes.BuildertoBuilder()StringtoString()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 the fleet.
- Returns:
- A unique identifier for the fleet.
-
fleetArn
public final String 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 theFleetIdvalue.- 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 theFleetIdvalue.
-
fleetType
public final FleetType fleetType()
Indicates whether the fleet uses On-Demand or Spot instances. For more information, see 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,
fleetTypewill returnFleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfleetTypeAsString().- Returns:
- Indicates whether the fleet uses On-Demand or Spot instances. For more information, see On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
- See Also:
FleetType
-
fleetTypeAsString
public final String fleetTypeAsString()
Indicates whether the fleet uses On-Demand or Spot instances. For more information, see 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,
fleetTypewill returnFleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfleetTypeAsString().- Returns:
- Indicates whether the fleet uses On-Demand or Spot instances. For more information, see On-Demand versus Spot Instances. This fleet property can't be changed after the fleet is created.
- See Also:
FleetType
-
instanceType
public final EC2InstanceType instanceType()
The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".If the service returns an enum value that is not available in the current SDK version,
instanceTypewill returnEC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominstanceTypeAsString().- Returns:
- The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of
each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for
detailed descriptions. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container". - See Also:
EC2InstanceType
-
instanceTypeAsString
public final String instanceTypeAsString()
The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".If the service returns an enum value that is not available in the current SDK version,
instanceTypewill returnEC2InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frominstanceTypeAsString().- Returns:
- The Amazon EC2 instance type that the fleet uses. Instance type determines the computing resources of
each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for
detailed descriptions. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container". - 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 resource has been defined and Amazon GameLift has started creating the fleet. Desired instances is set to 1.
-
DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift is download the game server build, running install scripts, and then validating the build files. When complete, Amazon GameLift launches a fleet instance.
-
ACTIVATING -- Amazon GameLift is launching a game server process and testing its connectivity with the Amazon GameLift service.
-
ACTIVE -- The fleet is now ready to host 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,
statuswill 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 resource has been defined and Amazon GameLift has started creating the fleet. Desired instances is set to 1.
-
DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift is download the game server build, running install scripts, and then validating the build files. When complete, Amazon GameLift launches a fleet instance.
-
ACTIVATING -- Amazon GameLift is launching a game server process and testing its connectivity with the Amazon GameLift service.
-
ACTIVE -- The fleet is now ready to host 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 resource has been defined and Amazon GameLift has started creating the fleet. Desired instances is set to 1.
-
DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift is download the game server build, running install scripts, and then validating the build files. When complete, Amazon GameLift launches a fleet instance.
-
ACTIVATING -- Amazon GameLift is launching a game server process and testing its connectivity with the Amazon GameLift service.
-
ACTIVE -- The fleet is now ready to host 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,
statuswill 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 resource has been defined and Amazon GameLift has started creating the fleet. Desired instances is set to 1.
-
DOWNLOADING/VALIDATING/BUILDING -- Amazon GameLift is download the game server build, running install scripts, and then validating the build files. When complete, Amazon GameLift launches a fleet instance.
-
ACTIVATING -- Amazon GameLift is launching a game server process and testing its connectivity with the Amazon GameLift service.
-
ACTIVE -- The fleet is now ready to host 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. This attribute is used with fleets where
ComputeTypeis "EC2".- Returns:
- A unique identifier for the build resource that is deployed on instances in this fleet. This attribute is
used with fleets where
ComputeTypeis "EC2".
-
buildArn
public final String 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
BuildIdvalue. This attribute is used with fleets whereComputeTypeis "EC2".- 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
BuildIdvalue. This attribute is used with fleets whereComputeTypeis "EC2".
-
scriptId
public final String scriptId()
A unique identifier for the Realtime script resource that is deployed on instances in this fleet. This attribute is used with fleets where
ComputeTypeis "EC2".- Returns:
- A unique identifier for the Realtime script resource that is deployed on instances in this fleet. This
attribute is used with fleets where
ComputeTypeis "EC2".
-
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
ScriptIdvalue.- 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
ScriptIdvalue.
-
serverLaunchPath
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 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 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 runtime configuration. Requests that use this parameter 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 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
public final List<String> 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
public final ProtectionPolicy newGameSessionProtectionPolicy()
The type of game session protection to set on all new instances that are started in the fleet. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".-
NoProtection -- The game session can be terminated during a scale-down event.
-
FullProtection -- If the game session is in an
ACTIVEstatus, 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,
newGameSessionProtectionPolicywill 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. This
attribute is used with fleets where
ComputeTypeis "EC2" or "Container".-
NoProtection -- The game session can be terminated during a scale-down event.
-
FullProtection -- If the game session is in an
ACTIVEstatus, 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. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".-
NoProtection -- The game session can be terminated during a scale-down event.
-
FullProtection -- If the game session is in an
ACTIVEstatus, 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,
newGameSessionProtectionPolicywill 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. This
attribute is used with fleets where
ComputeTypeis "EC2" or "Container".-
NoProtection -- The game session can be terminated during a scale-down event.
-
FullProtection -- If the game session is in an
ACTIVEstatus, 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. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
If the service returns an enum value that is not available in the current SDK version,
operatingSystemwill 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. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
- 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. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
If the service returns an enum value that is not available in the current SDK version,
operatingSystemwill 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. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the Amazon Linux 2 FAQs. For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See Migrate to Amazon GameLift server SDK version 5.
- See Also:
OperatingSystem
-
resourceCreationLimitPolicy
public final ResourceCreationLimitPolicy 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
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. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".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. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".
-
stoppedActions
public final List<FleetAction> stoppedActions()
A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".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. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".
-
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
public final List<String> stoppedActionsAsStrings()
A list of fleet activity that has been suspended using StopFleetActions. This includes fleet auto-scaling. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".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. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".
-
instanceRoleArn
public final String 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. This attribute is used with fleets where
ComputeTypeis "EC2" or "Container".- 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. This attribute is used with
fleets where
ComputeTypeis "EC2" or "Container".
-
certificateConfiguration
public final CertificateConfiguration certificateConfiguration()
Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate.
- Returns:
- Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate.
-
computeType
public final ComputeType 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,
computeTypewill 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:
ComputeType
-
computeTypeAsString
public final String 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,
computeTypewill 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:
ComputeType
-
anywhereConfiguration
public final AnywhereConfiguration anywhereConfiguration()
This property is used with the Amazon GameLift containers feature, which is currently in public preview. A set of attributes that describe the container groups that are deployed on the fleet. These attributes are included for fleets with compute type
CONTAINERonly. This attribute is used with fleets whereComputeTypeis "Container".- Returns:
- This property is used with the Amazon GameLift containers feature, which is currently in public
preview. A set of attributes that describe the container groups that are deployed on the fleet. These
attributes are included for fleets with compute type
CONTAINERonly. This attribute is used with fleets whereComputeTypeis "Container".
-
instanceRoleCredentialsProvider
public final InstanceRoleCredentialsProvider 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. This attribute is used with fleets whereComputeTypeis "EC2" or "Container".If the service returns an enum value that is not available in the current SDK version,
instanceRoleCredentialsProviderwill 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. This attribute is used with fleets whereComputeTypeis "EC2" or "Container". - See Also:
InstanceRoleCredentialsProvider
-
instanceRoleCredentialsProviderAsString
public final String 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. This attribute is used with fleets whereComputeTypeis "EC2" or "Container".If the service returns an enum value that is not available in the current SDK version,
instanceRoleCredentialsProviderwill 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. This attribute is used with fleets whereComputeTypeis "EC2" or "Container". - See Also:
InstanceRoleCredentialsProvider
-
containerGroupsAttributes
public final ContainerGroupsAttributes containerGroupsAttributes()
A set of properties that describe the container groups that are deployed to the fleet. These attributes are included for fleets with compute type
CONTAINER.- Returns:
- A set of properties that describe the container groups that are deployed to the fleet. These attributes
are included for fleets with compute type
CONTAINER.
-
toBuilder
public FleetAttributes.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FleetAttributes.Builder,FleetAttributes>
-
builder
public static FleetAttributes.Builder builder()
-
serializableBuilderClass
public static Class<? extends FleetAttributes.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-