com.amazonaws.services.kms.model

Class GetKeyPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.GetKeyPolicyRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetKeyPolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the GetKeyPolicy operation.

Retrieves a policy attached to the specified key.

See Also:

AWSKMS.getKeyPolicy(GetKeyPolicyRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetKeyPolicyRequest()

Method Summary

Methods

Modifier and Type	Method and Description
GetKeyPolicyRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getKeyId() A unique identifier for the customer master key.
String	getPolicyName() String that contains the name of the policy.
int	hashCode()
void	setKeyId(String keyId) A unique identifier for the customer master key.
void	setPolicyName(String policyName) String that contains the name of the policy.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetKeyPolicyRequest	withKeyId(String keyId) A unique identifier for the customer master key.
GetKeyPolicyRequest	withPolicyName(String policyName) String that contains the name of the policy.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

GetKeyPolicyRequest

public GetKeyPolicyRequest()

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 GetKeyPolicyRequest 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()

String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.

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

Returns:

String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.

setPolicyName

public void setPolicyName(String policyName)

String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.

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

Parameters:

policyName - String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.

withPolicyName

public GetKeyPolicyRequest withPolicyName(String policyName)

String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.

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

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

Parameters:

policyName - String that contains the name of the policy. Currently, this must be "default". Policy names can be discovered by calling ListKeyPolicies.

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 GetKeyPolicyRequest 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()