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. The root contains every Amazon Web Services account in the organization.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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 *Amazon Web Services Service Authorization Reference*.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies

Returns:

  • (String) 


4491
4492
4493
4494
4495
4496
4497
4498
 
# File 'lib/aws-sdk-organizations/types.rb', line 4491

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.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


4491
4492
4493
4494
4495
4496
4497
4498
 
# File 'lib/aws-sdk-organizations/types.rb', line 4491

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.

[1]: wikipedia.org/wiki/regex

Returns:

  • (String) 


4491
4492
4493
4494
4495
4496
4497
4498
 
# File 'lib/aws-sdk-organizations/types.rb', line 4491

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>

Returns:



4491
4492
4493
4494
4495
4496
4497
4498
 
# File 'lib/aws-sdk-organizations/types.rb', line 4491

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