AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::KMS::Model::GetKeyPolicyRequest Class Reference

#include <GetKeyPolicyRequest.h>

+ Inheritance diagram for Aws::KMS::Model::GetKeyPolicyRequest:

Public Member Functions

 GetKeyPolicyRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetKeyId () const
 
bool KeyIdHasBeenSet () const
 
void SetKeyId (const Aws::String &value)
 
void SetKeyId (Aws::String &&value)
 
void SetKeyId (const char *value)
 
GetKeyPolicyRequestWithKeyId (const Aws::String &value)
 
GetKeyPolicyRequestWithKeyId (Aws::String &&value)
 
GetKeyPolicyRequestWithKeyId (const char *value)
 
const Aws::StringGetPolicyName () const
 
bool PolicyNameHasBeenSet () const
 
void SetPolicyName (const Aws::String &value)
 
void SetPolicyName (Aws::String &&value)
 
void SetPolicyName (const char *value)
 
GetKeyPolicyRequestWithPolicyName (const Aws::String &value)
 
GetKeyPolicyRequestWithPolicyName (Aws::String &&value)
 
GetKeyPolicyRequestWithPolicyName (const char *value)
 
- Public Member Functions inherited from Aws::KMS::KMSRequest
virtual ~KMSRequest ()
 
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
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file GetKeyPolicyRequest.h.

Constructor & Destructor Documentation

◆ GetKeyPolicyRequest()

Aws::KMS::Model::GetKeyPolicyRequest::GetKeyPolicyRequest ( )

Member Function Documentation

◆ GetKeyId()

const Aws::String& Aws::KMS::Model::GetKeyPolicyRequest::GetKeyId ( ) const
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 46 of file GetKeyPolicyRequest.h.

◆ GetPolicyName()

const Aws::String& Aws::KMS::Model::GetKeyPolicyRequest::GetPolicyName ( ) const
inline

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Definition at line 131 of file GetKeyPolicyRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::KMS::Model::GetKeyPolicyRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

virtual const char* Aws::KMS::Model::GetKeyPolicyRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetKeyPolicyRequest.h.

◆ KeyIdHasBeenSet()

bool Aws::KMS::Model::GetKeyPolicyRequest::KeyIdHasBeenSet ( ) const
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 57 of file GetKeyPolicyRequest.h.

◆ PolicyNameHasBeenSet()

bool Aws::KMS::Model::GetKeyPolicyRequest::PolicyNameHasBeenSet ( ) const
inline

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Definition at line 138 of file GetKeyPolicyRequest.h.

◆ SerializePayload()

Aws::String Aws::KMS::Model::GetKeyPolicyRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetKeyId() [1/3]

void Aws::KMS::Model::GetKeyPolicyRequest::SetKeyId ( const Aws::String value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 68 of file GetKeyPolicyRequest.h.

◆ SetKeyId() [2/3]

void Aws::KMS::Model::GetKeyPolicyRequest::SetKeyId ( Aws::String &&  value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 79 of file GetKeyPolicyRequest.h.

◆ SetKeyId() [3/3]

void Aws::KMS::Model::GetKeyPolicyRequest::SetKeyId ( const char *  value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 90 of file GetKeyPolicyRequest.h.

◆ SetPolicyName() [1/3]

void Aws::KMS::Model::GetKeyPolicyRequest::SetPolicyName ( const Aws::String value)
inline

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Definition at line 145 of file GetKeyPolicyRequest.h.

◆ SetPolicyName() [2/3]

void Aws::KMS::Model::GetKeyPolicyRequest::SetPolicyName ( Aws::String &&  value)
inline

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Definition at line 152 of file GetKeyPolicyRequest.h.

◆ SetPolicyName() [3/3]

void Aws::KMS::Model::GetKeyPolicyRequest::SetPolicyName ( const char *  value)
inline

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Definition at line 159 of file GetKeyPolicyRequest.h.

◆ WithKeyId() [1/3]

GetKeyPolicyRequest& Aws::KMS::Model::GetKeyPolicyRequest::WithKeyId ( const Aws::String value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 101 of file GetKeyPolicyRequest.h.

◆ WithKeyId() [2/3]

GetKeyPolicyRequest& Aws::KMS::Model::GetKeyPolicyRequest::WithKeyId ( Aws::String &&  value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 112 of file GetKeyPolicyRequest.h.

◆ WithKeyId() [3/3]

GetKeyPolicyRequest& Aws::KMS::Model::GetKeyPolicyRequest::WithKeyId ( const char *  value)
inline

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

Definition at line 123 of file GetKeyPolicyRequest.h.

◆ WithPolicyName() [1/3]

GetKeyPolicyRequest& Aws::KMS::Model::GetKeyPolicyRequest::WithPolicyName ( const Aws::String value)
inline

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Definition at line 166 of file GetKeyPolicyRequest.h.

◆ WithPolicyName() [2/3]

GetKeyPolicyRequest& Aws::KMS::Model::GetKeyPolicyRequest::WithPolicyName ( Aws::String &&  value)
inline

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Definition at line 173 of file GetKeyPolicyRequest.h.

◆ WithPolicyName() [3/3]

GetKeyPolicyRequest& Aws::KMS::Model::GetKeyPolicyRequest::WithPolicyName ( const char *  value)
inline

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Definition at line 180 of file GetKeyPolicyRequest.h.


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