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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAdminAccountSummary.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringadminAccount()The Amazon Web Services account ID of the Firewall Manager administrator's account.static AdminAccountSummary.Builderbuilder()BooleandefaultAdmin()A boolean value that indicates if the administrator is the default administrator.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()List<SdkField<?>>sdkFields()static Class<? extends AdminAccountSummary.Builder>serializableBuilderClass()OrganizationStatusstatus()The current status of the request to onboard a member account as an Firewall Manager administrator.StringstatusAsString()The current status of the request to onboard a member account as an Firewall Manager administrator.AdminAccountSummary.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
-
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,
statuswill returnOrganizationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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:
OrganizationStatus
-
-
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,
statuswill returnOrganizationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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:
OrganizationStatus
-
-
toBuilder
public AdminAccountSummary.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AdminAccountSummary.Builder,AdminAccountSummary>
-
builder
public static AdminAccountSummary.Builder builder()
-
serializableBuilderClass
public static Class<? extends AdminAccountSummary.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.
-
-