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

Class UpdateFleetAttributesRequest

    • Method Detail

      • fleetId

        public final String fleetId()

        A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

        Returns:
        A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN value.

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

      • description

        public final String description()

        A human-readable description of a fleet.

        Returns:
        A human-readable description of a fleet.

      • newGameSessionProtectionPolicy

        public final ProtectionPolicy newGameSessionProtectionPolicy()

        The game session protection policy to apply to all new game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions using UpdateGameSession .

        • 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 game session protection policy to apply to all new game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions using UpdateGameSession .

        • 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 game session protection policy to apply to all new game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions using UpdateGameSession .

        • 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 game session protection policy to apply to all new game sessions created in this fleet. Game sessions that already exist are not affected. You can set protection for individual game sessions using UpdateGameSession .

        • 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

      • resourceCreationLimitPolicy

        public final ResourceCreationLimitPolicy resourceCreationLimitPolicy()

        Policy settings that limit the number of game sessions an individual player can create over a span of time.

        Returns:
        Policy settings that limit the number of game sessions an individual player can create over a span of time.

      • hasMetricGroups

        public final boolean hasMetricGroups()
        For responses, this returns true if the service returned a value for the MetricGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • metricGroups

        public final List<String> metricGroups()

        The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in 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:
        The name of a metric group to add this fleet to. Use a metric group in Amazon CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric group name, or create a new metric group by providing a new name. A fleet can only be in one metric group at a time.

      • anywhereConfiguration

        public final AnywhereConfiguration anywhereConfiguration()

        Amazon GameLift Anywhere configuration options.

        Returns:
        Amazon GameLift Anywhere configuration options.

      • 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