150 lines
7.7 KiB
C++
150 lines
7.7 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/kms/KMS_EXPORTS.h>
|
|
#include <aws/kms/KMSRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace KMS
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_KMS_API EnableKeyRotationRequest : public KMSRequest
|
|
{
|
|
public:
|
|
EnableKeyRotationRequest();
|
|
|
|
// 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 "EnableKeyRotation"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
|
|
|
|
|
/**
|
|
* <p>Identifies a symmetric customer master key (CMK). You cannot enable automatic
|
|
* rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom
|
|
* key store</a>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of
|
|
* the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline const Aws::String& GetKeyId() const{ return m_keyId; }
|
|
|
|
/**
|
|
* <p>Identifies a symmetric customer master key (CMK). You cannot enable automatic
|
|
* rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom
|
|
* key store</a>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of
|
|
* the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Identifies a symmetric customer master key (CMK). You cannot enable automatic
|
|
* rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom
|
|
* key store</a>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of
|
|
* the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; }
|
|
|
|
/**
|
|
* <p>Identifies a symmetric customer master key (CMK). You cannot enable automatic
|
|
* rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom
|
|
* key store</a>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of
|
|
* the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); }
|
|
|
|
/**
|
|
* <p>Identifies a symmetric customer master key (CMK). You cannot enable automatic
|
|
* rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom
|
|
* key store</a>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of
|
|
* the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); }
|
|
|
|
/**
|
|
* <p>Identifies a symmetric customer master key (CMK). You cannot enable automatic
|
|
* rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom
|
|
* key store</a>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of
|
|
* the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline EnableKeyRotationRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;}
|
|
|
|
/**
|
|
* <p>Identifies a symmetric customer master key (CMK). You cannot enable automatic
|
|
* rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom
|
|
* key store</a>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of
|
|
* the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline EnableKeyRotationRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Identifies a symmetric customer master key (CMK). You cannot enable automatic
|
|
* rotation of asymmetric CMKs, CMKs with imported key material, or CMKs in a <a
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html">custom
|
|
* key store</a>.</p> <p>Specify the key ID or the Amazon Resource Name (ARN) of
|
|
* the CMK.</p> <p>For example:</p> <ul> <li> <p>Key ID:
|
|
* <code>1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> <li> <p>Key ARN:
|
|
* <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>
|
|
* </p> </li> </ul> <p>To get the key ID and key ARN for a CMK, use <a>ListKeys</a>
|
|
* or <a>DescribeKey</a>.</p>
|
|
*/
|
|
inline EnableKeyRotationRequest& WithKeyId(const char* value) { SetKeyId(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_keyId;
|
|
bool m_keyIdHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace KMS
|
|
} // namespace Aws
|