@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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
String |
keyId()
A unique identifier for the customer master key (CMK).
|
String |
policy()
The key policy to attach to the CMK.
|
String |
policyName()
The name of the key policy.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutKeyPolicyRequest.Builder> |
serializableBuilderClass() |
PutKeyPolicyRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfigurationcopypublic 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.
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.
public String policyName()
The name of the key policy. The only valid value is default.
default.public String policy()
The key policy to attach to the CMK.
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 CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in
the Default Key Policy section of the AWS 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 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 Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
The key policy size limit is 32 kilobytes (32768 bytes).
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 CMK. This reduces the risk that the CMK becomes unmanageable.
For more information, refer to the scenario in the Default Key Policy section of the AWS 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 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 Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.
The key policy size limit is 32 kilobytes (32768 bytes).
public 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 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.
Setting this value to true increases the risk 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.
public PutKeyPolicyRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<PutKeyPolicyRequest.Builder,PutKeyPolicyRequest>toBuilder in class KmsRequestpublic static PutKeyPolicyRequest.Builder builder()
public static Class<? extends PutKeyPolicyRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.