com.amazonaws.services.kms.model

Class RetireGrantRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.RetireGrantRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class RetireGrantRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

• The AWS account (root user) under which the grant was created

• The RetiringPrincipal, if present in the grant

• The GranteePrincipal, if RetireGrant is an operation specified in the grant

You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.

Cross-account use: Yes. You can retire a grant on a CMK in a different AWS account.

Required permissions:: Permission to retire a grant is specified in the grant. You cannot control access to this operation in a policy. For more information, see Using grants in the AWS Key Management Service Developer Guide.

Related operations:

• CreateGrant

• ListGrants

• ListRetirableGrants

• RevokeGrant

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RetireGrantRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getGrantId() Unique identifier of the grant to retire.
java.lang.String	getGrantToken() Token that identifies the grant to be retired.
java.lang.String	getKeyId() The Amazon Resource Name (ARN) of the CMK associated with the grant.
int	hashCode()
void	setGrantId(java.lang.String grantId) Unique identifier of the grant to retire.
void	setGrantToken(java.lang.String grantToken) Token that identifies the grant to be retired.
void	setKeyId(java.lang.String keyId) The Amazon Resource Name (ARN) of the CMK associated with the grant.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
RetireGrantRequest	withGrantId(java.lang.String grantId) Unique identifier of the grant to retire.
RetireGrantRequest	withGrantToken(java.lang.String grantToken) Token that identifies the grant to be retired.
RetireGrantRequest	withKeyId(java.lang.String keyId) The Amazon Resource Name (ARN) of the CMK 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

RetireGrantRequest

public RetireGrantRequest()

Method Detail

getGrantToken

public java.lang.String getGrantToken()

Token that identifies the grant to be retired.

Constraints:
Length: 1 - 8192

Returns:

Token that identifies the grant to be retired.

setGrantToken

public void setGrantToken(java.lang.String grantToken)

Token that identifies the grant to be retired.

Constraints:
Length: 1 - 8192

Parameters:

grantToken -

Token that identifies the grant to be retired.

withGrantToken

public RetireGrantRequest withGrantToken(java.lang.String grantToken)

Token that identifies the grant to be retired.

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

Constraints:
Length: 1 - 8192

Parameters:

grantToken -

Token that identifies the grant to be retired.

Returns:

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

getKeyId

public java.lang.String getKeyId()

The Amazon Resource Name (ARN) of the CMK associated with the grant.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Constraints:
Length: 1 - 2048

Returns:

The Amazon Resource Name (ARN) of the CMK associated with the grant.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

setKeyId

public void setKeyId(java.lang.String keyId)

The Amazon Resource Name (ARN) of the CMK associated with the grant.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Constraints:
Length: 1 - 2048

Parameters:

keyId -

The Amazon Resource Name (ARN) of the CMK associated with the grant.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

withKeyId

public RetireGrantRequest withKeyId(java.lang.String keyId)

The Amazon Resource Name (ARN) of the CMK associated with the grant.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

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

Constraints:
Length: 1 - 2048

Parameters:

keyId -

The Amazon Resource Name (ARN) of the CMK associated with the grant.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

Returns:

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

getGrantId

public java.lang.String getGrantId()

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Constraints:
Length: 1 - 128

Returns:

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

setGrantId

public void setGrantId(java.lang.String grantId)

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Constraints:
Length: 1 - 128

Parameters:

grantId -

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

withGrantId

public RetireGrantRequest withGrantId(java.lang.String grantId)

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

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

Constraints:
Length: 1 - 128

Parameters:

grantId -

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

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