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

#include <CreateAliasRequest.h>

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

Public Member Functions

 CreateAliasRequest ()
 
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)
 
CreateAliasRequestWithAliasName (const Aws::String &value)
 
CreateAliasRequestWithAliasName (Aws::String &&value)
 
CreateAliasRequestWithAliasName (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)
 
CreateAliasRequestWithTargetKeyId (const Aws::String &value)
 
CreateAliasRequestWithTargetKeyId (Aws::String &&value)
 
CreateAliasRequestWithTargetKeyId (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 CreateAliasRequest.h.

Constructor & Destructor Documentation

◆ CreateAliasRequest()

Aws::KMS::Model::CreateAliasRequest::CreateAliasRequest ( )

Member Function Documentation

◆ AliasNameHasBeenSet()

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

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

Definition at line 59 of file CreateAliasRequest.h.

◆ GetAliasName()

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

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

Definition at line 47 of file CreateAliasRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::KMS::KMSRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file CreateAliasRequest.h.

◆ GetTargetKeyId()

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

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

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 150 of file CreateAliasRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAliasName() [1/3]

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

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

Definition at line 83 of file CreateAliasRequest.h.

◆ SetAliasName() [2/3]

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

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

Definition at line 71 of file CreateAliasRequest.h.

◆ SetAliasName() [3/3]

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

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

Definition at line 95 of file CreateAliasRequest.h.

◆ SetTargetKeyId() [1/3]

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

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

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 204 of file CreateAliasRequest.h.

◆ SetTargetKeyId() [2/3]

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

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

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 186 of file CreateAliasRequest.h.

◆ SetTargetKeyId() [3/3]

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

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

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 222 of file CreateAliasRequest.h.

◆ TargetKeyIdHasBeenSet()

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

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

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 168 of file CreateAliasRequest.h.

◆ WithAliasName() [1/3]

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

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

Definition at line 119 of file CreateAliasRequest.h.

◆ WithAliasName() [2/3]

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

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

Definition at line 107 of file CreateAliasRequest.h.

◆ WithAliasName() [3/3]

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

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

Definition at line 131 of file CreateAliasRequest.h.

◆ WithTargetKeyId() [1/3]

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

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

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 258 of file CreateAliasRequest.h.

◆ WithTargetKeyId() [2/3]

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

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

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 240 of file CreateAliasRequest.h.

◆ WithTargetKeyId() [3/3]

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

Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

For help finding the key ID and ARN, see Finding the Key ID and ARN in the Key Management Service Developer Guide .

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 276 of file CreateAliasRequest.h.


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