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

#include <PolicyVersion.h>

Public Member Functions

 PolicyVersion ()
 
 PolicyVersion (const Aws::Utils::Xml::XmlNode &xmlNode)
 
PolicyVersionoperator= (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::StringGetDocument () const
 
bool DocumentHasBeenSet () const
 
void SetDocument (const Aws::String &value)
 
void SetDocument (Aws::String &&value)
 
void SetDocument (const char *value)
 
PolicyVersionWithDocument (const Aws::String &value)
 
PolicyVersionWithDocument (Aws::String &&value)
 
PolicyVersionWithDocument (const char *value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
PolicyVersionWithVersionId (const Aws::String &value)
 
PolicyVersionWithVersionId (Aws::String &&value)
 
PolicyVersionWithVersionId (const char *value)
 
bool GetIsDefaultVersion () const
 
bool IsDefaultVersionHasBeenSet () const
 
void SetIsDefaultVersion (bool value)
 
PolicyVersionWithIsDefaultVersion (bool value)
 
const Aws::Utils::DateTimeGetCreateDate () const
 
bool CreateDateHasBeenSet () const
 
void SetCreateDate (const Aws::Utils::DateTime &value)
 
void SetCreateDate (Aws::Utils::DateTime &&value)
 
PolicyVersionWithCreateDate (const Aws::Utils::DateTime &value)
 
PolicyVersionWithCreateDate (Aws::Utils::DateTime &&value)
 

Detailed Description

Contains information about a version of a managed policy.

This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails 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 39 of file PolicyVersion.h.

Constructor & Destructor Documentation

◆ PolicyVersion() [1/2]

Aws::IAM::Model::PolicyVersion::PolicyVersion ( )

◆ PolicyVersion() [2/2]

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

Member Function Documentation

◆ CreateDateHasBeenSet()

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

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

Definition at line 255 of file PolicyVersion.h.

◆ DocumentHasBeenSet()

bool Aws::IAM::Model::PolicyVersion::DocumentHasBeenSet ( ) const
inline

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Definition at line 76 of file PolicyVersion.h.

◆ GetCreateDate()

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

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

Definition at line 249 of file PolicyVersion.h.

◆ GetDocument()

const Aws::String& Aws::IAM::Model::PolicyVersion::GetDocument ( ) const
inline

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Definition at line 62 of file PolicyVersion.h.

◆ GetIsDefaultVersion()

bool Aws::IAM::Model::PolicyVersion::GetIsDefaultVersion ( ) const
inline

Specifies whether the policy version is set as the policy's default version.

Definition at line 224 of file PolicyVersion.h.

◆ GetVersionId()

const Aws::String& Aws::IAM::Model::PolicyVersion::GetVersionId ( ) const
inline

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

Definition at line 168 of file PolicyVersion.h.

◆ IsDefaultVersionHasBeenSet()

bool Aws::IAM::Model::PolicyVersion::IsDefaultVersionHasBeenSet ( ) const
inline

Specifies whether the policy version is set as the policy's default version.

Definition at line 230 of file PolicyVersion.h.

◆ operator=()

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

◆ OutputToStream() [1/2]

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

◆ OutputToStream() [2/2]

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

◆ SetCreateDate() [1/2]

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

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

Definition at line 261 of file PolicyVersion.h.

◆ SetCreateDate() [2/2]

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

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

Definition at line 267 of file PolicyVersion.h.

◆ SetDocument() [1/3]

void Aws::IAM::Model::PolicyVersion::SetDocument ( const Aws::String value)
inline

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Definition at line 90 of file PolicyVersion.h.

◆ SetDocument() [2/3]

void Aws::IAM::Model::PolicyVersion::SetDocument ( Aws::String &&  value)
inline

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Definition at line 104 of file PolicyVersion.h.

◆ SetDocument() [3/3]

void Aws::IAM::Model::PolicyVersion::SetDocument ( const char *  value)
inline

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Definition at line 118 of file PolicyVersion.h.

◆ SetIsDefaultVersion()

void Aws::IAM::Model::PolicyVersion::SetIsDefaultVersion ( bool  value)
inline

Specifies whether the policy version is set as the policy's default version.

Definition at line 236 of file PolicyVersion.h.

◆ SetVersionId() [1/3]

void Aws::IAM::Model::PolicyVersion::SetVersionId ( const Aws::String value)
inline

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

Definition at line 182 of file PolicyVersion.h.

◆ SetVersionId() [2/3]

void Aws::IAM::Model::PolicyVersion::SetVersionId ( Aws::String &&  value)
inline

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

Definition at line 189 of file PolicyVersion.h.

◆ SetVersionId() [3/3]

void Aws::IAM::Model::PolicyVersion::SetVersionId ( const char *  value)
inline

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

Definition at line 196 of file PolicyVersion.h.

◆ VersionIdHasBeenSet()

bool Aws::IAM::Model::PolicyVersion::VersionIdHasBeenSet ( ) const
inline

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

Definition at line 175 of file PolicyVersion.h.

◆ WithCreateDate() [1/2]

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

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

Definition at line 273 of file PolicyVersion.h.

◆ WithCreateDate() [2/2]

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

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

Definition at line 279 of file PolicyVersion.h.

◆ WithDocument() [1/3]

PolicyVersion& Aws::IAM::Model::PolicyVersion::WithDocument ( const Aws::String value)
inline

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Definition at line 132 of file PolicyVersion.h.

◆ WithDocument() [2/3]

PolicyVersion& Aws::IAM::Model::PolicyVersion::WithDocument ( Aws::String &&  value)
inline

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Definition at line 146 of file PolicyVersion.h.

◆ WithDocument() [3/3]

PolicyVersion& Aws::IAM::Model::PolicyVersion::WithDocument ( const char *  value)
inline

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

Definition at line 160 of file PolicyVersion.h.

◆ WithIsDefaultVersion()

PolicyVersion& Aws::IAM::Model::PolicyVersion::WithIsDefaultVersion ( bool  value)
inline

Specifies whether the policy version is set as the policy's default version.

Definition at line 242 of file PolicyVersion.h.

◆ WithVersionId() [1/3]

PolicyVersion& Aws::IAM::Model::PolicyVersion::WithVersionId ( const Aws::String value)
inline

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

Definition at line 203 of file PolicyVersion.h.

◆ WithVersionId() [2/3]

PolicyVersion& Aws::IAM::Model::PolicyVersion::WithVersionId ( Aws::String &&  value)
inline

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

Definition at line 210 of file PolicyVersion.h.

◆ WithVersionId() [3/3]

PolicyVersion& Aws::IAM::Model::PolicyVersion::WithVersionId ( const char *  value)
inline

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

Definition at line 217 of file PolicyVersion.h.


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