Class PutKeyPolicyRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
A flag to indicate whether to bypass the key policy lockout safety check.getKeyId()
A unique identifier for the CMK.The key policy to attach to the CMK.The name of the key policy.int
hashCode()
A flag to indicate whether to bypass the key policy lockout safety check.void
setBypassPolicyLockoutSafetyCheck
(Boolean bypassPolicyLockoutSafetyCheck) A flag to indicate whether to bypass the key policy lockout safety check.void
A unique identifier for the CMK.void
The key policy to attach to the CMK.void
setPolicyName
(String policyName) The name of the key policy.toString()
Returns a string representation of this object; useful for testing and debugging.withBypassPolicyLockoutSafetyCheck
(Boolean bypassPolicyLockoutSafetyCheck) A flag to indicate whether to bypass the key policy lockout safety check.A unique identifier for the CMK.withPolicy
(String policy) The key policy to attach to the CMK.withPolicyName
(String policyName) The name of the key policy.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
PutKeyPolicyRequest
public PutKeyPolicyRequest()
-
-
Method Details
-
setKeyId
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-west-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-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab
-
-
-
getKeyId
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-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab
- Returns:
- 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-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab
-
-
-
withKeyId
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-west-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-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setPolicyName
The name of the key policy.
This value must be
default
.- Parameters:
policyName
- The name of the key policy.This value must be
default
.
-
getPolicyName
The name of the key policy.
This value must be
default
.- Returns:
- The name of the key policy.
This value must be
default
.
-
withPolicyName
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.
-
setPolicy
The key policy to attach to the CMK.
The key policy must meet the following criteria:
-
It must allow the principal making the
PutKeyPolicy
request to make a subsequentPutKeyPolicy
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 principal(s) 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.The key policy must meet the following criteria:
-
It must allow the principal making the
PutKeyPolicy
request to make a subsequentPutKeyPolicy
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 principal(s) 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).
-
-
-
getPolicy
The key policy to attach to the CMK.
The key policy must meet the following criteria:
-
It must allow the principal making the
PutKeyPolicy
request to make a subsequentPutKeyPolicy
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 principal(s) 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:
- The key policy to attach to the CMK.
The key policy must meet the following criteria:
-
It must allow the principal making the
PutKeyPolicy
request to make a subsequentPutKeyPolicy
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 principal(s) 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).
-
-
-
withPolicy
The key policy to attach to the CMK.
The key policy must meet the following criteria:
-
It must allow the principal making the
PutKeyPolicy
request to make a subsequentPutKeyPolicy
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 principal(s) 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.The key policy must meet the following criteria:
-
It must allow the principal making the
PutKeyPolicy
request to make a subsequentPutKeyPolicy
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 principal(s) 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.
-
-
setBypassPolicyLockoutSafetyCheck
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 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 making the request from making a subsequent
PutKeyPolicy
request on the CMK.The default value is false.
-
getBypassPolicyLockoutSafetyCheck
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 making the request from making a subsequent
PutKeyPolicy
request on the CMK.The default value is false.
- Returns:
- 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 making the request from making a subsequent
PutKeyPolicy
request on the CMK.The default value is false.
-
withBypassPolicyLockoutSafetyCheck
public PutKeyPolicyRequest withBypassPolicyLockoutSafetyCheck(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 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 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.
-
isBypassPolicyLockoutSafetyCheck
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 making the request from making a subsequent
PutKeyPolicy
request on the CMK.The default value is false.
- Returns:
- 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 making the request from making a subsequent
PutKeyPolicy
request on the CMK.The default value is false.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-