com.amazonaws.services.kms.model

Class RevokeGrantRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.RevokeGrantRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class RevokeGrantRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.

Cross-account use: Yes. To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Required permissions: kms:RevokeGrant (key policy)

Related operations:

• CreateGrant

• ListGrants

• ListRetirableGrants

• RetireGrant

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RevokeGrantRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getGrantId() Identifier of the grant to be revoked.
java.lang.String	getKeyId() A unique identifier for the customer master key associated with the grant.
int	hashCode()
void	setGrantId(java.lang.String grantId) Identifier of the grant to be revoked.
void	setKeyId(java.lang.String keyId) A unique identifier for the customer master key associated with the grant.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
RevokeGrantRequest	withGrantId(java.lang.String grantId) Identifier of the grant to be revoked.
RevokeGrantRequest	withKeyId(java.lang.String keyId) A unique identifier for the customer master key associated with the grant.

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

RevokeGrantRequest

public RevokeGrantRequest()

Method Detail

getKeyId

public java.lang.String getKeyId()

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 RevokeGrantRequest withKeyId(java.lang.String keyId)

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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 associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

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.

getGrantId

public java.lang.String getGrantId()

Identifier of the grant to be revoked.

Constraints:
Length: 1 - 128

Returns:

Identifier of the grant to be revoked.

setGrantId

public void setGrantId(java.lang.String grantId)

Identifier of the grant to be revoked.

Constraints:
Length: 1 - 128

Parameters:

grantId -

Identifier of the grant to be revoked.

withGrantId

public RevokeGrantRequest withGrantId(java.lang.String grantId)

Identifier of the grant to be revoked.

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

Constraints:
Length: 1 - 128

Parameters:

grantId -

Identifier of the grant to be revoked.

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