Package software.amazon.awssdk.services.kms.model

Interface PutKeyPolicyRequest.Builder

All Superinterfaces:

CopyableBuilder<PutKeyPolicyRequest.Builder,PutKeyPolicyRequest>, SdkBuilder<PutKeyPolicyRequest.Builder,PutKeyPolicyRequest>

Enclosing class:

PutKeyPolicyRequest

public static interface PutKeyPolicyRequest.Builder
extends CopyableBuilder<PutKeyPolicyRequest.Builder,PutKeyPolicyRequest>

Method Summary

Modifier and Type	Method	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 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.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

keyId

PutKeyPolicyRequest.Builder keyId(String keyId)

A unique identifier for the CMK.

Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:

• Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Parameters:

keyId - A unique identifier for the CMK.

Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:

• Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Returns:

Returns a reference to this object so that method calls can be chained together.

policyName

PutKeyPolicyRequest.Builder policyName(String policyName)

The name of the key policy.

This value must be default.

Parameters:

policyName - The name of the key policy.

This value must be default.

Returns:

Returns a reference to this object so that method calls can be chained together.

policy

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 KiB (32768 bytes).

Parameters:

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 KiB (32768 bytes).

Returns:

Returns a reference to this object so that method calls can be chained together.

bypassPolicyLockoutSafetyCheck

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.