public static interface PutKeyPolicyRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<PutKeyPolicyRequest.Builder,PutKeyPolicyRequest>
| Modifier and Type | Method and Description |
|---|---|
PutKeyPolicyRequest.Builder |
bypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
|
PutKeyPolicyRequest.Builder |
keyId(String keyId)
Sets the key policy on the specified KMS key.
|
PutKeyPolicyRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PutKeyPolicyRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PutKeyPolicyRequest.Builder |
policy(String policy)
The key policy to attach to the KMS key.
|
PutKeyPolicyRequest.Builder |
policyName(String policyName)
The name of the key policy.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildPutKeyPolicyRequest.Builder keyId(String keyId)
Sets the key policy on 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.
keyId - Sets the key policy on 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.
PutKeyPolicyRequest.Builder policyName(String policyName)
The name of the key policy. The only valid value is default.
policyName - The name of the key policy. The only valid value is default.PutKeyPolicyRequest.Builder policy(String policy)
The key policy to attach to the KMS key.
The key policy must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal
that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request
on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to
the scenario in the Default Key Policy section of the Key Management Service Developer Guide.
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services 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 KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
A key policy document can include only the following characters:
Printable ASCII characters from the space character ( ) through the end of the ASCII
character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ).
The tab ( ), line feed (
), and carriage return (
)
special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
policy - The key policy to attach to the KMS key.
The key policy must meet the following criteria:
If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the
principal that is making the PutKeyPolicy request to make a subsequent
PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes
unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide.
Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services 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 KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.
A key policy document can include only the following characters:
Printable ASCII characters from the space character ( ) through the end of the ASCII
character range.
Printable characters in the Basic Latin and Latin-1 Supplement character set (through
ÿ).
The tab ( ), line feed (
), and carriage return (
) special characters
For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .
PutKeyPolicyRequest.Builder bypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from making a
subsequent PutKeyPolicy request on the KMS key.
The default value is false.
bypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
Use this parameter only when you intend to prevent the principal that is making the request from
making a subsequent PutKeyPolicy request on the KMS key.
The default value is false.
PutKeyPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderPutKeyPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.