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

#include <UpdatePrimaryRegionRequest.h>

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

Public Member Functions

 UpdatePrimaryRegionRequest ()
 
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)
 
UpdatePrimaryRegionRequestWithKeyId (const Aws::String &value)
 
UpdatePrimaryRegionRequestWithKeyId (Aws::String &&value)
 
UpdatePrimaryRegionRequestWithKeyId (const char *value)
 
const Aws::StringGetPrimaryRegion () const
 
bool PrimaryRegionHasBeenSet () const
 
void SetPrimaryRegion (const Aws::String &value)
 
void SetPrimaryRegion (Aws::String &&value)
 
void SetPrimaryRegion (const char *value)
 
UpdatePrimaryRegionRequestWithPrimaryRegion (const Aws::String &value)
 
UpdatePrimaryRegionRequestWithPrimaryRegion (Aws::String &&value)
 
UpdatePrimaryRegionRequestWithPrimaryRegion (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 UpdatePrimaryRegionRequest.h.

Constructor & Destructor Documentation

◆ UpdatePrimaryRegionRequest()

Aws::KMS::Model::UpdatePrimaryRegionRequest::UpdatePrimaryRegionRequest ( )

Member Function Documentation

◆ GetKeyId()

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

Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

  • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

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

Definition at line 46 of file UpdatePrimaryRegionRequest.h.

◆ GetPrimaryRegion()

const Aws::String& Aws::KMS::Model::UpdatePrimaryRegionRequest::GetPrimaryRegion ( ) const
inline

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

Definition at line 132 of file UpdatePrimaryRegionRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file UpdatePrimaryRegionRequest.h.

◆ KeyIdHasBeenSet()

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

Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

  • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

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

Definition at line 57 of file UpdatePrimaryRegionRequest.h.

◆ PrimaryRegionHasBeenSet()

bool Aws::KMS::Model::UpdatePrimaryRegionRequest::PrimaryRegionHasBeenSet ( ) const
inline

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

Definition at line 140 of file UpdatePrimaryRegionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetKeyId() [1/3]

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

Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

  • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

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

Definition at line 79 of file UpdatePrimaryRegionRequest.h.

◆ SetKeyId() [2/3]

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

Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

  • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

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

Definition at line 68 of file UpdatePrimaryRegionRequest.h.

◆ SetKeyId() [3/3]

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

Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

  • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

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

Definition at line 90 of file UpdatePrimaryRegionRequest.h.

◆ SetPrimaryRegion() [1/3]

void Aws::KMS::Model::UpdatePrimaryRegionRequest::SetPrimaryRegion ( Aws::String &&  value)
inline

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

Definition at line 156 of file UpdatePrimaryRegionRequest.h.

◆ SetPrimaryRegion() [2/3]

void Aws::KMS::Model::UpdatePrimaryRegionRequest::SetPrimaryRegion ( const Aws::String value)
inline

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

Definition at line 148 of file UpdatePrimaryRegionRequest.h.

◆ SetPrimaryRegion() [3/3]

void Aws::KMS::Model::UpdatePrimaryRegionRequest::SetPrimaryRegion ( const char *  value)
inline

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

Definition at line 164 of file UpdatePrimaryRegionRequest.h.

◆ WithKeyId() [1/3]

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

Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

  • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

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

Definition at line 112 of file UpdatePrimaryRegionRequest.h.

◆ WithKeyId() [2/3]

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

Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

  • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

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

Definition at line 101 of file UpdatePrimaryRegionRequest.h.

◆ WithKeyId() [3/3]

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

Identifies the current primary key. When the operation completes, this KMS key will be a replica key.

Specify the key ID or key ARN of a multi-Region primary key.

For example:

  • Key ID: mrk-1234abcd12ab34cd56ef1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab

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

Definition at line 123 of file UpdatePrimaryRegionRequest.h.

◆ WithPrimaryRegion() [1/3]

UpdatePrimaryRegionRequest& Aws::KMS::Model::UpdatePrimaryRegionRequest::WithPrimaryRegion ( Aws::String &&  value)
inline

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

Definition at line 180 of file UpdatePrimaryRegionRequest.h.

◆ WithPrimaryRegion() [2/3]

UpdatePrimaryRegionRequest& Aws::KMS::Model::UpdatePrimaryRegionRequest::WithPrimaryRegion ( const Aws::String value)
inline

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

Definition at line 172 of file UpdatePrimaryRegionRequest.h.

◆ WithPrimaryRegion() [3/3]

UpdatePrimaryRegionRequest& Aws::KMS::Model::UpdatePrimaryRegionRequest::WithPrimaryRegion ( const char *  value)
inline

The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or ap-southeast-2. There must be an existing replica key in this Region.

When the operation completes, the multi-Region key in this Region will be the primary key.

Definition at line 188 of file UpdatePrimaryRegionRequest.h.


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