AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::Organizations::Model::Root Class Reference

#include <Root.h>

Public Member Functions

 Root ()
 
 Root (Aws::Utils::Json::JsonView jsonValue)
 
Rootoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
RootWithId (const Aws::String &value)
 
RootWithId (Aws::String &&value)
 
RootWithId (const char *value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
RootWithArn (const Aws::String &value)
 
RootWithArn (Aws::String &&value)
 
RootWithArn (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
RootWithName (const Aws::String &value)
 
RootWithName (Aws::String &&value)
 
RootWithName (const char *value)
 
const Aws::Vector< PolicyTypeSummary > & GetPolicyTypes () const
 
bool PolicyTypesHasBeenSet () const
 
void SetPolicyTypes (const Aws::Vector< PolicyTypeSummary > &value)
 
void SetPolicyTypes (Aws::Vector< PolicyTypeSummary > &&value)
 
RootWithPolicyTypes (const Aws::Vector< PolicyTypeSummary > &value)
 
RootWithPolicyTypes (Aws::Vector< PolicyTypeSummary > &&value)
 
RootAddPolicyTypes (const PolicyTypeSummary &value)
 
RootAddPolicyTypes (PolicyTypeSummary &&value)
 

Detailed Description

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 AWS account in the organization.

See Also:

AWS API Reference

Definition at line 36 of file Root.h.

Constructor & Destructor Documentation

◆ Root() [1/2]

Aws::Organizations::Model::Root::Root ( )

◆ Root() [2/2]

Aws::Organizations::Model::Root::Root ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddPolicyTypes() [1/2]

Root& Aws::Organizations::Model::Root::AddPolicyTypes ( const PolicyTypeSummary value)
inline

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.

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.

Definition at line 308 of file Root.h.

◆ AddPolicyTypes() [2/2]

Root& Aws::Organizations::Model::Root::AddPolicyTypes ( PolicyTypeSummary &&  value)
inline

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.

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.

Definition at line 318 of file Root.h.

◆ ArnHasBeenSet()

bool Aws::Organizations::Model::Root::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 118 of file Root.h.

◆ GetArn()

const Aws::String& Aws::Organizations::Model::Root::GetArn ( ) const
inline

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 109 of file Root.h.

◆ GetId()

const Aws::String& Aws::Organizations::Model::Root::GetId ( ) const
inline

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

Definition at line 50 of file Root.h.

◆ GetName()

const Aws::String& Aws::Organizations::Model::Root::GetName ( ) const
inline

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.

Definition at line 181 of file Root.h.

◆ GetPolicyTypes()

const Aws::Vector<PolicyTypeSummary>& Aws::Organizations::Model::Root::GetPolicyTypes ( ) const
inline

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.

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.

Definition at line 248 of file Root.h.

◆ IdHasBeenSet()

bool Aws::Organizations::Model::Root::IdHasBeenSet ( ) const
inline

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

Definition at line 57 of file Root.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Organizations::Model::Root::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::Organizations::Model::Root::NameHasBeenSet ( ) const
inline

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.

Definition at line 189 of file Root.h.

◆ operator=()

Root& Aws::Organizations::Model::Root::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PolicyTypesHasBeenSet()

bool Aws::Organizations::Model::Root::PolicyTypesHasBeenSet ( ) const
inline

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.

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.

Definition at line 258 of file Root.h.

◆ SetArn() [1/3]

void Aws::Organizations::Model::Root::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 136 of file Root.h.

◆ SetArn() [2/3]

void Aws::Organizations::Model::Root::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 127 of file Root.h.

◆ SetArn() [3/3]

void Aws::Organizations::Model::Root::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 145 of file Root.h.

◆ SetId() [1/3]

void Aws::Organizations::Model::Root::SetId ( Aws::String &&  value)
inline

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

Definition at line 71 of file Root.h.

◆ SetId() [2/3]

void Aws::Organizations::Model::Root::SetId ( const Aws::String value)
inline

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

Definition at line 64 of file Root.h.

◆ SetId() [3/3]

void Aws::Organizations::Model::Root::SetId ( const char *  value)
inline

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

Definition at line 78 of file Root.h.

◆ SetName() [1/3]

void Aws::Organizations::Model::Root::SetName ( Aws::String &&  value)
inline

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.

Definition at line 205 of file Root.h.

◆ SetName() [2/3]

void Aws::Organizations::Model::Root::SetName ( const Aws::String value)
inline

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.

Definition at line 197 of file Root.h.

◆ SetName() [3/3]

void Aws::Organizations::Model::Root::SetName ( const char *  value)
inline

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.

Definition at line 213 of file Root.h.

◆ SetPolicyTypes() [1/2]

void Aws::Organizations::Model::Root::SetPolicyTypes ( Aws::Vector< PolicyTypeSummary > &&  value)
inline

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.

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.

Definition at line 278 of file Root.h.

◆ SetPolicyTypes() [2/2]

void Aws::Organizations::Model::Root::SetPolicyTypes ( const Aws::Vector< PolicyTypeSummary > &  value)
inline

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.

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.

Definition at line 268 of file Root.h.

◆ WithArn() [1/3]

Root& Aws::Organizations::Model::Root::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 163 of file Root.h.

◆ WithArn() [2/3]

Root& Aws::Organizations::Model::Root::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 154 of file Root.h.

◆ WithArn() [3/3]

Root& Aws::Organizations::Model::Root::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 172 of file Root.h.

◆ WithId() [1/3]

Root& Aws::Organizations::Model::Root::WithId ( Aws::String &&  value)
inline

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

Definition at line 92 of file Root.h.

◆ WithId() [2/3]

Root& Aws::Organizations::Model::Root::WithId ( const Aws::String value)
inline

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

Definition at line 85 of file Root.h.

◆ WithId() [3/3]

Root& Aws::Organizations::Model::Root::WithId ( const char *  value)
inline

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires "r-" followed by from 4 to 32 lowercase letters or digits.

Definition at line 99 of file Root.h.

◆ WithName() [1/3]

Root& Aws::Organizations::Model::Root::WithName ( Aws::String &&  value)
inline

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.

Definition at line 229 of file Root.h.

◆ WithName() [2/3]

Root& Aws::Organizations::Model::Root::WithName ( const Aws::String value)
inline

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.

Definition at line 221 of file Root.h.

◆ WithName() [3/3]

Root& Aws::Organizations::Model::Root::WithName ( const char *  value)
inline

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.

Definition at line 237 of file Root.h.

◆ WithPolicyTypes() [1/2]

Root& Aws::Organizations::Model::Root::WithPolicyTypes ( Aws::Vector< PolicyTypeSummary > &&  value)
inline

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.

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.

Definition at line 298 of file Root.h.

◆ WithPolicyTypes() [2/2]

Root& Aws::Organizations::Model::Root::WithPolicyTypes ( const Aws::Vector< PolicyTypeSummary > &  value)
inline

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.

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.

Definition at line 288 of file Root.h.


The documentation for this class was generated from the following file: