/** * 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 AWS_KMS_API UpdateAliasRequest : public KMSRequest { public: 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::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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