Class Root

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

Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. The root contains every Amazon Web Services account in the organization.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier (ID) for the root. The ID is unique to the organization only.

      The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

      Returns:
      The unique identifier (ID) for the root. The ID is unique to the organization only.

      The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the root.

      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 the root.

      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 the root.

      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 the root.

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

    • hasPolicyTypes

      public final boolean hasPolicyTypes()
      For responses, this returns true if the service returned a value for the PolicyTypes 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.

    • policyTypes

      public final List<PolicyTypeSummary> policyTypes()

      The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

      Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.

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

      Returns:
      The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

      Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.

    • toBuilder

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

    • builder

      public static Root.Builder builder()

    • serializableBuilderClass

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