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

#include <RevokeGrantRequest.h>

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

Public Member Functions

 RevokeGrantRequest ()
 
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)
 
RevokeGrantRequestWithKeyId (const Aws::String &value)
 
RevokeGrantRequestWithKeyId (Aws::String &&value)
 
RevokeGrantRequestWithKeyId (const char *value)
 
const Aws::StringGetGrantId () const
 
bool GrantIdHasBeenSet () const
 
void SetGrantId (const Aws::String &value)
 
void SetGrantId (Aws::String &&value)
 
void SetGrantId (const char *value)
 
RevokeGrantRequestWithGrantId (const Aws::String &value)
 
RevokeGrantRequestWithGrantId (Aws::String &&value)
 
RevokeGrantRequestWithGrantId (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 RevokeGrantRequest.h.

Constructor & Destructor Documentation

◆ RevokeGrantRequest()

Aws::KMS::Model::RevokeGrantRequest::RevokeGrantRequest ( )

Member Function Documentation

◆ GetGrantId()

const Aws::String& Aws::KMS::Model::RevokeGrantRequest::GetGrantId ( ) const
inline

Identifier of the grant to be revoked.

Definition at line 137 of file RevokeGrantRequest.h.

◆ GetKeyId()

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

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 47 of file RevokeGrantRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file RevokeGrantRequest.h.

◆ GrantIdHasBeenSet()

bool Aws::KMS::Model::RevokeGrantRequest::GrantIdHasBeenSet ( ) const
inline

Identifier of the grant to be revoked.

Definition at line 142 of file RevokeGrantRequest.h.

◆ KeyIdHasBeenSet()

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

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 59 of file RevokeGrantRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetGrantId() [1/3]

void Aws::KMS::Model::RevokeGrantRequest::SetGrantId ( const Aws::String value)
inline

Identifier of the grant to be revoked.

Definition at line 147 of file RevokeGrantRequest.h.

◆ SetGrantId() [2/3]

void Aws::KMS::Model::RevokeGrantRequest::SetGrantId ( Aws::String &&  value)
inline

Identifier of the grant to be revoked.

Definition at line 152 of file RevokeGrantRequest.h.

◆ SetGrantId() [3/3]

void Aws::KMS::Model::RevokeGrantRequest::SetGrantId ( const char *  value)
inline

Identifier of the grant to be revoked.

Definition at line 157 of file RevokeGrantRequest.h.

◆ SetKeyId() [1/3]

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

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 71 of file RevokeGrantRequest.h.

◆ SetKeyId() [2/3]

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

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 83 of file RevokeGrantRequest.h.

◆ SetKeyId() [3/3]

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

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 95 of file RevokeGrantRequest.h.

◆ WithGrantId() [1/3]

RevokeGrantRequest& Aws::KMS::Model::RevokeGrantRequest::WithGrantId ( const Aws::String value)
inline

Identifier of the grant to be revoked.

Definition at line 162 of file RevokeGrantRequest.h.

◆ WithGrantId() [2/3]

RevokeGrantRequest& Aws::KMS::Model::RevokeGrantRequest::WithGrantId ( Aws::String &&  value)
inline

Identifier of the grant to be revoked.

Definition at line 167 of file RevokeGrantRequest.h.

◆ WithGrantId() [3/3]

RevokeGrantRequest& Aws::KMS::Model::RevokeGrantRequest::WithGrantId ( const char *  value)
inline

Identifier of the grant to be revoked.

Definition at line 172 of file RevokeGrantRequest.h.

◆ WithKeyId() [1/3]

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

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 107 of file RevokeGrantRequest.h.

◆ WithKeyId() [2/3]

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

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 119 of file RevokeGrantRequest.h.

◆ WithKeyId() [3/3]

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

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 131 of file RevokeGrantRequest.h.


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