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

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
GetKeyPolicyRequest()

Method Summary

Modifier and Type	Method	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 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

Methods inherited from class Object

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

Constructor Details

GetKeyPolicyRequest

public GetKeyPolicyRequest()

Method Details

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

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

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

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

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

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:

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

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.

Parameters:

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

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.

Returns:

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.

Parameters:

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

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

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