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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-organizations/types.rb

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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_permissions.html#orgs-permissions-arns

Returns:

  • (String) 


2649
2650
2651
2652
2653
2654
2655
 
# File 'lib/aws-sdk-organizations/types.rb', line 2649

class Root < Struct.new(
  :id,
  :arn,
  :name,
  :policy_types)
  include Aws::Structure
end

#id ⇒ String

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.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


2649
2650
2651
2652
2653
2654
2655
 
# File 'lib/aws-sdk-organizations/types.rb', line 2649

class Root < Struct.new(
  :id,
  :arn,
  :name,
  :policy_types)
  include Aws::Structure
end

#name ⇒ String

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.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


2649
2650
2651
2652
2653
2654
2655
 
# File 'lib/aws-sdk-organizations/types.rb', line 2649

class Root < Struct.new(
  :id,
  :arn,
  :name,
  :policy_types)
  include Aws::Structure
end

#policy_types ⇒ 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.

Returns:



2649
2650
2651
2652
2653
2654
2655
 
# File 'lib/aws-sdk-organizations/types.rb', line 2649

class Root < Struct.new(
  :id,
  :arn,
  :name,
  :policy_types)
  include Aws::Structure
end