software.amazon.awssdk.services.organizations.model

Class Root

java.lang.Object

software.amazon.awssdk.services.organizations.model.Root

All Implemented Interfaces:

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

@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 Amazon Web Services account in the organization.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Root.Builder

Method Summary

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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPolicyTypes() For responses, this returns true if the service returned a value for the PolicyTypes property.
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()
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

id

public 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.

Returns:

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.

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()

Specified by:

toBuilder in interface ToCopyableBuilder<Root.Builder,Root>

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)

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