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

#include <UpdateAliasRequest.h>

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

Public Member Functions

 UpdateAliasRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAliasName () const
 
bool AliasNameHasBeenSet () const
 
void SetAliasName (const Aws::String &value)
 
void SetAliasName (Aws::String &&value)
 
void SetAliasName (const char *value)
 
UpdateAliasRequestWithAliasName (const Aws::String &value)
 
UpdateAliasRequestWithAliasName (Aws::String &&value)
 
UpdateAliasRequestWithAliasName (const char *value)
 
const Aws::StringGetTargetKeyId () const
 
bool TargetKeyIdHasBeenSet () const
 
void SetTargetKeyId (const Aws::String &value)
 
void SetTargetKeyId (Aws::String &&value)
 
void SetTargetKeyId (const char *value)
 
UpdateAliasRequestWithTargetKeyId (const Aws::String &value)
 
UpdateAliasRequestWithTargetKeyId (Aws::String &&value)
 
UpdateAliasRequestWithTargetKeyId (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 UpdateAliasRequest.h.

Constructor & Destructor Documentation

◆ UpdateAliasRequest()

Aws::KMS::Model::UpdateAliasRequest::UpdateAliasRequest ( )

Member Function Documentation

◆ AliasNameHasBeenSet()

bool Aws::KMS::Model::UpdateAliasRequest::AliasNameHasBeenSet ( ) const
inline

Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

Definition at line 51 of file UpdateAliasRequest.h.

◆ GetAliasName()

const Aws::String& Aws::KMS::Model::UpdateAliasRequest::GetAliasName ( ) const
inline

Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

Definition at line 43 of file UpdateAliasRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file UpdateAliasRequest.h.

◆ GetTargetKeyId()

const Aws::String& Aws::KMS::Model::UpdateAliasRequest::GetTargetKeyId ( ) const
inline

Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct CMK, use ListAliases.

Definition at line 115 of file UpdateAliasRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAliasName() [1/3]

void Aws::KMS::Model::UpdateAliasRequest::SetAliasName ( const Aws::String value)
inline

Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

Definition at line 59 of file UpdateAliasRequest.h.

◆ SetAliasName() [2/3]

void Aws::KMS::Model::UpdateAliasRequest::SetAliasName ( Aws::String &&  value)
inline

Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

Definition at line 67 of file UpdateAliasRequest.h.

◆ SetAliasName() [3/3]

void Aws::KMS::Model::UpdateAliasRequest::SetAliasName ( const char *  value)
inline

Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

Definition at line 75 of file UpdateAliasRequest.h.

◆ SetTargetKeyId() [1/3]

void Aws::KMS::Model::UpdateAliasRequest::SetTargetKeyId ( const Aws::String value)
inline

Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct CMK, use ListAliases.

Definition at line 145 of file UpdateAliasRequest.h.

◆ SetTargetKeyId() [2/3]

void Aws::KMS::Model::UpdateAliasRequest::SetTargetKeyId ( Aws::String &&  value)
inline

Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct CMK, use ListAliases.

Definition at line 160 of file UpdateAliasRequest.h.

◆ SetTargetKeyId() [3/3]

void Aws::KMS::Model::UpdateAliasRequest::SetTargetKeyId ( const char *  value)
inline

Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct CMK, use ListAliases.

Definition at line 175 of file UpdateAliasRequest.h.

◆ TargetKeyIdHasBeenSet()

bool Aws::KMS::Model::UpdateAliasRequest::TargetKeyIdHasBeenSet ( ) const
inline

Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct CMK, use ListAliases.

Definition at line 130 of file UpdateAliasRequest.h.

◆ WithAliasName() [1/3]

UpdateAliasRequest& Aws::KMS::Model::UpdateAliasRequest::WithAliasName ( const Aws::String value)
inline

Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

Definition at line 83 of file UpdateAliasRequest.h.

◆ WithAliasName() [2/3]

UpdateAliasRequest& Aws::KMS::Model::UpdateAliasRequest::WithAliasName ( Aws::String &&  value)
inline

Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

Definition at line 91 of file UpdateAliasRequest.h.

◆ WithAliasName() [3/3]

UpdateAliasRequest& Aws::KMS::Model::UpdateAliasRequest::WithAliasName ( const char *  value)
inline

Identifies the alias that is changing its CMK. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias. You cannot use UpdateAlias to change the alias name.

Definition at line 99 of file UpdateAliasRequest.h.

◆ WithTargetKeyId() [1/3]

UpdateAliasRequest& Aws::KMS::Model::UpdateAliasRequest::WithTargetKeyId ( const Aws::String value)
inline

Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct CMK, use ListAliases.

Definition at line 190 of file UpdateAliasRequest.h.

◆ WithTargetKeyId() [2/3]

UpdateAliasRequest& Aws::KMS::Model::UpdateAliasRequest::WithTargetKeyId ( Aws::String &&  value)
inline

Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct CMK, use ListAliases.

Definition at line 205 of file UpdateAliasRequest.h.

◆ WithTargetKeyId() [3/3]

UpdateAliasRequest& Aws::KMS::Model::UpdateAliasRequest::WithTargetKeyId ( const char *  value)
inline

Identifies the CMK to associate with the alias. When the update operation completes, the alias will point to this CMK.

The CMK must be in the same AWS account and Region as the alias. Also, the new target CMK must be the same type as the current target CMK (both symmetric or both asymmetric) and they must have the same key usage.

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.

To verify that the alias is mapped to the correct CMK, use ListAliases.

Definition at line 220 of file UpdateAliasRequest.h.


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