software.amazon.awssdk.services.fms.model

Class AccountScope

java.lang.Object

software.amazon.awssdk.services.fms.model.AccountScope

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AccountScope.Builder,AccountScope>

@Generated(value="software.amazon.awssdk:codegen")
public final class AccountScope
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AccountScope.Builder,AccountScope>

Configures the accounts within the administrator's Organizations organization that the specified Firewall Manager administrator can apply policies to.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AccountScope.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	accounts() The list of accounts within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of ExcludeSpecifiedAccounts.
Boolean	allAccountsEnabled() A boolean value that indicates if the administrator can apply policies to all accounts within an organization.
static AccountScope.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	excludeSpecifiedAccounts() A boolean value that excludes the accounts in AccountScope$Accounts from the administrator's scope.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAccounts() For responses, this returns true if the service returned a value for the Accounts property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends AccountScope.Builder>	serializableBuilderClass()
AccountScope.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

hasAccounts

public final boolean hasAccounts()

For responses, this returns true if the service returned a value for the Accounts 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.

accounts

public final List<String> accounts()

The list of accounts within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of ExcludeSpecifiedAccounts. If ExcludeSpecifiedAccounts is set to true, then the Firewall Manager administrator can apply policies to all members of the organization except for the accounts in this list. If ExcludeSpecifiedAccounts is set to false, then the Firewall Manager administrator can only apply policies to the accounts in this list.

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 hasAccounts() method.

Returns:

The list of accounts within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of ExcludeSpecifiedAccounts. If ExcludeSpecifiedAccounts is set to true, then the Firewall Manager administrator can apply policies to all members of the organization except for the accounts in this list. If ExcludeSpecifiedAccounts is set to false, then the Firewall Manager administrator can only apply policies to the accounts in this list.

allAccountsEnabled

public final Boolean allAccountsEnabled()

A boolean value that indicates if the administrator can apply policies to all accounts within an organization. If true, the administrator can apply policies to all accounts within the organization. You can either enable management of all accounts through this operation, or you can specify a list of accounts to manage in AccountScope$Accounts. You cannot specify both.

Returns:

A boolean value that indicates if the administrator can apply policies to all accounts within an organization. If true, the administrator can apply policies to all accounts within the organization. You can either enable management of all accounts through this operation, or you can specify a list of accounts to manage in AccountScope$Accounts. You cannot specify both.

excludeSpecifiedAccounts

public final Boolean excludeSpecifiedAccounts()

A boolean value that excludes the accounts in AccountScope$Accounts from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all members of the organization except for the accounts listed in AccountScope$Accounts. You can either specify a list of accounts to exclude by AccountScope$Accounts, or you can enable management of all accounts by AccountScope$AllAccountsEnabled. You cannot specify both.

Returns:

A boolean value that excludes the accounts in AccountScope$Accounts from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all members of the organization except for the accounts listed in AccountScope$Accounts. You can either specify a list of accounts to exclude by AccountScope$Accounts, or you can enable management of all accounts by AccountScope$AllAccountsEnabled. You cannot specify both.

toBuilder

public AccountScope.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AccountScope.Builder,AccountScope>

builder

public static AccountScope.Builder builder()

serializableBuilderClass

public static Class<? extends AccountScope.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