Package software.amazon.awssdk.services.gamelift.model

Class FleetAttributes

    • 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 the FleetId 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 the FleetId value.

      • fleetType

        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 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 return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetTypeAsString().

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

      • fleetTypeAsString

        public 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 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 return FleetType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from fleetTypeAsString().

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

      • 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 -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

        • ACTIVE -- Hosts can now accept game sessions.

        • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

        • DELETING -- Hosts are responding to a delete fleet request.

        • TERMINATED -- The fleet no longer exists.

        If the service returns an enum value that is not available in the current SDK version, status will return FleetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        Current status of the fleet. Possible fleet statuses include the following:

        • NEW -- A new fleet has been defined and desired instances is set to 1.

        • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

        • ACTIVE -- Hosts can now accept game sessions.

        • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

        • DELETING -- Hosts are responding to a delete fleet request.

        • TERMINATED -- The fleet no longer exists.

        See Also:
        FleetStatus

      • statusAsString

        public final String statusAsString()

        Current status of the fleet. Possible fleet statuses include the following:

        • NEW -- A new fleet has been defined and desired instances is set to 1.

        • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

        • ACTIVE -- Hosts can now accept game sessions.

        • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

        • DELETING -- Hosts are responding to a delete fleet request.

        • TERMINATED -- The fleet no longer exists.

        If the service returns an enum value that is not available in the current SDK version, status will return FleetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        Current status of the fleet. Possible fleet statuses include the following:

        • NEW -- A new fleet has been defined and desired instances is set to 1.

        • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

        • ACTIVE -- Hosts can now accept game sessions.

        • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

        • DELETING -- Hosts are responding to a delete fleet request.

        • TERMINATED -- The fleet no longer exists.

        See Also:
        FleetStatus

      • buildId

        public final String buildId()

        A unique identifier for 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 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

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

        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.

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

        • 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()
        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 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 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

        public final CertificateConfiguration certificateConfiguration()
        Returns the value of the CertificateConfiguration property for this object.
        Returns:
        The value of the CertificateConfiguration property for this object.

      • 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, computeType will return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeTypeAsString().

        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, computeType will return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeTypeAsString().

        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()
        Returns the value of the AnywhereConfiguration property for this object.
        Returns:
        The value of the AnywhereConfiguration property for this object.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)