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

#include <CreatePolicyRequest.h>

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

Public Member Functions

 CreatePolicyRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetPolicyName () const
 
bool PolicyNameHasBeenSet () const
 
void SetPolicyName (const Aws::String &value)
 
void SetPolicyName (Aws::String &&value)
 
void SetPolicyName (const char *value)
 
CreatePolicyRequestWithPolicyName (const Aws::String &value)
 
CreatePolicyRequestWithPolicyName (Aws::String &&value)
 
CreatePolicyRequestWithPolicyName (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)
 
CreatePolicyRequestWithPath (const Aws::String &value)
 
CreatePolicyRequestWithPath (Aws::String &&value)
 
CreatePolicyRequestWithPath (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)
 
CreatePolicyRequestWithPolicyDocument (const Aws::String &value)
 
CreatePolicyRequestWithPolicyDocument (Aws::String &&value)
 
CreatePolicyRequestWithPolicyDocument (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)
 
CreatePolicyRequestWithDescription (const Aws::String &value)
 
CreatePolicyRequestWithDescription (Aws::String &&value)
 
CreatePolicyRequestWithDescription (const char *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 CreatePolicyRequest.h.

Constructor & Destructor Documentation

◆ CreatePolicyRequest()

Aws::IAM::Model::CreatePolicyRequest::CreatePolicyRequest ( )

Member Function Documentation

◆ DescriptionHasBeenSet()

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

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Definition at line 368 of file CreatePolicyRequest.h.

◆ DumpBodyToUrl()

void Aws::IAM::Model::CreatePolicyRequest::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.

◆ GetDescription()

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

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Definition at line 360 of file CreatePolicyRequest.h.

◆ GetPath()

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

The path for the policy.

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

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 116 of file CreatePolicyRequest.h.

◆ GetPolicyDocument()

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

The JSON policy document that you want to use as the content for the new 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 232 of file CreatePolicyRequest.h.

◆ GetPolicyName()

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

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 45 of file CreatePolicyRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file CreatePolicyRequest.h.

◆ PathHasBeenSet()

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

The path for the policy.

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

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 130 of file CreatePolicyRequest.h.

◆ PolicyDocumentHasBeenSet()

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

The JSON policy document that you want to use as the content for the new 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 249 of file CreatePolicyRequest.h.

◆ PolicyNameHasBeenSet()

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

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 53 of file CreatePolicyRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDescription() [1/3]

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

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Definition at line 376 of file CreatePolicyRequest.h.

◆ SetDescription() [2/3]

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

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Definition at line 384 of file CreatePolicyRequest.h.

◆ SetDescription() [3/3]

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

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Definition at line 392 of file CreatePolicyRequest.h.

◆ SetPath() [1/3]

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

The path for the policy.

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

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 144 of file CreatePolicyRequest.h.

◆ SetPath() [2/3]

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

The path for the policy.

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

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 158 of file CreatePolicyRequest.h.

◆ SetPath() [3/3]

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

The path for the policy.

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

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 172 of file CreatePolicyRequest.h.

◆ SetPolicyDocument() [1/3]

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

The JSON policy document that you want to use as the content for the new 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 266 of file CreatePolicyRequest.h.

◆ SetPolicyDocument() [2/3]

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

The JSON policy document that you want to use as the content for the new 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 283 of file CreatePolicyRequest.h.

◆ SetPolicyDocument() [3/3]

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

The JSON policy document that you want to use as the content for the new 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 300 of file CreatePolicyRequest.h.

◆ SetPolicyName() [1/3]

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

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 61 of file CreatePolicyRequest.h.

◆ SetPolicyName() [2/3]

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

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 69 of file CreatePolicyRequest.h.

◆ SetPolicyName() [3/3]

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

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 77 of file CreatePolicyRequest.h.

◆ WithDescription() [1/3]

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

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Definition at line 400 of file CreatePolicyRequest.h.

◆ WithDescription() [2/3]

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

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Definition at line 408 of file CreatePolicyRequest.h.

◆ WithDescription() [3/3]

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

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, "Grants access to production DynamoDB tables."

The policy description is immutable. After a value is assigned, it cannot be changed.

Definition at line 416 of file CreatePolicyRequest.h.

◆ WithPath() [1/3]

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

The path for the policy.

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

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 186 of file CreatePolicyRequest.h.

◆ WithPath() [2/3]

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

The path for the policy.

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

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 200 of file CreatePolicyRequest.h.

◆ WithPath() [3/3]

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

The path for the policy.

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

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! () through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Definition at line 214 of file CreatePolicyRequest.h.

◆ WithPolicyDocument() [1/3]

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

The JSON policy document that you want to use as the content for the new 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 317 of file CreatePolicyRequest.h.

◆ WithPolicyDocument() [2/3]

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

The JSON policy document that you want to use as the content for the new 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 334 of file CreatePolicyRequest.h.

◆ WithPolicyDocument() [3/3]

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

The JSON policy document that you want to use as the content for the new 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 351 of file CreatePolicyRequest.h.

◆ WithPolicyName() [1/3]

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

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 85 of file CreatePolicyRequest.h.

◆ WithPolicyName() [2/3]

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

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 93 of file CreatePolicyRequest.h.

◆ WithPolicyName() [3/3]

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

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both "MyResource" and "myresource".

Definition at line 101 of file CreatePolicyRequest.h.


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