PutKeyPolicyRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.PutKeyPolicyRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
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. For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the IAM User Guide . For examples of adding a key policy in multiple programming languages, see Setting a key policy in the AWS Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a CMK in a different AWS account.

Required permissions: kms:PutKeyPolicy (key policy)

Related operations: GetKeyPolicy

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PutKeyPolicyRequest()

Constructors
Constructor and Description
`PutKeyPolicyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
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 customer master key (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 customer master key (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 customer master key (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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PutKeyPolicyRequest
```
public PutKeyPolicyRequest()
```
- Method Detail
  - getKeyId
```
public java.lang.String getKeyId()
```
    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.
    
    Constraints:
    Length: 1 - 2048
    Returns:
    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.
  - setKeyId
```
public void setKeyId(java.lang.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.
    
    Constraints:
    Length: 1 - 2048
    Parameters:
    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.
  - withKeyId
```
public PutKeyPolicyRequest withKeyId(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 2048
    Parameters:
    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.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPolicyName
```
public java.lang.String getPolicyName()
```
    The name of the key policy. The only valid value is default.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w]+
    
    Returns:
    
    The name of the key policy. The only valid value is default.
  - setPolicyName
```
public void setPolicyName(java.lang.String policyName)
```
    The name of the key policy. The only valid value is default.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\w]+
    
    Parameters:
    
    policyName -
    The name of the key policy. The only valid value is default.
  - withPolicyName
```
public PutKeyPolicyRequest withPolicyName(java.lang.String policyName)
```
    The name of the key policy. The only valid value is default.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\w]+
    
    Parameters:
    
    policyName -
    The name of the key policy. The only valid value is default.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getPolicy
```
public java.lang.String getPolicy()
```
    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 cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer Guide.
    
    Constraints:
    Length: 1 - 131072
    Pattern: [ -ÿ]+
    Returns:
    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 cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer Guide.
  - setPolicy
```
public void setPolicy(java.lang.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 cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer Guide.
    
    Constraints:
    Length: 1 - 131072
    Pattern: [ -ÿ]+
    Parameters:
    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 cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer Guide.
  - withPolicy
```
public PutKeyPolicyRequest withPolicy(java.lang.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 cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer Guide.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 131072
    Pattern: [ -ÿ]+
    Parameters:
    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 cannot exceed 32 kilobytes (32768 bytes). For more information, see Resource Quotas in the AWS Key Management Service Developer Guide.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isBypassPolicyLockoutSafetyCheck
```
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 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.
    
    Returns:
    
    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.
  - getBypassPolicyLockoutSafetyCheck
```
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 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.
    
    Returns:
    
    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.
  - setBypassPolicyLockoutSafetyCheck
```
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 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.
    
    Parameters:
    
    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.
  - withBypassPolicyLockoutSafetyCheck
```
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 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class PutKeyPolicyRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

PutKeyPolicyRequest

Method Detail

getKeyId

setKeyId

withKeyId

getPolicyName

setPolicyName

withPolicyName

getPolicy

setPolicy

withPolicy

isBypassPolicyLockoutSafetyCheck

getBypassPolicyLockoutSafetyCheck

setBypassPolicyLockoutSafetyCheck

withBypassPolicyLockoutSafetyCheck

toString

hashCode

equals