Class: Aws::Organizations::Types::Root
- Inherits:
-
Struct
- Object
- Struct
- Aws::Organizations::Types::Root
- 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. The root contains every Amazon Web Services account in the organization.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the root.
-
#id ⇒ String
The unique identifier (ID) for the root.
-
#name ⇒ String
The friendly name of the root.
-
#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.
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 *Amazon Web Services Service Authorization Reference*.
4473 4474 4475 4476 4477 4478 4479 4480 |
# File 'lib/aws-sdk-organizations/types.rb', line 4473 class Root < Struct.new( :id, :arn, :name, :policy_types) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The unique identifier (ID) for the root. The ID is unique to the organization only.
The [regex pattern] for a root ID string requires “r-” followed by from 4 to 32 lowercase letters or digits.
4473 4474 4475 4476 4477 4478 4479 4480 |
# File 'lib/aws-sdk-organizations/types.rb', line 4473 class Root < Struct.new( :id, :arn, :name, :policy_types) SENSITIVE = [] 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.
4473 4474 4475 4476 4477 4478 4479 4480 |
# File 'lib/aws-sdk-organizations/types.rb', line 4473 class Root < Struct.new( :id, :arn, :name, :policy_types) SENSITIVE = [] 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.
<note markdown=“1”> 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.
</note>
4473 4474 4475 4476 4477 4478 4479 4480 |
# File 'lib/aws-sdk-organizations/types.rb', line 4473 class Root < Struct.new( :id, :arn, :name, :policy_types) SENSITIVE = [] include Aws::Structure end |