Enum AccountIdEndpointMode

java.lang.Object
java.lang.Enum<AccountIdEndpointMode>
software.amazon.awssdk.awscore.endpoints.AccountIdEndpointMode
All Implemented Interfaces:
Serializable, Comparable<AccountIdEndpointMode>
@SdkPublicApi public enum AccountIdEndpointMode extends Enum<AccountIdEndpointMode>
Enum Class for AccountId Endpoint Mode.

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DISABLED
    When mode is disabled, any resolved account ID will not be used in endpoint construction and rules that reference them will be bypassed.
    PREFERRED
    Default value that indicates account ID values will be used in endpoint rules if available.
    REQUIRED
    Required mode would be used in scenarios where endpoint resolution should return an error if no account ID is available.

  • Method Summary

    Modifier and Type
    Method
    Description
    static AccountIdEndpointMode
    fromValue(String s)
    Returns the appropriate AccountIdEndpointMode value after parsing the parameter.
    String
    value()
    Returns the canonical lowercase string for this mode, as the endpoint rules engine expects to receive it in the AWS::Auth::AccountIdEndpointMode built-in.
    static AccountIdEndpointMode
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static AccountIdEndpointMode[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • PREFERRED

      public static final AccountIdEndpointMode PREFERRED
      Default value that indicates account ID values will be used in endpoint rules if available.

    • DISABLED

      public static final AccountIdEndpointMode DISABLED
      When mode is disabled, any resolved account ID will not be used in endpoint construction and rules that reference them will be bypassed.

    • REQUIRED

      public static final AccountIdEndpointMode REQUIRED
      Required mode would be used in scenarios where endpoint resolution should return an error if no account ID is available.

  • Method Details

    • values

      public static AccountIdEndpointMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static AccountIdEndpointMode valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • fromValue

      public static AccountIdEndpointMode fromValue(String s)
      Returns the appropriate AccountIdEndpointMode value after parsing the parameter.
      Parameters:
      s - AccountIdEndpointMode in String Format.
      Returns:
      AccountIdEndpointMode enumValue
      Throws:
      IllegalArgumentException - Unrecognized value for endpoint mode.

    • value

      public String value()
      Returns the canonical lowercase string for this mode, as the endpoint rules engine expects to receive it in the AWS::Auth::AccountIdEndpointMode built-in.

      Unlike name().toLowerCase(), this returns the same interned String reference on every call instead of a fresh string per request, which removes an allocation from the request path. It is also independent of the default locale, which name().toLowerCase() is not.