AWS SDK for C++  1.8.3
AWS SDK for C++
Public Member Functions | List of all members
Aws::IAM::Model::Policy Class Reference

#include <Policy.h>

Public Member Functions

 Policy ()
 
 Policy (const Aws::Utils::Xml::XmlNode &xmlNode)
 
Policyoperator= (const Aws::Utils::Xml::XmlNode &xmlNode)
 
void OutputToStream (Aws::OStream &ostream, const char *location, unsigned index, const char *locationValue) const
 
void OutputToStream (Aws::OStream &oStream, const char *location) const
 
const Aws::StringGetPolicyName () const
 
bool PolicyNameHasBeenSet () const
 
void SetPolicyName (const Aws::String &value)
 
void SetPolicyName (Aws::String &&value)
 
void SetPolicyName (const char *value)
 
PolicyWithPolicyName (const Aws::String &value)
 
PolicyWithPolicyName (Aws::String &&value)
 
PolicyWithPolicyName (const char *value)
 
const Aws::StringGetPolicyId () const
 
bool PolicyIdHasBeenSet () const
 
void SetPolicyId (const Aws::String &value)
 
void SetPolicyId (Aws::String &&value)
 
void SetPolicyId (const char *value)
 
PolicyWithPolicyId (const Aws::String &value)
 
PolicyWithPolicyId (Aws::String &&value)
 
PolicyWithPolicyId (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)
 
PolicyWithArn (const Aws::String &value)
 
PolicyWithArn (Aws::String &&value)
 
PolicyWithArn (const char *value)
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
PolicyWithPath (const Aws::String &value)
 
PolicyWithPath (Aws::String &&value)
 
PolicyWithPath (const char *value)
 
const Aws::StringGetDefaultVersionId () const
 
bool DefaultVersionIdHasBeenSet () const
 
void SetDefaultVersionId (const Aws::String &value)
 
void SetDefaultVersionId (Aws::String &&value)
 
void SetDefaultVersionId (const char *value)
 
PolicyWithDefaultVersionId (const Aws::String &value)
 
PolicyWithDefaultVersionId (Aws::String &&value)
 
PolicyWithDefaultVersionId (const char *value)
 
int GetAttachmentCount () const
 
bool AttachmentCountHasBeenSet () const
 
void SetAttachmentCount (int value)
 
PolicyWithAttachmentCount (int value)
 
int GetPermissionsBoundaryUsageCount () const
 
bool PermissionsBoundaryUsageCountHasBeenSet () const
 
void SetPermissionsBoundaryUsageCount (int value)
 
PolicyWithPermissionsBoundaryUsageCount (int value)
 
bool GetIsAttachable () const
 
bool IsAttachableHasBeenSet () const
 
void SetIsAttachable (bool value)
 
PolicyWithIsAttachable (bool value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
PolicyWithDescription (const Aws::String &value)
 
PolicyWithDescription (Aws::String &&value)
 
PolicyWithDescription (const char *value)
 
const Aws::Utils::DateTimeGetCreateDate () const
 
bool CreateDateHasBeenSet () const
 
void SetCreateDate (const Aws::Utils::DateTime &value)
 
void SetCreateDate (Aws::Utils::DateTime &&value)
 
PolicyWithCreateDate (const Aws::Utils::DateTime &value)
 
PolicyWithCreateDate (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetUpdateDate () const
 
bool UpdateDateHasBeenSet () const
 
void SetUpdateDate (const Aws::Utils::DateTime &value)
 
void SetUpdateDate (Aws::Utils::DateTime &&value)
 
PolicyWithUpdateDate (const Aws::Utils::DateTime &value)
 
PolicyWithUpdateDate (Aws::Utils::DateTime &&value)
 

Detailed Description

Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations.

For more information about managed policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

See Also:

AWS API Reference

Definition at line 38 of file Policy.h.

Constructor & Destructor Documentation

◆ Policy() [1/2]

Aws::IAM::Model::Policy::Policy ( )

◆ Policy() [2/2]

Aws::IAM::Model::Policy::Policy ( const Aws::Utils::Xml::XmlNode xmlNode)

Member Function Documentation

◆ ArnHasBeenSet()

bool Aws::IAM::Model::Policy::ArnHasBeenSet ( ) const
inline

Definition at line 159 of file Policy.h.

◆ AttachmentCountHasBeenSet()

bool Aws::IAM::Model::Policy::AttachmentCountHasBeenSet ( ) const
inline

The number of entities (users, groups, and roles) that the policy is attached to.

Definition at line 296 of file Policy.h.

◆ CreateDateHasBeenSet()

bool Aws::IAM::Model::Policy::CreateDateHasBeenSet ( ) const
inline

The date and time, in ISO 8601 date-time format, when the policy was created.

Definition at line 440 of file Policy.h.

◆ DefaultVersionIdHasBeenSet()

bool Aws::IAM::Model::Policy::DefaultVersionIdHasBeenSet ( ) const
inline

The identifier for the version of the policy that is set as the default version.

Definition at line 247 of file Policy.h.

◆ DescriptionHasBeenSet()

bool Aws::IAM::Model::Policy::DescriptionHasBeenSet ( ) const
inline

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

Definition at line 385 of file Policy.h.

◆ GetArn()

const Aws::String& Aws::IAM::Model::Policy::GetArn ( ) const
inline

Definition at line 156 of file Policy.h.

◆ GetAttachmentCount()

int Aws::IAM::Model::Policy::GetAttachmentCount ( ) const
inline

The number of entities (users, groups, and roles) that the policy is attached to.

Definition at line 290 of file Policy.h.

◆ GetCreateDate()

const Aws::Utils::DateTime& Aws::IAM::Model::Policy::GetCreateDate ( ) const
inline

The date and time, in ISO 8601 date-time format, when the policy was created.

Definition at line 434 of file Policy.h.

◆ GetDefaultVersionId()

const Aws::String& Aws::IAM::Model::Policy::GetDefaultVersionId ( ) const
inline

The identifier for the version of the policy that is set as the default version.

Definition at line 241 of file Policy.h.

◆ GetDescription()

const Aws::String& Aws::IAM::Model::Policy::GetDescription ( ) const
inline

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

Definition at line 378 of file Policy.h.

◆ GetIsAttachable()

bool Aws::IAM::Model::Policy::GetIsAttachable ( ) const
inline

Specifies whether the policy can be attached to an IAM user, group, or role.

Definition at line 352 of file Policy.h.

◆ GetPath()

const Aws::String& Aws::IAM::Model::Policy::GetPath ( ) const
inline

The path to the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 185 of file Policy.h.

◆ GetPermissionsBoundaryUsageCount()

int Aws::IAM::Model::Policy::GetPermissionsBoundaryUsageCount ( ) const
inline

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Definition at line 318 of file Policy.h.

◆ GetPolicyId()

const Aws::String& Aws::IAM::Model::Policy::GetPolicyId ( ) const
inline

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 96 of file Policy.h.

◆ GetPolicyName()

const Aws::String& Aws::IAM::Model::Policy::GetPolicyName ( ) const
inline

The friendly name (not ARN) identifying the policy.

Definition at line 52 of file Policy.h.

◆ GetUpdateDate()

const Aws::Utils::DateTime& Aws::IAM::Model::Policy::GetUpdateDate ( ) const
inline

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

Definition at line 474 of file Policy.h.

◆ IsAttachableHasBeenSet()

bool Aws::IAM::Model::Policy::IsAttachableHasBeenSet ( ) const
inline

Specifies whether the policy can be attached to an IAM user, group, or role.

Definition at line 358 of file Policy.h.

◆ operator=()

Policy& Aws::IAM::Model::Policy::operator= ( const Aws::Utils::Xml::XmlNode xmlNode)

◆ OutputToStream() [1/2]

void Aws::IAM::Model::Policy::OutputToStream ( Aws::OStream ostream,
const char *  location,
unsigned  index,
const char *  locationValue 
) const

◆ OutputToStream() [2/2]

void Aws::IAM::Model::Policy::OutputToStream ( Aws::OStream oStream,
const char *  location 
) const

◆ PathHasBeenSet()

bool Aws::IAM::Model::Policy::PathHasBeenSet ( ) const
inline

The path to the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 192 of file Policy.h.

◆ PermissionsBoundaryUsageCountHasBeenSet()

bool Aws::IAM::Model::Policy::PermissionsBoundaryUsageCountHasBeenSet ( ) const
inline

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Definition at line 327 of file Policy.h.

◆ PolicyIdHasBeenSet()

bool Aws::IAM::Model::Policy::PolicyIdHasBeenSet ( ) const
inline

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 104 of file Policy.h.

◆ PolicyNameHasBeenSet()

bool Aws::IAM::Model::Policy::PolicyNameHasBeenSet ( ) const
inline

The friendly name (not ARN) identifying the policy.

Definition at line 57 of file Policy.h.

◆ SetArn() [1/3]

void Aws::IAM::Model::Policy::SetArn ( const Aws::String value)
inline

Definition at line 162 of file Policy.h.

◆ SetArn() [2/3]

void Aws::IAM::Model::Policy::SetArn ( Aws::String &&  value)
inline

Definition at line 165 of file Policy.h.

◆ SetArn() [3/3]

void Aws::IAM::Model::Policy::SetArn ( const char *  value)
inline

Definition at line 168 of file Policy.h.

◆ SetAttachmentCount()

void Aws::IAM::Model::Policy::SetAttachmentCount ( int  value)
inline

The number of entities (users, groups, and roles) that the policy is attached to.

Definition at line 302 of file Policy.h.

◆ SetCreateDate() [1/2]

void Aws::IAM::Model::Policy::SetCreateDate ( const Aws::Utils::DateTime value)
inline

The date and time, in ISO 8601 date-time format, when the policy was created.

Definition at line 446 of file Policy.h.

◆ SetCreateDate() [2/2]

void Aws::IAM::Model::Policy::SetCreateDate ( Aws::Utils::DateTime &&  value)
inline

The date and time, in ISO 8601 date-time format, when the policy was created.

Definition at line 452 of file Policy.h.

◆ SetDefaultVersionId() [1/3]

void Aws::IAM::Model::Policy::SetDefaultVersionId ( const Aws::String value)
inline

The identifier for the version of the policy that is set as the default version.

Definition at line 253 of file Policy.h.

◆ SetDefaultVersionId() [2/3]

void Aws::IAM::Model::Policy::SetDefaultVersionId ( Aws::String &&  value)
inline

The identifier for the version of the policy that is set as the default version.

Definition at line 259 of file Policy.h.

◆ SetDefaultVersionId() [3/3]

void Aws::IAM::Model::Policy::SetDefaultVersionId ( const char *  value)
inline

The identifier for the version of the policy that is set as the default version.

Definition at line 265 of file Policy.h.

◆ SetDescription() [1/3]

void Aws::IAM::Model::Policy::SetDescription ( const Aws::String value)
inline

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

Definition at line 392 of file Policy.h.

◆ SetDescription() [2/3]

void Aws::IAM::Model::Policy::SetDescription ( Aws::String &&  value)
inline

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

Definition at line 399 of file Policy.h.

◆ SetDescription() [3/3]

void Aws::IAM::Model::Policy::SetDescription ( const char *  value)
inline

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

Definition at line 406 of file Policy.h.

◆ SetIsAttachable()

void Aws::IAM::Model::Policy::SetIsAttachable ( bool  value)
inline

Specifies whether the policy can be attached to an IAM user, group, or role.

Definition at line 364 of file Policy.h.

◆ SetPath() [1/3]

void Aws::IAM::Model::Policy::SetPath ( const Aws::String value)
inline

The path to the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 199 of file Policy.h.

◆ SetPath() [2/3]

void Aws::IAM::Model::Policy::SetPath ( Aws::String &&  value)
inline

The path to the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 206 of file Policy.h.

◆ SetPath() [3/3]

void Aws::IAM::Model::Policy::SetPath ( const char *  value)
inline

The path to the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 213 of file Policy.h.

◆ SetPermissionsBoundaryUsageCount()

void Aws::IAM::Model::Policy::SetPermissionsBoundaryUsageCount ( int  value)
inline

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Definition at line 336 of file Policy.h.

◆ SetPolicyId() [1/3]

void Aws::IAM::Model::Policy::SetPolicyId ( const Aws::String value)
inline

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 112 of file Policy.h.

◆ SetPolicyId() [2/3]

void Aws::IAM::Model::Policy::SetPolicyId ( Aws::String &&  value)
inline

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 120 of file Policy.h.

◆ SetPolicyId() [3/3]

void Aws::IAM::Model::Policy::SetPolicyId ( const char *  value)
inline

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 128 of file Policy.h.

◆ SetPolicyName() [1/3]

void Aws::IAM::Model::Policy::SetPolicyName ( const Aws::String value)
inline

The friendly name (not ARN) identifying the policy.

Definition at line 62 of file Policy.h.

◆ SetPolicyName() [2/3]

void Aws::IAM::Model::Policy::SetPolicyName ( Aws::String &&  value)
inline

The friendly name (not ARN) identifying the policy.

Definition at line 67 of file Policy.h.

◆ SetPolicyName() [3/3]

void Aws::IAM::Model::Policy::SetPolicyName ( const char *  value)
inline

The friendly name (not ARN) identifying the policy.

Definition at line 72 of file Policy.h.

◆ SetUpdateDate() [1/2]

void Aws::IAM::Model::Policy::SetUpdateDate ( const Aws::Utils::DateTime value)
inline

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

Definition at line 492 of file Policy.h.

◆ SetUpdateDate() [2/2]

void Aws::IAM::Model::Policy::SetUpdateDate ( Aws::Utils::DateTime &&  value)
inline

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

Definition at line 501 of file Policy.h.

◆ UpdateDateHasBeenSet()

bool Aws::IAM::Model::Policy::UpdateDateHasBeenSet ( ) const
inline

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

Definition at line 483 of file Policy.h.

◆ WithArn() [1/3]

Policy& Aws::IAM::Model::Policy::WithArn ( const Aws::String value)
inline

Definition at line 171 of file Policy.h.

◆ WithArn() [2/3]

Policy& Aws::IAM::Model::Policy::WithArn ( Aws::String &&  value)
inline

Definition at line 174 of file Policy.h.

◆ WithArn() [3/3]

Policy& Aws::IAM::Model::Policy::WithArn ( const char *  value)
inline

Definition at line 177 of file Policy.h.

◆ WithAttachmentCount()

Policy& Aws::IAM::Model::Policy::WithAttachmentCount ( int  value)
inline

The number of entities (users, groups, and roles) that the policy is attached to.

Definition at line 308 of file Policy.h.

◆ WithCreateDate() [1/2]

Policy& Aws::IAM::Model::Policy::WithCreateDate ( const Aws::Utils::DateTime value)
inline

The date and time, in ISO 8601 date-time format, when the policy was created.

Definition at line 458 of file Policy.h.

◆ WithCreateDate() [2/2]

Policy& Aws::IAM::Model::Policy::WithCreateDate ( Aws::Utils::DateTime &&  value)
inline

The date and time, in ISO 8601 date-time format, when the policy was created.

Definition at line 464 of file Policy.h.

◆ WithDefaultVersionId() [1/3]

Policy& Aws::IAM::Model::Policy::WithDefaultVersionId ( const Aws::String value)
inline

The identifier for the version of the policy that is set as the default version.

Definition at line 271 of file Policy.h.

◆ WithDefaultVersionId() [2/3]

Policy& Aws::IAM::Model::Policy::WithDefaultVersionId ( Aws::String &&  value)
inline

The identifier for the version of the policy that is set as the default version.

Definition at line 277 of file Policy.h.

◆ WithDefaultVersionId() [3/3]

Policy& Aws::IAM::Model::Policy::WithDefaultVersionId ( const char *  value)
inline

The identifier for the version of the policy that is set as the default version.

Definition at line 283 of file Policy.h.

◆ WithDescription() [1/3]

Policy& Aws::IAM::Model::Policy::WithDescription ( const Aws::String value)
inline

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

Definition at line 413 of file Policy.h.

◆ WithDescription() [2/3]

Policy& Aws::IAM::Model::Policy::WithDescription ( Aws::String &&  value)
inline

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

Definition at line 420 of file Policy.h.

◆ WithDescription() [3/3]

Policy& Aws::IAM::Model::Policy::WithDescription ( const char *  value)
inline

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

Definition at line 427 of file Policy.h.

◆ WithIsAttachable()

Policy& Aws::IAM::Model::Policy::WithIsAttachable ( bool  value)
inline

Specifies whether the policy can be attached to an IAM user, group, or role.

Definition at line 370 of file Policy.h.

◆ WithPath() [1/3]

Policy& Aws::IAM::Model::Policy::WithPath ( const Aws::String value)
inline

The path to the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 220 of file Policy.h.

◆ WithPath() [2/3]

Policy& Aws::IAM::Model::Policy::WithPath ( Aws::String &&  value)
inline

The path to the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 227 of file Policy.h.

◆ WithPath() [3/3]

Policy& Aws::IAM::Model::Policy::WithPath ( const char *  value)
inline

The path to the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

Definition at line 234 of file Policy.h.

◆ WithPermissionsBoundaryUsageCount()

Policy& Aws::IAM::Model::Policy::WithPermissionsBoundaryUsageCount ( int  value)
inline

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Definition at line 345 of file Policy.h.

◆ WithPolicyId() [1/3]

Policy& Aws::IAM::Model::Policy::WithPolicyId ( const Aws::String value)
inline

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 136 of file Policy.h.

◆ WithPolicyId() [2/3]

Policy& Aws::IAM::Model::Policy::WithPolicyId ( Aws::String &&  value)
inline

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 144 of file Policy.h.

◆ WithPolicyId() [3/3]

Policy& Aws::IAM::Model::Policy::WithPolicyId ( const char *  value)
inline

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the IAM User Guide.

Definition at line 152 of file Policy.h.

◆ WithPolicyName() [1/3]

Policy& Aws::IAM::Model::Policy::WithPolicyName ( const Aws::String value)
inline

The friendly name (not ARN) identifying the policy.

Definition at line 77 of file Policy.h.

◆ WithPolicyName() [2/3]

Policy& Aws::IAM::Model::Policy::WithPolicyName ( Aws::String &&  value)
inline

The friendly name (not ARN) identifying the policy.

Definition at line 82 of file Policy.h.

◆ WithPolicyName() [3/3]

Policy& Aws::IAM::Model::Policy::WithPolicyName ( const char *  value)
inline

The friendly name (not ARN) identifying the policy.

Definition at line 87 of file Policy.h.

◆ WithUpdateDate() [1/2]

Policy& Aws::IAM::Model::Policy::WithUpdateDate ( const Aws::Utils::DateTime value)
inline

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

Definition at line 510 of file Policy.h.

◆ WithUpdateDate() [2/2]

Policy& Aws::IAM::Model::Policy::WithUpdateDate ( Aws::Utils::DateTime &&  value)
inline

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

Definition at line 519 of file Policy.h.


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