com.amazonaws.services.kms.model

Class PutKeyPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.PutKeyPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutKeyPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutKeyPolicy operation.

Attaches a policy to the specified key.

See Also:

AWSKMS.putKeyPolicy(PutKeyPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutKeyPolicyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
PutKeyPolicyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getKeyId() A unique identifier for the customer master key.
String	getPolicy() The policy, in JSON format, to be attached to the key.
String	getPolicyName() Name of the policy to be attached.
int	hashCode()
void	setKeyId(String keyId) A unique identifier for the customer master key.
void	setPolicy(String policy) The policy, in JSON format, to be attached to the key.
void	setPolicyName(String policyName) Name of the policy to be attached.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutKeyPolicyRequest	withKeyId(String keyId) A unique identifier for the customer master key.
PutKeyPolicyRequest	withPolicy(String policy) The policy, in JSON format, to be attached to the key.
PutKeyPolicyRequest	withPolicyName(String policyName) Name of the policy to be attached.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutKeyPolicyRequest

public PutKeyPolicyRequest()

Method Detail

getKeyId

public String getKeyId()

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Constraints:
Length: 1 - 256

Returns:

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

setKeyId

public void setKeyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Constraints:
Length: 1 - 256

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

withKeyId

public PutKeyPolicyRequest withKeyId(String keyId)

A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

keyId - A unique identifier for the customer master key. This value can be a globally unique identifier or the fully specified ARN to a key.

• Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012

Returns:

A reference to this updated object so that method calls can be chained together.

getPolicyName

public String getPolicyName()

Name of the policy to be attached. Currently, the only supported name is "default".

Constraints:
Length: 1 - 128
Pattern: [\w]+

Returns:

Name of the policy to be attached. Currently, the only supported name is "default".

setPolicyName

public void setPolicyName(String policyName)

Name of the policy to be attached. Currently, the only supported name is "default".

Constraints:
Length: 1 - 128
Pattern: [\w]+

Parameters:

policyName - Name of the policy to be attached. Currently, the only supported name is "default".

withPolicyName

public PutKeyPolicyRequest withPolicyName(String policyName)

Name of the policy to be attached. Currently, the only supported name is "default".

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128
Pattern: [\w]+

Parameters:

policyName - Name of the policy to be attached. Currently, the only supported name is "default".

Returns:

A reference to this updated object so that method calls can be chained together.

getPolicy

public String getPolicy()

The policy, in JSON format, to be attached to the key.

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Returns:

The policy, in JSON format, to be attached to the key.

setPolicy

public void setPolicy(String policy)

The policy, in JSON format, to be attached to the key.

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Parameters:

policy - The policy, in JSON format, to be attached to the key.

withPolicy

public PutKeyPolicyRequest withPolicy(String policy)

The policy, in JSON format, to be attached to the key.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 131072
Pattern: [\u0009\u000A\u000D\u0020-\u00FF]+

Parameters:

policy - The policy, in JSON format, to be attached to the key.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public PutKeyPolicyRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()