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

#include <ScheduleKeyDeletionRequest.h>

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

Public Member Functions

 ScheduleKeyDeletionRequest ()
 
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)
 
ScheduleKeyDeletionRequestWithKeyId (const Aws::String &value)
 
ScheduleKeyDeletionRequestWithKeyId (Aws::String &&value)
 
ScheduleKeyDeletionRequestWithKeyId (const char *value)
 
int GetPendingWindowInDays () const
 
bool PendingWindowInDaysHasBeenSet () const
 
void SetPendingWindowInDays (int value)
 
ScheduleKeyDeletionRequestWithPendingWindowInDays (int 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 ScheduleKeyDeletionRequest.h.

Constructor & Destructor Documentation

◆ ScheduleKeyDeletionRequest()

Aws::KMS::Model::ScheduleKeyDeletionRequest::ScheduleKeyDeletionRequest ( )

Member Function Documentation

◆ GetKeyId()

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

The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Definition at line 45 of file ScheduleKeyDeletionRequest.h.

◆ GetPendingWindowInDays()

int Aws::KMS::Model::ScheduleKeyDeletionRequest::GetPendingWindowInDays ( ) const
inline

The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

Definition at line 126 of file ScheduleKeyDeletionRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ScheduleKeyDeletionRequest.h.

◆ KeyIdHasBeenSet()

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

The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Definition at line 55 of file ScheduleKeyDeletionRequest.h.

◆ PendingWindowInDaysHasBeenSet()

bool Aws::KMS::Model::ScheduleKeyDeletionRequest::PendingWindowInDaysHasBeenSet ( ) const
inline

The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

Definition at line 136 of file ScheduleKeyDeletionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetKeyId() [1/3]

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

The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Definition at line 75 of file ScheduleKeyDeletionRequest.h.

◆ SetKeyId() [2/3]

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

The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Definition at line 65 of file ScheduleKeyDeletionRequest.h.

◆ SetKeyId() [3/3]

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

The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Definition at line 85 of file ScheduleKeyDeletionRequest.h.

◆ SetPendingWindowInDays()

void Aws::KMS::Model::ScheduleKeyDeletionRequest::SetPendingWindowInDays ( int  value)
inline

The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

Definition at line 146 of file ScheduleKeyDeletionRequest.h.

◆ WithKeyId() [1/3]

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

The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Definition at line 105 of file ScheduleKeyDeletionRequest.h.

◆ WithKeyId() [2/3]

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

The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Definition at line 95 of file ScheduleKeyDeletionRequest.h.

◆ WithKeyId() [3/3]

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

The unique identifier of the KMS key to delete.

Specify the key ID or key ARN of the KMS key.

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 KMS key, use ListKeys or DescribeKey.

Definition at line 115 of file ScheduleKeyDeletionRequest.h.

◆ WithPendingWindowInDays()

ScheduleKeyDeletionRequest& Aws::KMS::Model::ScheduleKeyDeletionRequest::WithPendingWindowInDays ( int  value)
inline

The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

Definition at line 156 of file ScheduleKeyDeletionRequest.h.


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