AWS SDK for C++  1.8.27
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::IAM::Model::CreatePolicyVersionRequest Class Reference

#include <CreatePolicyVersionRequest.h>

+ Inheritance diagram for Aws::IAM::Model::CreatePolicyVersionRequest:

Public Member Functions

 CreatePolicyVersionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetPolicyArn () const
 
bool PolicyArnHasBeenSet () const
 
void SetPolicyArn (const Aws::String &value)
 
void SetPolicyArn (Aws::String &&value)
 
void SetPolicyArn (const char *value)
 
CreatePolicyVersionRequestWithPolicyArn (const Aws::String &value)
 
CreatePolicyVersionRequestWithPolicyArn (Aws::String &&value)
 
CreatePolicyVersionRequestWithPolicyArn (const char *value)
 
const Aws::StringGetPolicyDocument () const
 
bool PolicyDocumentHasBeenSet () const
 
void SetPolicyDocument (const Aws::String &value)
 
void SetPolicyDocument (Aws::String &&value)
 
void SetPolicyDocument (const char *value)
 
CreatePolicyVersionRequestWithPolicyDocument (const Aws::String &value)
 
CreatePolicyVersionRequestWithPolicyDocument (Aws::String &&value)
 
CreatePolicyVersionRequestWithPolicyDocument (const char *value)
 
bool GetSetAsDefault () const
 
bool SetAsDefaultHasBeenSet () const
 
void SetSetAsDefault (bool value)
 
CreatePolicyVersionRequestWithSetAsDefault (bool value)
 
- Public Member Functions inherited from Aws::IAM::IAMRequest
virtual ~IAMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::IAM::IAMRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 21 of file CreatePolicyVersionRequest.h.

Constructor & Destructor Documentation

◆ CreatePolicyVersionRequest()

Aws::IAM::Model::CreatePolicyVersionRequest::CreatePolicyVersionRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::IAM::Model::CreatePolicyVersionRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetPolicyArn()

const Aws::String& Aws::IAM::Model::CreatePolicyVersionRequest::GetPolicyArn ( ) const
inline

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Definition at line 46 of file CreatePolicyVersionRequest.h.

◆ GetPolicyDocument()

const Aws::String& Aws::IAM::Model::CreatePolicyVersionRequest::GetPolicyDocument ( ) const
inline

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 127 of file CreatePolicyVersionRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::IAM::Model::CreatePolicyVersionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file CreatePolicyVersionRequest.h.

◆ GetSetAsDefault()

bool Aws::IAM::Model::CreatePolicyVersionRequest::GetSetAsDefault ( ) const
inline

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

Definition at line 258 of file CreatePolicyVersionRequest.h.

◆ PolicyArnHasBeenSet()

bool Aws::IAM::Model::CreatePolicyVersionRequest::PolicyArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Definition at line 55 of file CreatePolicyVersionRequest.h.

◆ PolicyDocumentHasBeenSet()

bool Aws::IAM::Model::CreatePolicyVersionRequest::PolicyDocumentHasBeenSet ( ) const
inline

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 144 of file CreatePolicyVersionRequest.h.

◆ SerializePayload()

Aws::String Aws::IAM::Model::CreatePolicyVersionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAsDefaultHasBeenSet()

bool Aws::IAM::Model::CreatePolicyVersionRequest::SetAsDefaultHasBeenSet ( ) const
inline

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

Definition at line 269 of file CreatePolicyVersionRequest.h.

◆ SetPolicyArn() [1/3]

void Aws::IAM::Model::CreatePolicyVersionRequest::SetPolicyArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Definition at line 64 of file CreatePolicyVersionRequest.h.

◆ SetPolicyArn() [2/3]

void Aws::IAM::Model::CreatePolicyVersionRequest::SetPolicyArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Definition at line 73 of file CreatePolicyVersionRequest.h.

◆ SetPolicyArn() [3/3]

void Aws::IAM::Model::CreatePolicyVersionRequest::SetPolicyArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Definition at line 82 of file CreatePolicyVersionRequest.h.

◆ SetPolicyDocument() [1/3]

void Aws::IAM::Model::CreatePolicyVersionRequest::SetPolicyDocument ( const Aws::String value)
inline

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 161 of file CreatePolicyVersionRequest.h.

◆ SetPolicyDocument() [2/3]

void Aws::IAM::Model::CreatePolicyVersionRequest::SetPolicyDocument ( Aws::String &&  value)
inline

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 178 of file CreatePolicyVersionRequest.h.

◆ SetPolicyDocument() [3/3]

void Aws::IAM::Model::CreatePolicyVersionRequest::SetPolicyDocument ( const char *  value)
inline

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 195 of file CreatePolicyVersionRequest.h.

◆ SetSetAsDefault()

void Aws::IAM::Model::CreatePolicyVersionRequest::SetSetAsDefault ( bool  value)
inline

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

Definition at line 280 of file CreatePolicyVersionRequest.h.

◆ WithPolicyArn() [1/3]

CreatePolicyVersionRequest& Aws::IAM::Model::CreatePolicyVersionRequest::WithPolicyArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Definition at line 91 of file CreatePolicyVersionRequest.h.

◆ WithPolicyArn() [2/3]

CreatePolicyVersionRequest& Aws::IAM::Model::CreatePolicyVersionRequest::WithPolicyArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Definition at line 100 of file CreatePolicyVersionRequest.h.

◆ WithPolicyArn() [3/3]

CreatePolicyVersionRequest& Aws::IAM::Model::CreatePolicyVersionRequest::WithPolicyArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Definition at line 109 of file CreatePolicyVersionRequest.h.

◆ WithPolicyDocument() [1/3]

CreatePolicyVersionRequest& Aws::IAM::Model::CreatePolicyVersionRequest::WithPolicyDocument ( const Aws::String value)
inline

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 212 of file CreatePolicyVersionRequest.h.

◆ WithPolicyDocument() [2/3]

CreatePolicyVersionRequest& Aws::IAM::Model::CreatePolicyVersionRequest::WithPolicyDocument ( Aws::String &&  value)
inline

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 229 of file CreatePolicyVersionRequest.h.

◆ WithPolicyDocument() [3/3]

CreatePolicyVersionRequest& Aws::IAM::Model::CreatePolicyVersionRequest::WithPolicyDocument ( const char *  value)
inline

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character () through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through )

  • The special characters tab (), line feed (), and carriage return ()

Definition at line 246 of file CreatePolicyVersionRequest.h.

◆ WithSetAsDefault()

CreatePolicyVersionRequest& Aws::IAM::Model::CreatePolicyVersionRequest::WithSetAsDefault ( bool  value)
inline

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

Definition at line 291 of file CreatePolicyVersionRequest.h.


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