public class PutKeyPolicyRequest extends AmazonWebServiceRequest implements java.io.Serializable
Attaches a key policy to the specified customer master key (CMK).
For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.
Constructor and Description |
---|
PutKeyPolicyRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.Boolean |
getBypassPolicyLockoutSafetyCheck()
A flag to indicate whether to bypass the key policy lockout safety check.
|
java.lang.String |
getKeyId()
A unique identifier for the CMK.
|
java.lang.String |
getPolicy()
The key policy to attach to the CMK.
|
java.lang.String |
getPolicyName()
The name of the key policy.
|
int |
hashCode() |
java.lang.Boolean |
isBypassPolicyLockoutSafetyCheck()
A flag to indicate whether to bypass the key policy lockout safety check.
|
void |
setBypassPolicyLockoutSafetyCheck(java.lang.Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
|
void |
setKeyId(java.lang.String keyId)
A unique identifier for the CMK.
|
void |
setPolicy(java.lang.String policy)
The key policy to attach to the CMK.
|
void |
setPolicyName(java.lang.String policyName)
The name of the key policy.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PutKeyPolicyRequest |
withBypassPolicyLockoutSafetyCheck(java.lang.Boolean bypassPolicyLockoutSafetyCheck)
A flag to indicate whether to bypass the key policy lockout safety check.
|
PutKeyPolicyRequest |
withKeyId(java.lang.String keyId)
A unique identifier for the CMK.
|
PutKeyPolicyRequest |
withPolicy(java.lang.String policy)
The key policy to attach to the CMK.
|
PutKeyPolicyRequest |
withPolicyName(java.lang.String policyName)
The name of the key policy.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.lang.String 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-east-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab
Constraints:
Length: 1 - 256
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
public void setKeyId(java.lang.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
Constraints:
Length: 1 - 256
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
public PutKeyPolicyRequest withKeyId(java.lang.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
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
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
public java.lang.String getPolicyName()
The name of the key policy.
This value must be default
.
Constraints:
Length: 1 - 128
Pattern: [\w]+
The name of the key policy.
This value must be default
.
public void setPolicyName(java.lang.String policyName)
The name of the key policy.
This value must be default
.
Constraints:
Length: 1 - 128
Pattern: [\w]+
policyName
- The name of the key policy.
This value must be default
.
public PutKeyPolicyRequest withPolicyName(java.lang.String policyName)
The name of the key policy.
This value must be default
.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [\w]+
policyName
- The name of the key policy.
This value must be default
.
public java.lang.String getPolicy()
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 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 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).
Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+
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 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 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).
public void setPolicy(java.lang.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 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 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).
Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+
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 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 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).
public PutKeyPolicyRequest withPolicy(java.lang.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 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 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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 131072
Pattern: [ -ÿ]+
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 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 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).
public java.lang.Boolean 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.
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.
public java.lang.Boolean 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.
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.
public void setBypassPolicyLockoutSafetyCheck(java.lang.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.
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.
public PutKeyPolicyRequest withBypassPolicyLockoutSafetyCheck(java.lang.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.
Returns a reference to this object so that method calls can be chained together.
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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.