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(value="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 and Description
static interface	AdminAccountSummary.Builder

Method Summary

Modifier and Type	Method and Description
String	adminAccount() The Amazon Web Services account ID of the Firewall Manager administrator's account.
static AdminAccountSummary.Builder	builder()
Boolean	defaultAdmin() A boolean value that indicates if the administrator is the default administrator.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AdminAccountSummary.Builder>	serializableBuilderClass()
OrganizationStatus	status() The current status of the request to onboard a member account as an Firewall Manager administator.
String	statusAsString() The current status of the request to onboard a member account as an Firewall Manager administator.
AdminAccountSummary.Builder	toBuilder()
String	toString() 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 administator.

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

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

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

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

toBuilder in interface ToCopyableBuilder<AdminAccountSummary.Builder,AdminAccountSummary>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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