442 lines
26 KiB
C
442 lines
26 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 PutKeyPolicyRequest : public KMSRequest
|
|||
|
|
{
|
|||
|
|
public:
|
|||
|
|
PutKeyPolicyRequest();
|
|||
|
|
|
|||
|
|
// 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 "PutKeyPolicy"; }
|
|||
|
|
|
|||
|
|
Aws::String SerializePayload() const override;
|
|||
|
|
|
|||
|
|
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A unique identifier for the customer master key (CMK).</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>A unique identifier for the customer master key (CMK).</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>A unique identifier for the customer master key (CMK).</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>A unique identifier for the customer master key (CMK).</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>A unique identifier for the customer master key (CMK).</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>A unique identifier for the customer master key (CMK).</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 PutKeyPolicyRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A unique identifier for the customer master key (CMK).</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 PutKeyPolicyRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A unique identifier for the customer master key (CMK).</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 PutKeyPolicyRequest& WithKeyId(const char* value) { SetKeyId(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the key policy. The only valid value is <code>default</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetPolicyName() const{ return m_policyName; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the key policy. The only valid value is <code>default</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool PolicyNameHasBeenSet() const { return m_policyNameHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the key policy. The only valid value is <code>default</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetPolicyName(const Aws::String& value) { m_policyNameHasBeenSet = true; m_policyName = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the key policy. The only valid value is <code>default</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetPolicyName(Aws::String&& value) { m_policyNameHasBeenSet = true; m_policyName = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the key policy. The only valid value is <code>default</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetPolicyName(const char* value) { m_policyNameHasBeenSet = true; m_policyName.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the key policy. The only valid value is <code>default</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline PutKeyPolicyRequest& WithPolicyName(const Aws::String& value) { SetPolicyName(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the key policy. The only valid value is <code>default</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline PutKeyPolicyRequest& WithPolicyName(Aws::String&& value) { SetPolicyName(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The name of the key policy. The only valid value is <code>default</code>.</p>
|
|||
|
|
*/
|
|||
|
|
inline PutKeyPolicyRequest& WithPolicyName(const char* value) { SetPolicyName(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The key policy to attach to the CMK.</p> <p>The key policy must meet the
|
|||
|
|
* following criteria:</p> <ul> <li> <p>If you don't set
|
|||
|
|
* <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow
|
|||
|
|
* the principal that is making the <code>PutKeyPolicy</code> request to make a
|
|||
|
|
* subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk
|
|||
|
|
* that the CMK becomes unmanageable. For more information, refer to the scenario
|
|||
|
|
* in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section of the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one
|
|||
|
|
* or more principals. The principals in the key policy must exist and be visible
|
|||
|
|
* to AWS KMS. When you create a new AWS principal (for example, an IAM user or
|
|||
|
|
* role), you might need to enforce a delay before including the new principal in a
|
|||
|
|
* key policy because the new principal might not be immediately visible to AWS
|
|||
|
|
* KMS. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes
|
|||
|
|
* that I make are not always immediately visible</a> in the <i>AWS Identity and
|
|||
|
|
* Access Management User Guide</i>.</p> </li> </ul> <p>The key policy cannot
|
|||
|
|
* exceed 32 kilobytes (32768 bytes). For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource
|
|||
|
|
* Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline const Aws::String& GetPolicy() const{ return m_policy; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The key policy to attach to the CMK.</p> <p>The key policy must meet the
|
|||
|
|
* following criteria:</p> <ul> <li> <p>If you don't set
|
|||
|
|
* <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow
|
|||
|
|
* the principal that is making the <code>PutKeyPolicy</code> request to make a
|
|||
|
|
* subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk
|
|||
|
|
* that the CMK becomes unmanageable. For more information, refer to the scenario
|
|||
|
|
* in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section of the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one
|
|||
|
|
* or more principals. The principals in the key policy must exist and be visible
|
|||
|
|
* to AWS KMS. When you create a new AWS principal (for example, an IAM user or
|
|||
|
|
* role), you might need to enforce a delay before including the new principal in a
|
|||
|
|
* key policy because the new principal might not be immediately visible to AWS
|
|||
|
|
* KMS. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes
|
|||
|
|
* that I make are not always immediately visible</a> in the <i>AWS Identity and
|
|||
|
|
* Access Management User Guide</i>.</p> </li> </ul> <p>The key policy cannot
|
|||
|
|
* exceed 32 kilobytes (32768 bytes). For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource
|
|||
|
|
* Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool PolicyHasBeenSet() const { return m_policyHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The key policy to attach to the CMK.</p> <p>The key policy must meet the
|
|||
|
|
* following criteria:</p> <ul> <li> <p>If you don't set
|
|||
|
|
* <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow
|
|||
|
|
* the principal that is making the <code>PutKeyPolicy</code> request to make a
|
|||
|
|
* subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk
|
|||
|
|
* that the CMK becomes unmanageable. For more information, refer to the scenario
|
|||
|
|
* in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section of the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one
|
|||
|
|
* or more principals. The principals in the key policy must exist and be visible
|
|||
|
|
* to AWS KMS. When you create a new AWS principal (for example, an IAM user or
|
|||
|
|
* role), you might need to enforce a delay before including the new principal in a
|
|||
|
|
* key policy because the new principal might not be immediately visible to AWS
|
|||
|
|
* KMS. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes
|
|||
|
|
* that I make are not always immediately visible</a> in the <i>AWS Identity and
|
|||
|
|
* Access Management User Guide</i>.</p> </li> </ul> <p>The key policy cannot
|
|||
|
|
* exceed 32 kilobytes (32768 bytes). For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource
|
|||
|
|
* Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetPolicy(const Aws::String& value) { m_policyHasBeenSet = true; m_policy = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The key policy to attach to the CMK.</p> <p>The key policy must meet the
|
|||
|
|
* following criteria:</p> <ul> <li> <p>If you don't set
|
|||
|
|
* <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow
|
|||
|
|
* the principal that is making the <code>PutKeyPolicy</code> request to make a
|
|||
|
|
* subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk
|
|||
|
|
* that the CMK becomes unmanageable. For more information, refer to the scenario
|
|||
|
|
* in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section of the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one
|
|||
|
|
* or more principals. The principals in the key policy must exist and be visible
|
|||
|
|
* to AWS KMS. When you create a new AWS principal (for example, an IAM user or
|
|||
|
|
* role), you might need to enforce a delay before including the new principal in a
|
|||
|
|
* key policy because the new principal might not be immediately visible to AWS
|
|||
|
|
* KMS. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes
|
|||
|
|
* that I make are not always immediately visible</a> in the <i>AWS Identity and
|
|||
|
|
* Access Management User Guide</i>.</p> </li> </ul> <p>The key policy cannot
|
|||
|
|
* exceed 32 kilobytes (32768 bytes). For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource
|
|||
|
|
* Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetPolicy(Aws::String&& value) { m_policyHasBeenSet = true; m_policy = std::move(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The key policy to attach to the CMK.</p> <p>The key policy must meet the
|
|||
|
|
* following criteria:</p> <ul> <li> <p>If you don't set
|
|||
|
|
* <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow
|
|||
|
|
* the principal that is making the <code>PutKeyPolicy</code> request to make a
|
|||
|
|
* subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk
|
|||
|
|
* that the CMK becomes unmanageable. For more information, refer to the scenario
|
|||
|
|
* in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section of the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one
|
|||
|
|
* or more principals. The principals in the key policy must exist and be visible
|
|||
|
|
* to AWS KMS. When you create a new AWS principal (for example, an IAM user or
|
|||
|
|
* role), you might need to enforce a delay before including the new principal in a
|
|||
|
|
* key policy because the new principal might not be immediately visible to AWS
|
|||
|
|
* KMS. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes
|
|||
|
|
* that I make are not always immediately visible</a> in the <i>AWS Identity and
|
|||
|
|
* Access Management User Guide</i>.</p> </li> </ul> <p>The key policy cannot
|
|||
|
|
* exceed 32 kilobytes (32768 bytes). For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource
|
|||
|
|
* Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetPolicy(const char* value) { m_policyHasBeenSet = true; m_policy.assign(value); }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The key policy to attach to the CMK.</p> <p>The key policy must meet the
|
|||
|
|
* following criteria:</p> <ul> <li> <p>If you don't set
|
|||
|
|
* <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow
|
|||
|
|
* the principal that is making the <code>PutKeyPolicy</code> request to make a
|
|||
|
|
* subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk
|
|||
|
|
* that the CMK becomes unmanageable. For more information, refer to the scenario
|
|||
|
|
* in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section of the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one
|
|||
|
|
* or more principals. The principals in the key policy must exist and be visible
|
|||
|
|
* to AWS KMS. When you create a new AWS principal (for example, an IAM user or
|
|||
|
|
* role), you might need to enforce a delay before including the new principal in a
|
|||
|
|
* key policy because the new principal might not be immediately visible to AWS
|
|||
|
|
* KMS. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes
|
|||
|
|
* that I make are not always immediately visible</a> in the <i>AWS Identity and
|
|||
|
|
* Access Management User Guide</i>.</p> </li> </ul> <p>The key policy cannot
|
|||
|
|
* exceed 32 kilobytes (32768 bytes). For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource
|
|||
|
|
* Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline PutKeyPolicyRequest& WithPolicy(const Aws::String& value) { SetPolicy(value); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The key policy to attach to the CMK.</p> <p>The key policy must meet the
|
|||
|
|
* following criteria:</p> <ul> <li> <p>If you don't set
|
|||
|
|
* <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow
|
|||
|
|
* the principal that is making the <code>PutKeyPolicy</code> request to make a
|
|||
|
|
* subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk
|
|||
|
|
* that the CMK becomes unmanageable. For more information, refer to the scenario
|
|||
|
|
* in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section of the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one
|
|||
|
|
* or more principals. The principals in the key policy must exist and be visible
|
|||
|
|
* to AWS KMS. When you create a new AWS principal (for example, an IAM user or
|
|||
|
|
* role), you might need to enforce a delay before including the new principal in a
|
|||
|
|
* key policy because the new principal might not be immediately visible to AWS
|
|||
|
|
* KMS. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes
|
|||
|
|
* that I make are not always immediately visible</a> in the <i>AWS Identity and
|
|||
|
|
* Access Management User Guide</i>.</p> </li> </ul> <p>The key policy cannot
|
|||
|
|
* exceed 32 kilobytes (32768 bytes). For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource
|
|||
|
|
* Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline PutKeyPolicyRequest& WithPolicy(Aws::String&& value) { SetPolicy(std::move(value)); return *this;}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>The key policy to attach to the CMK.</p> <p>The key policy must meet the
|
|||
|
|
* following criteria:</p> <ul> <li> <p>If you don't set
|
|||
|
|
* <code>BypassPolicyLockoutSafetyCheck</code> to true, the key policy must allow
|
|||
|
|
* the principal that is making the <code>PutKeyPolicy</code> request to make a
|
|||
|
|
* subsequent <code>PutKeyPolicy</code> request on the CMK. This reduces the risk
|
|||
|
|
* that the CMK becomes unmanageable. For more information, refer to the scenario
|
|||
|
|
* in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section of the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> </li> <li> <p>Each statement in the key policy must contain one
|
|||
|
|
* or more principals. The principals in the key policy must exist and be visible
|
|||
|
|
* to AWS KMS. When you create a new AWS principal (for example, an IAM user or
|
|||
|
|
* role), you might need to enforce a delay before including the new principal in a
|
|||
|
|
* key policy because the new principal might not be immediately visible to AWS
|
|||
|
|
* KMS. For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency">Changes
|
|||
|
|
* that I make are not always immediately visible</a> in the <i>AWS Identity and
|
|||
|
|
* Access Management User Guide</i>.</p> </li> </ul> <p>The key policy cannot
|
|||
|
|
* exceed 32 kilobytes (32768 bytes). For more information, see <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html">Resource
|
|||
|
|
* Quotas</a> in the <i>AWS Key Management Service Developer Guide</i>.</p>
|
|||
|
|
*/
|
|||
|
|
inline PutKeyPolicyRequest& WithPolicy(const char* value) { SetPolicy(value); return *this;}
|
|||
|
|
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A flag to indicate whether to bypass the key policy lockout safety check.</p>
|
|||
|
|
* <p>Setting this value to true increases the risk that the CMK
|
|||
|
|
* becomes unmanageable. Do not set this value to true indiscriminately.</p> <p>For
|
|||
|
|
* more information, refer to the scenario in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section in the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> <p>Use this parameter only when you intend to
|
|||
|
|
* prevent the principal that is making the request from making a subsequent
|
|||
|
|
* <code>PutKeyPolicy</code> request on the CMK.</p> <p>The default value is
|
|||
|
|
* false.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool GetBypassPolicyLockoutSafetyCheck() const{ return m_bypassPolicyLockoutSafetyCheck; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A flag to indicate whether to bypass the key policy lockout safety check.</p>
|
|||
|
|
* <p>Setting this value to true increases the risk that the CMK
|
|||
|
|
* becomes unmanageable. Do not set this value to true indiscriminately.</p> <p>For
|
|||
|
|
* more information, refer to the scenario in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section in the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> <p>Use this parameter only when you intend to
|
|||
|
|
* prevent the principal that is making the request from making a subsequent
|
|||
|
|
* <code>PutKeyPolicy</code> request on the CMK.</p> <p>The default value is
|
|||
|
|
* false.</p>
|
|||
|
|
*/
|
|||
|
|
inline bool BypassPolicyLockoutSafetyCheckHasBeenSet() const { return m_bypassPolicyLockoutSafetyCheckHasBeenSet; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A flag to indicate whether to bypass the key policy lockout safety check.</p>
|
|||
|
|
* <p>Setting this value to true increases the risk that the CMK
|
|||
|
|
* becomes unmanageable. Do not set this value to true indiscriminately.</p> <p>For
|
|||
|
|
* more information, refer to the scenario in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section in the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> <p>Use this parameter only when you intend to
|
|||
|
|
* prevent the principal that is making the request from making a subsequent
|
|||
|
|
* <code>PutKeyPolicy</code> request on the CMK.</p> <p>The default value is
|
|||
|
|
* false.</p>
|
|||
|
|
*/
|
|||
|
|
inline void SetBypassPolicyLockoutSafetyCheck(bool value) { m_bypassPolicyLockoutSafetyCheckHasBeenSet = true; m_bypassPolicyLockoutSafetyCheck = value; }
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* <p>A flag to indicate whether to bypass the key policy lockout safety check.</p>
|
|||
|
|
* <p>Setting this value to true increases the risk that the CMK
|
|||
|
|
* becomes unmanageable. Do not set this value to true indiscriminately.</p> <p>For
|
|||
|
|
* more information, refer to the scenario in the <a
|
|||
|
|
* href="https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam">Default
|
|||
|
|
* Key Policy</a> section in the <i>AWS Key Management Service Developer
|
|||
|
|
* Guide</i>.</p> <p>Use this parameter only when you intend to
|
|||
|
|
* prevent the principal that is making the request from making a subsequent
|
|||
|
|
* <code>PutKeyPolicy</code> request on the CMK.</p> <p>The default value is
|
|||
|
|
* false.</p>
|
|||
|
|
*/
|
|||
|
|
inline PutKeyPolicyRequest& WithBypassPolicyLockoutSafetyCheck(bool value) { SetBypassPolicyLockoutSafetyCheck(value); return *this;}
|
|||
|
|
|
|||
|
|
private:
|
|||
|
|
|
|||
|
|
Aws::String m_keyId;
|
|||
|
|
bool m_keyIdHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::String m_policyName;
|
|||
|
|
bool m_policyNameHasBeenSet;
|
|||
|
|
|
|||
|
|
Aws::String m_policy;
|
|||
|
|
bool m_policyHasBeenSet;
|
|||
|
|
|
|||
|
|
bool m_bypassPolicyLockoutSafetyCheck;
|
|||
|
|
bool m_bypassPolicyLockoutSafetyCheckHasBeenSet;
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
} // namespace Model
|
|||
|
|
} // namespace KMS
|
|||
|
|
} // namespace Aws
|