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

#include <ImportKeyMaterialRequest.h>

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

Public Member Functions

 ImportKeyMaterialRequest ()
 
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)
 
ImportKeyMaterialRequestWithKeyId (const Aws::String &value)
 
ImportKeyMaterialRequestWithKeyId (Aws::String &&value)
 
ImportKeyMaterialRequestWithKeyId (const char *value)
 
const Aws::Utils::ByteBufferGetImportToken () const
 
bool ImportTokenHasBeenSet () const
 
void SetImportToken (const Aws::Utils::ByteBuffer &value)
 
void SetImportToken (Aws::Utils::ByteBuffer &&value)
 
ImportKeyMaterialRequestWithImportToken (const Aws::Utils::ByteBuffer &value)
 
ImportKeyMaterialRequestWithImportToken (Aws::Utils::ByteBuffer &&value)
 
const Aws::Utils::ByteBufferGetEncryptedKeyMaterial () const
 
bool EncryptedKeyMaterialHasBeenSet () const
 
void SetEncryptedKeyMaterial (const Aws::Utils::ByteBuffer &value)
 
void SetEncryptedKeyMaterial (Aws::Utils::ByteBuffer &&value)
 
ImportKeyMaterialRequestWithEncryptedKeyMaterial (const Aws::Utils::ByteBuffer &value)
 
ImportKeyMaterialRequestWithEncryptedKeyMaterial (Aws::Utils::ByteBuffer &&value)
 
const Aws::Utils::DateTimeGetValidTo () const
 
bool ValidToHasBeenSet () const
 
void SetValidTo (const Aws::Utils::DateTime &value)
 
void SetValidTo (Aws::Utils::DateTime &&value)
 
ImportKeyMaterialRequestWithValidTo (const Aws::Utils::DateTime &value)
 
ImportKeyMaterialRequestWithValidTo (Aws::Utils::DateTime &&value)
 
const ExpirationModelTypeGetExpirationModel () const
 
bool ExpirationModelHasBeenSet () const
 
void SetExpirationModel (const ExpirationModelType &value)
 
void SetExpirationModel (ExpirationModelType &&value)
 
ImportKeyMaterialRequestWithExpirationModel (const ExpirationModelType &value)
 
ImportKeyMaterialRequestWithExpirationModel (ExpirationModelType &&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 24 of file ImportKeyMaterialRequest.h.

Constructor & Destructor Documentation

◆ ImportKeyMaterialRequest()

Aws::KMS::Model::ImportKeyMaterialRequest::ImportKeyMaterialRequest ( )

Member Function Documentation

◆ EncryptedKeyMaterialHasBeenSet()

bool Aws::KMS::Model::ImportKeyMaterialRequest::EncryptedKeyMaterialHasBeenSet ( ) const
inline

The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport request.

Definition at line 202 of file ImportKeyMaterialRequest.h.

◆ ExpirationModelHasBeenSet()

bool Aws::KMS::Model::ImportKeyMaterialRequest::ExpirationModelHasBeenSet ( ) const
inline

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

Definition at line 302 of file ImportKeyMaterialRequest.h.

◆ GetEncryptedKeyMaterial()

const Aws::Utils::ByteBuffer& Aws::KMS::Model::ImportKeyMaterialRequest::GetEncryptedKeyMaterial ( ) const
inline

The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport request.

Definition at line 194 of file ImportKeyMaterialRequest.h.

◆ GetExpirationModel()

const ExpirationModelType& Aws::KMS::Model::ImportKeyMaterialRequest::GetExpirationModel ( ) const
inline

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

Definition at line 293 of file ImportKeyMaterialRequest.h.

◆ GetImportToken()

const Aws::Utils::ByteBuffer& Aws::KMS::Model::ImportKeyMaterialRequest::GetImportToken ( ) const
inline

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

Definition at line 150 of file ImportKeyMaterialRequest.h.

◆ GetKeyId()

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

The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

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 51 of file ImportKeyMaterialRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file ImportKeyMaterialRequest.h.

◆ GetValidTo()

const Aws::Utils::DateTime& Aws::KMS::Model::ImportKeyMaterialRequest::GetValidTo ( ) const
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

Definition at line 243 of file ImportKeyMaterialRequest.h.

◆ ImportTokenHasBeenSet()

bool Aws::KMS::Model::ImportKeyMaterialRequest::ImportTokenHasBeenSet ( ) const
inline

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

Definition at line 157 of file ImportKeyMaterialRequest.h.

◆ KeyIdHasBeenSet()

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

The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

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 64 of file ImportKeyMaterialRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEncryptedKeyMaterial() [1/2]

void Aws::KMS::Model::ImportKeyMaterialRequest::SetEncryptedKeyMaterial ( const Aws::Utils::ByteBuffer value)
inline

The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport request.

Definition at line 210 of file ImportKeyMaterialRequest.h.

◆ SetEncryptedKeyMaterial() [2/2]

void Aws::KMS::Model::ImportKeyMaterialRequest::SetEncryptedKeyMaterial ( Aws::Utils::ByteBuffer &&  value)
inline

The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport request.

Definition at line 218 of file ImportKeyMaterialRequest.h.

◆ SetExpirationModel() [1/2]

void Aws::KMS::Model::ImportKeyMaterialRequest::SetExpirationModel ( const ExpirationModelType value)
inline

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

Definition at line 311 of file ImportKeyMaterialRequest.h.

◆ SetExpirationModel() [2/2]

void Aws::KMS::Model::ImportKeyMaterialRequest::SetExpirationModel ( ExpirationModelType &&  value)
inline

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

Definition at line 320 of file ImportKeyMaterialRequest.h.

◆ SetImportToken() [1/2]

void Aws::KMS::Model::ImportKeyMaterialRequest::SetImportToken ( const Aws::Utils::ByteBuffer value)
inline

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

Definition at line 164 of file ImportKeyMaterialRequest.h.

◆ SetImportToken() [2/2]

void Aws::KMS::Model::ImportKeyMaterialRequest::SetImportToken ( Aws::Utils::ByteBuffer &&  value)
inline

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

Definition at line 171 of file ImportKeyMaterialRequest.h.

◆ SetKeyId() [1/3]

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

The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

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 77 of file ImportKeyMaterialRequest.h.

◆ SetKeyId() [2/3]

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

The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

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 ImportKeyMaterialRequest.h.

◆ SetKeyId() [3/3]

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

The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

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 103 of file ImportKeyMaterialRequest.h.

◆ SetValidTo() [1/2]

void Aws::KMS::Model::ImportKeyMaterialRequest::SetValidTo ( const Aws::Utils::DateTime value)
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

Definition at line 259 of file ImportKeyMaterialRequest.h.

◆ SetValidTo() [2/2]

void Aws::KMS::Model::ImportKeyMaterialRequest::SetValidTo ( Aws::Utils::DateTime &&  value)
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

Definition at line 267 of file ImportKeyMaterialRequest.h.

◆ ValidToHasBeenSet()

bool Aws::KMS::Model::ImportKeyMaterialRequest::ValidToHasBeenSet ( ) const
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

Definition at line 251 of file ImportKeyMaterialRequest.h.

◆ WithEncryptedKeyMaterial() [1/2]

ImportKeyMaterialRequest& Aws::KMS::Model::ImportKeyMaterialRequest::WithEncryptedKeyMaterial ( const Aws::Utils::ByteBuffer value)
inline

The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport request.

Definition at line 226 of file ImportKeyMaterialRequest.h.

◆ WithEncryptedKeyMaterial() [2/2]

ImportKeyMaterialRequest& Aws::KMS::Model::ImportKeyMaterialRequest::WithEncryptedKeyMaterial ( Aws::Utils::ByteBuffer &&  value)
inline

The encrypted key material to import. The key material must be encrypted with the public wrapping key that GetParametersForImport returned, using the wrapping algorithm that you specified in the same GetParametersForImport request.

Definition at line 234 of file ImportKeyMaterialRequest.h.

◆ WithExpirationModel() [1/2]

ImportKeyMaterialRequest& Aws::KMS::Model::ImportKeyMaterialRequest::WithExpirationModel ( const ExpirationModelType value)
inline

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

Definition at line 329 of file ImportKeyMaterialRequest.h.

◆ WithExpirationModel() [2/2]

ImportKeyMaterialRequest& Aws::KMS::Model::ImportKeyMaterialRequest::WithExpirationModel ( ExpirationModelType &&  value)
inline

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

Definition at line 338 of file ImportKeyMaterialRequest.h.

◆ WithImportToken() [1/2]

ImportKeyMaterialRequest& Aws::KMS::Model::ImportKeyMaterialRequest::WithImportToken ( const Aws::Utils::ByteBuffer value)
inline

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

Definition at line 178 of file ImportKeyMaterialRequest.h.

◆ WithImportToken() [2/2]

ImportKeyMaterialRequest& Aws::KMS::Model::ImportKeyMaterialRequest::WithImportToken ( Aws::Utils::ByteBuffer &&  value)
inline

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

Definition at line 185 of file ImportKeyMaterialRequest.h.

◆ WithKeyId() [1/3]

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

The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

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 116 of file ImportKeyMaterialRequest.h.

◆ WithKeyId() [2/3]

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

The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

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 129 of file ImportKeyMaterialRequest.h.

◆ WithKeyId() [3/3]

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

The identifier of the symmetric CMK that receives the imported key material. The CMK's Origin must be EXTERNAL. This must be the same CMK specified in the KeyID parameter of the corresponding GetParametersForImport request.

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 142 of file ImportKeyMaterialRequest.h.

◆ WithValidTo() [1/2]

ImportKeyMaterialRequest& Aws::KMS::Model::ImportKeyMaterialRequest::WithValidTo ( const Aws::Utils::DateTime value)
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

Definition at line 275 of file ImportKeyMaterialRequest.h.

◆ WithValidTo() [2/2]

ImportKeyMaterialRequest& Aws::KMS::Model::ImportKeyMaterialRequest::WithValidTo ( Aws::Utils::DateTime &&  value)
inline

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

Definition at line 283 of file ImportKeyMaterialRequest.h.


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