com.amazonaws.services.kms.model

Class GetKeyPolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.GetKeyPolicyRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GetKeyPolicyRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Gets a key policy attached to the specified customer master key (CMK).

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

Required permissions: kms:GetKeyPolicy (key policy)

Related operations: PutKeyPolicy

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetKeyPolicyRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getKeyId() A unique identifier for the customer master key (CMK).
java.lang.String	getPolicyName() Specifies the name of the key policy.
int	hashCode()
void	setKeyId(java.lang.String keyId) A unique identifier for the customer master key (CMK).
void	setPolicyName(java.lang.String policyName) Specifies the name of the key policy.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GetKeyPolicyRequest	withKeyId(java.lang.String keyId) A unique identifier for the customer master key (CMK).
GetKeyPolicyRequest	withPolicyName(java.lang.String policyName) Specifies 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

GetKeyPolicyRequest

public GetKeyPolicyRequest()

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

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

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

Returns:

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

setPolicyName

public void setPolicyName(java.lang.String policyName)

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

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

Parameters:

policyName -

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

withPolicyName

public GetKeyPolicyRequest withPolicyName(java.lang.String policyName)

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

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

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

Parameters:

policyName -

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

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