Class OrganizationalUnit

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

Contains details about an organizational unit (OU). An OU is a container of Amazon Web Services accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier (ID) associated with this OU. The ID is unique to the organization only.

      The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

      Returns:
      The unique identifier (ID) associated with this OU. The ID is unique to the organization only.

      The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of this OU.

      For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

      Returns:
      The Amazon Resource Name (ARN) of this OU.

      For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

    • name

      public final String name()

      The friendly name of this OU.

      The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

      Returns:
      The friendly name of this OU.

      The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

    • toBuilder

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

    • builder

      public static OrganizationalUnit.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.