Class OrganizationalUnitScope
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<OrganizationalUnitScope.Builder,
OrganizationalUnitScope>
Defines the Organizations organizational units (OUs) that the specified Firewall Manager administrator can apply policies to. For more information about OUs in Organizations, see Managing organizational units (OUs) in the Organizations User Guide.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
A boolean value that indicates if the administrator can apply policies to all OUs within an organization.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
A boolean value that excludes the OUs inOrganizationalUnitScope$OrganizationalUnits
from the administrator's scope.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the OrganizationalUnits property.The list of OUs within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value ofOrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits
.static Class
<? extends OrganizationalUnitScope.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasOrganizationalUnits
public final boolean hasOrganizationalUnits()For responses, this returns true if the service returned a value for the OrganizationalUnits property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
organizationalUnits
The list of OUs within the organization that the specified Firewall Manager administrator either can or cannot apply policies to, based on the value of
OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits
. IfOrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits
is set totrue
, then the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs in this list. IfOrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits
is set tofalse
, then the Firewall Manager administrator can only apply policies to the OUs 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
hasOrganizationalUnits()
method.- Returns:
- The list of OUs within the organization that the specified Firewall Manager administrator either can or
cannot apply policies to, based on the value of
OrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits
. IfOrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits
is set totrue
, then the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs in this list. IfOrganizationalUnitScope$ExcludeSpecifiedOrganizationalUnits
is set tofalse
, then the Firewall Manager administrator can only apply policies to the OUs in this list.
-
allOrganizationalUnitsEnabled
A boolean value that indicates if the administrator can apply policies to all OUs within an organization. If true, the administrator can manage all OUs within the organization. You can either enable management of all OUs through this operation, or you can specify OUs to manage in
OrganizationalUnitScope$OrganizationalUnits
. You cannot specify both.- Returns:
- A boolean value that indicates if the administrator can apply policies to all OUs within an organization.
If true, the administrator can manage all OUs within the organization. You can either enable management
of all OUs through this operation, or you can specify OUs to manage in
OrganizationalUnitScope$OrganizationalUnits
. You cannot specify both.
-
excludeSpecifiedOrganizationalUnits
A boolean value that excludes the OUs in
OrganizationalUnitScope$OrganizationalUnits
from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs listed inOrganizationalUnitScope$OrganizationalUnits
. You can either specify a list of OUs to exclude byOrganizationalUnitScope$OrganizationalUnits
, or you can enable management of all OUs byOrganizationalUnitScope$AllOrganizationalUnitsEnabled
. You cannot specify both.- Returns:
- A boolean value that excludes the OUs in
OrganizationalUnitScope$OrganizationalUnits
from the administrator's scope. If true, the Firewall Manager administrator can apply policies to all OUs in the organization except for the OUs listed inOrganizationalUnitScope$OrganizationalUnits
. You can either specify a list of OUs to exclude byOrganizationalUnitScope$OrganizationalUnits
, or you can enable management of all OUs byOrganizationalUnitScope$AllOrganizationalUnitsEnabled
. You cannot specify both.
-
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 interfaceToCopyableBuilder<OrganizationalUnitScope.Builder,
OrganizationalUnitScope> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-