com.amazonaws.services.kms.model

Class RetireGrantRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.RetireGrantRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RetireGrantRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RetireGrant operation.

Retires a grant. You can retire a grant when you're done using it to clean up. 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 account that created the grant
• The RetiringPrincipal , if present
• The GranteePrincipal , if RetireGrant is a grantee operation

The grant to retire must be identified by its grant token or by a combination of the key ARN and the grant ID. A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. Both are returned by the CreateGrant function.

See Also:

AWSKMS.retireGrant(RetireGrantRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RetireGrantRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RetireGrantRequest	clone()
boolean	equals(Object obj)
String	getGrantId() Unique identifier of the grant to be retired.
String	getGrantToken() Token that identifies the grant to be retired.
String	getKeyId() A unique identifier for the customer master key associated with the grant.
int	hashCode()
void	setGrantId(String grantId) Unique identifier of the grant to be retired.
void	setGrantToken(String grantToken) Token that identifies the grant to be retired.
void	setKeyId(String keyId) A unique identifier for the customer master key associated with the grant.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RetireGrantRequest	withGrantId(String grantId) Unique identifier of the grant to be retired.
RetireGrantRequest	withGrantToken(String grantToken) Token that identifies the grant to be retired.
RetireGrantRequest	withKeyId(String keyId) A unique identifier for the customer master key associated with the grant.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, 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

RetireGrantRequest

public RetireGrantRequest()

Method Detail

getGrantToken

public 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(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(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 String getKeyId()

A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the 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 associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the 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 associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the 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 associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the 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 RetireGrantRequest withKeyId(String keyId)

A unique identifier for the customer master key associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the 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 associated with the grant. This value can be a globally unique identifier or a fully specified ARN of the 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.

getGrantId

public String getGrantId()

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Constraints:
Length: 1 - 128

Returns:

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

setGrantId

public void setGrantId(String grantId)

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

Constraints:
Length: 1 - 128

Parameters:

grantId - Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

withGrantId

public RetireGrantRequest withGrantId(String grantId)

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• 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 be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

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 RetireGrantRequest clone()

Overrides:

clone in class AmazonWebServiceRequest