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

Updates the description of the specified KMS 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.

*/ inline const Aws::String& GetKeyId() const{ return m_keyId; } /** *

Updates the description of the specified KMS 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.

*/ inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; } /** *

Updates the description of the specified KMS 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.

*/ inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; } /** *

Updates the description of the specified KMS 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.

*/ inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); } /** *

Updates the description of the specified KMS 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.

*/ inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); } /** *

Updates the description of the specified KMS 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.

*/ inline UpdateKeyDescriptionRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;} /** *

Updates the description of the specified KMS 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.

*/ inline UpdateKeyDescriptionRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;} /** *

Updates the description of the specified KMS 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.

*/ inline UpdateKeyDescriptionRequest& WithKeyId(const char* value) { SetKeyId(value); return *this;} /** *

New description for the KMS key.

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& GetDescription() const{ return m_description; } /** *

New description for the KMS key.

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 DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; } /** *

New description for the KMS key.

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 SetDescription(const Aws::String& value) { m_descriptionHasBeenSet = true; m_description = value; } /** *

New description for the KMS key.

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 SetDescription(Aws::String&& value) { m_descriptionHasBeenSet = true; m_description = std::move(value); } /** *

New description for the KMS key.

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 SetDescription(const char* value) { m_descriptionHasBeenSet = true; m_description.assign(value); } /** *

New description for the KMS key.

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

*/ inline UpdateKeyDescriptionRequest& WithDescription(const Aws::String& value) { SetDescription(value); return *this;} /** *

New description for the KMS key.

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

*/ inline UpdateKeyDescriptionRequest& WithDescription(Aws::String&& value) { SetDescription(std::move(value)); return *this;} /** *

New description for the KMS key.

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

*/ inline UpdateKeyDescriptionRequest& WithDescription(const char* value) { SetDescription(value); return *this;} private: Aws::String m_keyId; bool m_keyIdHasBeenSet = false; Aws::String m_description; bool m_descriptionHasBeenSet = false; }; } // namespace Model } // namespace KMS } // namespace Aws