@Generated(value="software.amazon.awssdk:codegen") public final class PutKeyPolicyRequest extends KmsRequest implements ToCopyableBuilder<PutKeyPolicyRequest.Builder,PutKeyPolicyRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutKeyPolicyRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static PutKeyPolicyRequest.Builder |
builder() |
Boolean |
bypassPolicyLockoutSafetyCheck()
A flag to indicate whether to bypass the key policy lockout safety check.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
keyId()
Sets the key policy on the specified KMS key.
|
String |
policy()
The key policy to attach to the KMS key.
|
String |
policyName()
The name of the key policy.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutKeyPolicyRequest.Builder> |
serializableBuilderClass() |
PutKeyPolicyRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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.
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.
public final String policyName()
The name of the key policy. The only valid value is default
.
default
.public final 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.
The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the Key Management Service Developer Guide.
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.
The key policy cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the Key Management Service Developer Guide.
public final 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.
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.
public PutKeyPolicyRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<PutKeyPolicyRequest.Builder,PutKeyPolicyRequest>
toBuilder
in class KmsRequest
public static PutKeyPolicyRequest.Builder builder()
public static Class<? extends PutKeyPolicyRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.