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

#include <UpdateCustomKeyStoreRequest.h>

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

Public Member Functions

 UpdateCustomKeyStoreRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCustomKeyStoreId () const
 
bool CustomKeyStoreIdHasBeenSet () const
 
void SetCustomKeyStoreId (const Aws::String &value)
 
void SetCustomKeyStoreId (Aws::String &&value)
 
void SetCustomKeyStoreId (const char *value)
 
UpdateCustomKeyStoreRequestWithCustomKeyStoreId (const Aws::String &value)
 
UpdateCustomKeyStoreRequestWithCustomKeyStoreId (Aws::String &&value)
 
UpdateCustomKeyStoreRequestWithCustomKeyStoreId (const char *value)
 
const Aws::StringGetNewCustomKeyStoreName () const
 
bool NewCustomKeyStoreNameHasBeenSet () const
 
void SetNewCustomKeyStoreName (const Aws::String &value)
 
void SetNewCustomKeyStoreName (Aws::String &&value)
 
void SetNewCustomKeyStoreName (const char *value)
 
UpdateCustomKeyStoreRequestWithNewCustomKeyStoreName (const Aws::String &value)
 
UpdateCustomKeyStoreRequestWithNewCustomKeyStoreName (Aws::String &&value)
 
UpdateCustomKeyStoreRequestWithNewCustomKeyStoreName (const char *value)
 
const Aws::StringGetKeyStorePassword () const
 
bool KeyStorePasswordHasBeenSet () const
 
void SetKeyStorePassword (const Aws::String &value)
 
void SetKeyStorePassword (Aws::String &&value)
 
void SetKeyStorePassword (const char *value)
 
UpdateCustomKeyStoreRequestWithKeyStorePassword (const Aws::String &value)
 
UpdateCustomKeyStoreRequestWithKeyStorePassword (Aws::String &&value)
 
UpdateCustomKeyStoreRequestWithKeyStorePassword (const char *value)
 
const Aws::StringGetCloudHsmClusterId () const
 
bool CloudHsmClusterIdHasBeenSet () const
 
void SetCloudHsmClusterId (const Aws::String &value)
 
void SetCloudHsmClusterId (Aws::String &&value)
 
void SetCloudHsmClusterId (const char *value)
 
UpdateCustomKeyStoreRequestWithCloudHsmClusterId (const Aws::String &value)
 
UpdateCustomKeyStoreRequestWithCloudHsmClusterId (Aws::String &&value)
 
UpdateCustomKeyStoreRequestWithCloudHsmClusterId (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 UpdateCustomKeyStoreRequest.h.

Constructor & Destructor Documentation

◆ UpdateCustomKeyStoreRequest()

Aws::KMS::Model::UpdateCustomKeyStoreRequest::UpdateCustomKeyStoreRequest ( )

Member Function Documentation

◆ CloudHsmClusterIdHasBeenSet()

bool Aws::KMS::Model::UpdateCustomKeyStoreRequest::CloudHsmClusterIdHasBeenSet ( ) const
inline

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Definition at line 244 of file UpdateCustomKeyStoreRequest.h.

◆ CustomKeyStoreIdHasBeenSet()

bool Aws::KMS::Model::UpdateCustomKeyStoreRequest::CustomKeyStoreIdHasBeenSet ( ) const
inline

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Definition at line 49 of file UpdateCustomKeyStoreRequest.h.

◆ GetCloudHsmClusterId()

const Aws::String& Aws::KMS::Model::UpdateCustomKeyStoreRequest::GetCloudHsmClusterId ( ) const
inline

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Definition at line 229 of file UpdateCustomKeyStoreRequest.h.

◆ GetCustomKeyStoreId()

const Aws::String& Aws::KMS::Model::UpdateCustomKeyStoreRequest::GetCustomKeyStoreId ( ) const
inline

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Definition at line 42 of file UpdateCustomKeyStoreRequest.h.

◆ GetKeyStorePassword()

const Aws::String& Aws::KMS::Model::UpdateCustomKeyStoreRequest::GetKeyStorePassword ( ) const
inline

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Definition at line 150 of file UpdateCustomKeyStoreRequest.h.

◆ GetNewCustomKeyStoreName()

const Aws::String& Aws::KMS::Model::UpdateCustomKeyStoreRequest::GetNewCustomKeyStoreName ( ) const
inline

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Definition at line 98 of file UpdateCustomKeyStoreRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file UpdateCustomKeyStoreRequest.h.

◆ KeyStorePasswordHasBeenSet()

bool Aws::KMS::Model::UpdateCustomKeyStoreRequest::KeyStorePasswordHasBeenSet ( ) const
inline

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Definition at line 159 of file UpdateCustomKeyStoreRequest.h.

◆ NewCustomKeyStoreNameHasBeenSet()

bool Aws::KMS::Model::UpdateCustomKeyStoreRequest::NewCustomKeyStoreNameHasBeenSet ( ) const
inline

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Definition at line 104 of file UpdateCustomKeyStoreRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCloudHsmClusterId() [1/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetCloudHsmClusterId ( const Aws::String value)
inline

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Definition at line 259 of file UpdateCustomKeyStoreRequest.h.

◆ SetCloudHsmClusterId() [2/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetCloudHsmClusterId ( Aws::String &&  value)
inline

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Definition at line 274 of file UpdateCustomKeyStoreRequest.h.

◆ SetCloudHsmClusterId() [3/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetCloudHsmClusterId ( const char *  value)
inline

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Definition at line 289 of file UpdateCustomKeyStoreRequest.h.

◆ SetCustomKeyStoreId() [1/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetCustomKeyStoreId ( const Aws::String value)
inline

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Definition at line 56 of file UpdateCustomKeyStoreRequest.h.

◆ SetCustomKeyStoreId() [2/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetCustomKeyStoreId ( Aws::String &&  value)
inline

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Definition at line 63 of file UpdateCustomKeyStoreRequest.h.

◆ SetCustomKeyStoreId() [3/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetCustomKeyStoreId ( const char *  value)
inline

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Definition at line 70 of file UpdateCustomKeyStoreRequest.h.

◆ SetKeyStorePassword() [1/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetKeyStorePassword ( const Aws::String value)
inline

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Definition at line 168 of file UpdateCustomKeyStoreRequest.h.

◆ SetKeyStorePassword() [2/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetKeyStorePassword ( Aws::String &&  value)
inline

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Definition at line 177 of file UpdateCustomKeyStoreRequest.h.

◆ SetKeyStorePassword() [3/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetKeyStorePassword ( const char *  value)
inline

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Definition at line 186 of file UpdateCustomKeyStoreRequest.h.

◆ SetNewCustomKeyStoreName() [1/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetNewCustomKeyStoreName ( const Aws::String value)
inline

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Definition at line 110 of file UpdateCustomKeyStoreRequest.h.

◆ SetNewCustomKeyStoreName() [2/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetNewCustomKeyStoreName ( Aws::String &&  value)
inline

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Definition at line 116 of file UpdateCustomKeyStoreRequest.h.

◆ SetNewCustomKeyStoreName() [3/3]

void Aws::KMS::Model::UpdateCustomKeyStoreRequest::SetNewCustomKeyStoreName ( const char *  value)
inline

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Definition at line 122 of file UpdateCustomKeyStoreRequest.h.

◆ WithCloudHsmClusterId() [1/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithCloudHsmClusterId ( const Aws::String value)
inline

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Definition at line 304 of file UpdateCustomKeyStoreRequest.h.

◆ WithCloudHsmClusterId() [2/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithCloudHsmClusterId ( Aws::String &&  value)
inline

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Definition at line 319 of file UpdateCustomKeyStoreRequest.h.

◆ WithCloudHsmClusterId() [3/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithCloudHsmClusterId ( const char *  value)
inline

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

Definition at line 334 of file UpdateCustomKeyStoreRequest.h.

◆ WithCustomKeyStoreId() [1/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithCustomKeyStoreId ( const Aws::String value)
inline

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Definition at line 77 of file UpdateCustomKeyStoreRequest.h.

◆ WithCustomKeyStoreId() [2/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithCustomKeyStoreId ( Aws::String &&  value)
inline

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Definition at line 84 of file UpdateCustomKeyStoreRequest.h.

◆ WithCustomKeyStoreId() [3/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithCustomKeyStoreId ( const char *  value)
inline

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Definition at line 91 of file UpdateCustomKeyStoreRequest.h.

◆ WithKeyStorePassword() [1/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithKeyStorePassword ( const Aws::String value)
inline

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Definition at line 195 of file UpdateCustomKeyStoreRequest.h.

◆ WithKeyStorePassword() [2/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithKeyStorePassword ( Aws::String &&  value)
inline

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Definition at line 204 of file UpdateCustomKeyStoreRequest.h.

◆ WithKeyStorePassword() [3/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithKeyStorePassword ( const char *  value)
inline

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

Definition at line 213 of file UpdateCustomKeyStoreRequest.h.

◆ WithNewCustomKeyStoreName() [1/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithNewCustomKeyStoreName ( const Aws::String value)
inline

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Definition at line 128 of file UpdateCustomKeyStoreRequest.h.

◆ WithNewCustomKeyStoreName() [2/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithNewCustomKeyStoreName ( Aws::String &&  value)
inline

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Definition at line 134 of file UpdateCustomKeyStoreRequest.h.

◆ WithNewCustomKeyStoreName() [3/3]

UpdateCustomKeyStoreRequest& Aws::KMS::Model::UpdateCustomKeyStoreRequest::WithNewCustomKeyStoreName ( const char *  value)
inline

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

Definition at line 140 of file UpdateCustomKeyStoreRequest.h.


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