@Generated(value="software.amazon.awssdk:codegen") public class Root extends Object implements StructuredPojo, 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. Every root contains every AWS account in the organization. Each root enables the accounts to be organized in a different way and to have different policy types enabled for use in that root.
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
id()
The unique identifier (ID) for the root.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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.
|
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() |
copy
public 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 lower-case letters or digits.
The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lower-case letters or digits.
public 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 Organizations User Guide.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
public 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 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public Root.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Root.Builder,Root>
public static Root.Builder builder()
public static Class<? extends Root.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.