public static interface PutKeyPolicyRequest.Builder extends KMSRequest.Builder, 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)
A unique identifier for the customer master key (CMK).
|
PutKeyPolicyRequest.Builder |
policy(String policy)
The key policy to attach to the CMK.
|
PutKeyPolicyRequest.Builder |
policyName(String policyName)
The name of the key policy.
|
PutKeyPolicyRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
PutKeyPolicyRequest.Builder keyId(String keyId)
A unique identifier for the customer master key (CMK).
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.
keyId
- A unique identifier for the customer master key (CMK).
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.
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 CMK.
If you do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the following
criteria:
It must allow the principal that is making the PutKeyPolicy
request to make a subsequent
PutKeyPolicy
request on the CMK. This reduces the likelihood that the CMK becomes unmanageable.
For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
The principals that are specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
The policy size limit is 32 kilobytes (32768 bytes).
policy
- The key policy to attach to the CMK.
If you do not set BypassPolicyLockoutSafetyCheck
to true, the policy must meet the
following criteria:
It must allow the principal that is making the PutKeyPolicy
request to make a subsequent
PutKeyPolicy
request on the CMK. This reduces the likelihood that the CMK becomes
unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.
The principals that are specified 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 specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.
The policy size limit is 32 kilobytes (32768 bytes).
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 likelihood that the CMK 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 AWS 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 CMK.
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 likelihood that the CMK 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 AWS 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 CMK.
The default value is false.
PutKeyPolicyRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.