You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Organizations::Types::Root

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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:

  • (String)

    The Amazon Resource Name (ARN) of the root.

#idString

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:

  • (String)

    The unique identifier (ID) for the root.

#nameString

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:

  • (String)

    The friendly name of the root.

#policy_typesArray<Types::PolicyTypeSummary>

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:

  • (Array<Types::PolicyTypeSummary>)

    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.