/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace KMS { namespace Model { /** */ class UpdateAliasRequest : public KMSRequest { public: AWS_KMS_API UpdateAliasRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "UpdateAlias"; } AWS_KMS_API Aws::String SerializePayload() const override; AWS_KMS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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

Do not include confidential or * sensitive information in this field. This field may be displayed in plaintext in * CloudTrail logs and other output.

*/ inline const Aws::String& GetAliasName() const{ return m_aliasName; } /** *

Do not include confidential or * sensitive information in this field. This field may be displayed in plaintext in * CloudTrail logs and other output.

*/ inline bool AliasNameHasBeenSet() const { return m_aliasNameHasBeenSet; } /** *

Do not include confidential or * sensitive information in this field. This field may be displayed in plaintext in * CloudTrail logs and other output.

*/ inline void SetAliasName(const Aws::String& value) { m_aliasNameHasBeenSet = true; m_aliasName = value; } /** *

Do not include confidential or * sensitive information in this field. This field may be displayed in plaintext in * CloudTrail logs and other output.

*/ inline void SetAliasName(Aws::String&& value) { m_aliasNameHasBeenSet = true; m_aliasName = std::move(value); } /** *

Do not include confidential or * sensitive information in this field. This field may be displayed in plaintext in * CloudTrail logs and other output.

*/ inline void SetAliasName(const char* value) { m_aliasNameHasBeenSet = true; m_aliasName.assign(value); } /** *

Do not include confidential or * sensitive information in this field. This field may be displayed in plaintext in * CloudTrail logs and other output.

*/ inline UpdateAliasRequest& WithAliasName(const Aws::String& value) { SetAliasName(value); return *this;} /** *

Do not include confidential or * sensitive information in this field. This field may be displayed in plaintext in * CloudTrail logs and other output.

*/ inline UpdateAliasRequest& WithAliasName(Aws::String&& value) { SetAliasName(std::move(value)); return *this;} /** *

Do not include confidential or * sensitive information in this field. This field may be displayed in plaintext in * CloudTrail logs and other output.

*/ inline UpdateAliasRequest& WithAliasName(const char* value) { SetAliasName(value); return *this;} /** *

Identifies the customer * managed key to associate with the alias. You don't have permission to * associate an alias with an Amazon * Web Services managed key.

The KMS key must be in the same Amazon Web * Services account and Region as the alias. Also, the new target KMS key must be * the same type as the current target KMS key (both symmetric or both asymmetric * or both HMAC) and they must have the same key usage.

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.

To verify that the alias is mapped * to the correct KMS key, use ListAliases.

*/ inline const Aws::String& GetTargetKeyId() const{ return m_targetKeyId; } /** *

Identifies the customer * managed key to associate with the alias. You don't have permission to * associate an alias with an Amazon * Web Services managed key.

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.

To verify that the alias is mapped * to the correct KMS key, use ListAliases.

*/ inline bool TargetKeyIdHasBeenSet() const { return m_targetKeyIdHasBeenSet; } /** *

Identifies the customer * managed key to associate with the alias. You don't have permission to * associate an alias with an Amazon * Web Services managed key.

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.

To verify that the alias is mapped * to the correct KMS key, use ListAliases.

*/ inline void SetTargetKeyId(const Aws::String& value) { m_targetKeyIdHasBeenSet = true; m_targetKeyId = value; } /** *

Identifies the customer * managed key to associate with the alias. You don't have permission to * associate an alias with an Amazon * Web Services managed key.

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.

To verify that the alias is mapped * to the correct KMS key, use ListAliases.

*/ inline void SetTargetKeyId(Aws::String&& value) { m_targetKeyIdHasBeenSet = true; m_targetKeyId = std::move(value); } /** *

Identifies the customer * managed key to associate with the alias. You don't have permission to * associate an alias with an Amazon * Web Services managed key.

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.

To verify that the alias is mapped * to the correct KMS key, use ListAliases.

*/ inline void SetTargetKeyId(const char* value) { m_targetKeyIdHasBeenSet = true; m_targetKeyId.assign(value); } /** *

Identifies the customer * managed key to associate with the alias. You don't have permission to * associate an alias with an Amazon * Web Services managed key.

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.

To verify that the alias is mapped * to the correct KMS key, use ListAliases.

*/ inline UpdateAliasRequest& WithTargetKeyId(const Aws::String& value) { SetTargetKeyId(value); return *this;} /** *

Identifies the customer * managed key to associate with the alias. You don't have permission to * associate an alias with an Amazon * Web Services managed key.

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.

To verify that the alias is mapped * to the correct KMS key, use ListAliases.

*/ inline UpdateAliasRequest& WithTargetKeyId(Aws::String&& value) { SetTargetKeyId(std::move(value)); return *this;} /** *

Identifies the customer * managed key to associate with the alias. You don't have permission to * associate an alias with an Amazon * Web Services managed key.

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.

To verify that the alias is mapped * to the correct KMS key, use ListAliases.

*/ inline UpdateAliasRequest& WithTargetKeyId(const char* value) { SetTargetKeyId(value); return *this;} private: Aws::String m_aliasName; bool m_aliasNameHasBeenSet = false; Aws::String m_targetKeyId; bool m_targetKeyIdHasBeenSet = false; }; } // namespace Model } // namespace KMS } // namespace Aws