@Generated(value="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 AWS account in the organization.
| Modifier and Type | Class and Description |
|---|---|
static interface |
Root.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
arn()
The Amazon Resource Name (ARN) of the root.
|
static Root.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasPolicyTypes()
Returns true if the PolicyTypes property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
String |
id()
The unique identifier (ID) for the root.
|
String |
name()
The friendly name of the root.
|
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.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Root.Builder> |
serializableBuilderClass() |
Root.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copypublic final String id()
The unique identifier (ID) for the root.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.
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 AWS Service Authorization Reference.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.
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.
The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.
public final boolean hasPolicyTypes()
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.
You can use hasPolicyTypes() to see if a value was sent in this field.
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.
public Root.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<Root.Builder,Root>public static Root.Builder builder()
public static Class<? extends Root.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()