Package software.amazon.awssdk.services.fms.model

Class AdminAccountSummary

java.lang.Object
software.amazon.awssdk.services.fms.model.AdminAccountSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AdminAccountSummary.Builder,AdminAccountSummary>
@Generated("software.amazon.awssdk:codegen") public final class AdminAccountSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AdminAccountSummary.Builder,AdminAccountSummary>

Contains high level information about the Firewall Manager administrator account.

See Also:

  • Method Details

    • adminAccount

      public final String adminAccount()

      The Amazon Web Services account ID of the Firewall Manager administrator's account.

      Returns:
      The Amazon Web Services account ID of the Firewall Manager administrator's account.

    • defaultAdmin

      public final Boolean defaultAdmin()

      A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

      Returns:
      A boolean value that indicates if the administrator is the default administrator. If true, then this is the default administrator account. The default administrator can manage third-party firewalls and has full administrative scope. There is only one default administrator account per organization. For information about Firewall Manager default administrator accounts, see Managing Firewall Manager administrators in the Firewall Manager Developer Guide.

    • status

      public final OrganizationStatus status()

      The current status of the request to onboard a member account as an Firewall Manager administrator.

      • ONBOARDING - The account is onboarding to Firewall Manager as an administrator.

      • ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.

      • OFFBOARDING - The account is being removed as an Firewall Manager administrator.

      • OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.

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

      Returns:
      The current status of the request to onboard a member account as an Firewall Manager administrator.

      • ONBOARDING - The account is onboarding to Firewall Manager as an administrator.

      • ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.

      • OFFBOARDING - The account is being removed as an Firewall Manager administrator.

      • OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the request to onboard a member account as an Firewall Manager administrator.

      • ONBOARDING - The account is onboarding to Firewall Manager as an administrator.

      • ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.

      • OFFBOARDING - The account is being removed as an Firewall Manager administrator.

      • OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.

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

      Returns:
      The current status of the request to onboard a member account as an Firewall Manager administrator.

      • ONBOARDING - The account is onboarding to Firewall Manager as an administrator.

      • ONBOARDING_COMPLETE - Firewall Manager The account is onboarded to Firewall Manager as an administrator, and can perform actions on the resources defined in their AdminScope.

      • OFFBOARDING - The account is being removed as an Firewall Manager administrator.

      • OFFBOARDING_COMPLETE - The account has been removed as an Firewall Manager administrator.

      See Also:

    • toBuilder

      public AdminAccountSummary.Builder 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 interface ToCopyableBuilder<AdminAccountSummary.Builder,AdminAccountSummary>
      Returns:
      a builder for type T

    • builder

      public static AdminAccountSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AdminAccountSummary.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.