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

#include <PolicySummary.h>

Public Member Functions

 PolicySummary ()
 
 PolicySummary (Aws::Utils::Json::JsonView jsonValue)
 
PolicySummaryoperator= (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)
 
PolicySummaryWithId (const Aws::String &value)
 
PolicySummaryWithId (Aws::String &&value)
 
PolicySummaryWithId (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)
 
PolicySummaryWithArn (const Aws::String &value)
 
PolicySummaryWithArn (Aws::String &&value)
 
PolicySummaryWithArn (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)
 
PolicySummaryWithName (const Aws::String &value)
 
PolicySummaryWithName (Aws::String &&value)
 
PolicySummaryWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
PolicySummaryWithDescription (const Aws::String &value)
 
PolicySummaryWithDescription (Aws::String &&value)
 
PolicySummaryWithDescription (const char *value)
 
const PolicyTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const PolicyType &value)
 
void SetType (PolicyType &&value)
 
PolicySummaryWithType (const PolicyType &value)
 
PolicySummaryWithType (PolicyType &&value)
 
bool GetAwsManaged () const
 
bool AwsManagedHasBeenSet () const
 
void SetAwsManaged (bool value)
 
PolicySummaryWithAwsManaged (bool value)
 

Detailed Description

Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy.

See Also:


AWS API Reference

Definition at line 34 of file PolicySummary.h.

Constructor & Destructor Documentation

◆ PolicySummary() [1/2]

Aws::Organizations::Model::PolicySummary::PolicySummary ( )

◆ PolicySummary() [2/2]

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

Member Function Documentation

◆ ArnHasBeenSet()

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

The Amazon Resource Name (ARN) of the policy.

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

Definition at line 124 of file PolicySummary.h.

◆ AwsManagedHasBeenSet()

bool Aws::Organizations::Model::PolicySummary::AwsManagedHasBeenSet ( ) const
inline

A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

Definition at line 330 of file PolicySummary.h.

◆ DescriptionHasBeenSet()

bool Aws::Organizations::Model::PolicySummary::DescriptionHasBeenSet ( ) const
inline

The description of the policy.

Definition at line 254 of file PolicySummary.h.

◆ GetArn()

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

The Amazon Resource Name (ARN) of the policy.

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

Definition at line 115 of file PolicySummary.h.

◆ GetAwsManaged()

bool Aws::Organizations::Model::PolicySummary::GetAwsManaged ( ) const
inline

A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

Definition at line 323 of file PolicySummary.h.

◆ GetDescription()

const Aws::String& Aws::Organizations::Model::PolicySummary::GetDescription ( ) const
inline

The description of the policy.

Definition at line 249 of file PolicySummary.h.

◆ GetId()

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

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

Definition at line 49 of file PolicySummary.h.

◆ GetName()

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

The friendly name of the policy.

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 187 of file PolicySummary.h.

◆ GetType()

const PolicyType& Aws::Organizations::Model::PolicySummary::GetType ( ) const
inline

The type of policy.

Definition at line 290 of file PolicySummary.h.

◆ IdHasBeenSet()

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

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

Definition at line 57 of file PolicySummary.h.

◆ Jsonize()

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

◆ NameHasBeenSet()

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

The friendly name of the policy.

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 195 of file PolicySummary.h.

◆ operator=()

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

◆ SetArn() [1/3]

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

The Amazon Resource Name (ARN) of the policy.

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

Definition at line 142 of file PolicySummary.h.

◆ SetArn() [2/3]

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

The Amazon Resource Name (ARN) of the policy.

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

Definition at line 133 of file PolicySummary.h.

◆ SetArn() [3/3]

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

The Amazon Resource Name (ARN) of the policy.

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

Definition at line 151 of file PolicySummary.h.

◆ SetAwsManaged()

void Aws::Organizations::Model::PolicySummary::SetAwsManaged ( bool  value)
inline

A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

Definition at line 337 of file PolicySummary.h.

◆ SetDescription() [1/3]

void Aws::Organizations::Model::PolicySummary::SetDescription ( Aws::String &&  value)
inline

The description of the policy.

Definition at line 264 of file PolicySummary.h.

◆ SetDescription() [2/3]

void Aws::Organizations::Model::PolicySummary::SetDescription ( const Aws::String value)
inline

The description of the policy.

Definition at line 259 of file PolicySummary.h.

◆ SetDescription() [3/3]

void Aws::Organizations::Model::PolicySummary::SetDescription ( const char *  value)
inline

The description of the policy.

Definition at line 269 of file PolicySummary.h.

◆ SetId() [1/3]

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

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

Definition at line 73 of file PolicySummary.h.

◆ SetId() [2/3]

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

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

Definition at line 65 of file PolicySummary.h.

◆ SetId() [3/3]

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

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

Definition at line 81 of file PolicySummary.h.

◆ SetName() [1/3]

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

The friendly name of the policy.

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 211 of file PolicySummary.h.

◆ SetName() [2/3]

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

The friendly name of the policy.

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 203 of file PolicySummary.h.

◆ SetName() [3/3]

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

The friendly name of the policy.

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 219 of file PolicySummary.h.

◆ SetType() [1/2]

void Aws::Organizations::Model::PolicySummary::SetType ( const PolicyType value)
inline

The type of policy.

Definition at line 300 of file PolicySummary.h.

◆ SetType() [2/2]

void Aws::Organizations::Model::PolicySummary::SetType ( PolicyType &&  value)
inline

The type of policy.

Definition at line 305 of file PolicySummary.h.

◆ TypeHasBeenSet()

bool Aws::Organizations::Model::PolicySummary::TypeHasBeenSet ( ) const
inline

The type of policy.

Definition at line 295 of file PolicySummary.h.

◆ WithArn() [1/3]

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

The Amazon Resource Name (ARN) of the policy.

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

Definition at line 169 of file PolicySummary.h.

◆ WithArn() [2/3]

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

The Amazon Resource Name (ARN) of the policy.

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

Definition at line 160 of file PolicySummary.h.

◆ WithArn() [3/3]

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

The Amazon Resource Name (ARN) of the policy.

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

Definition at line 178 of file PolicySummary.h.

◆ WithAwsManaged()

PolicySummary& Aws::Organizations::Model::PolicySummary::WithAwsManaged ( bool  value)
inline

A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

Definition at line 344 of file PolicySummary.h.

◆ WithDescription() [1/3]

PolicySummary& Aws::Organizations::Model::PolicySummary::WithDescription ( Aws::String &&  value)
inline

The description of the policy.

Definition at line 279 of file PolicySummary.h.

◆ WithDescription() [2/3]

PolicySummary& Aws::Organizations::Model::PolicySummary::WithDescription ( const Aws::String value)
inline

The description of the policy.

Definition at line 274 of file PolicySummary.h.

◆ WithDescription() [3/3]

PolicySummary& Aws::Organizations::Model::PolicySummary::WithDescription ( const char *  value)
inline

The description of the policy.

Definition at line 284 of file PolicySummary.h.

◆ WithId() [1/3]

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

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

Definition at line 97 of file PolicySummary.h.

◆ WithId() [2/3]

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

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

Definition at line 89 of file PolicySummary.h.

◆ WithId() [3/3]

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

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires "p-" followed by from 8 to 128 lowercase or uppercase letters, digits, or the underscore character (_).

Definition at line 105 of file PolicySummary.h.

◆ WithName() [1/3]

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

The friendly name of the policy.

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 235 of file PolicySummary.h.

◆ WithName() [2/3]

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

The friendly name of the policy.

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 227 of file PolicySummary.h.

◆ WithName() [3/3]

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

The friendly name of the policy.

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 243 of file PolicySummary.h.

◆ WithType() [1/2]

PolicySummary& Aws::Organizations::Model::PolicySummary::WithType ( const PolicyType value)
inline

The type of policy.

Definition at line 310 of file PolicySummary.h.

◆ WithType() [2/2]

PolicySummary& Aws::Organizations::Model::PolicySummary::WithType ( PolicyType &&  value)
inline

The type of policy.

Definition at line 315 of file PolicySummary.h.


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