Root (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.organizations.model.Root

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Root
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Root()

Constructors
Constructor and Description
`Root()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Root`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the root.
`String`	`getId()` The unique identifier (ID) for the root.
`String`	`getName()` The friendly name of the root.
`List<PolicyTypeSummary>`	`getPolicyTypes()` 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.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the root.
`void`	`setId(String id)` The unique identifier (ID) for the root.
`void`	`setName(String name)` The friendly name of the root.
`void`	`setPolicyTypes(Collection<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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Root`	`withArn(String arn)` The Amazon Resource Name (ARN) of the root.
`Root`	`withId(String id)` The unique identifier (ID) for the root.
`Root`	`withName(String name)` The friendly name of the root.
`Root`	`withPolicyTypes(Collection<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.
`Root`	`withPolicyTypes(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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Root
```
public Root()
```
- Method Detail
  - setId
```
public void setId(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.
    
    Parameters:
    
    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.
  - getId
```
public String getId()
```
    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.
    
    Returns:
    
    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.
  - withId
```
public Root withId(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(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.
    
    Parameters:
    
    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.
  - getArn
```
public String getArn()
```
    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.
    
    Returns:
    
    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.
  - withArn
```
public Root withArn(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(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.
    
    Parameters:
    
    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.
  - getName
```
public String getName()
```
    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.
  - withName
```
public Root withName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPolicyTypes
```
public List<PolicyTypeSummary> getPolicyTypes()
```
    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.
    
    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.
  - setPolicyTypes
```
public void setPolicyTypes(Collection<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.
    
    Parameters:
    
    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.
  - withPolicyTypes
```
public Root withPolicyTypes(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setPolicyTypes(java.util.Collection) or withPolicyTypes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPolicyTypes
```
public Root withPolicyTypes(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Root clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Root

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Root

Method Detail

setId

getId

withId

setArn

getArn

withArn

setName

getName

withName

getPolicyTypes

setPolicyTypes

withPolicyTypes

withPolicyTypes

toString

equals

hashCode

clone

marshall