Class RetireGrantRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Unique identifier of the grant to be retired.Token that identifies the grant to be retired.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
A unique identifier for the customer master key associated with the grant.toString()
Returns a string representation of this object; useful for testing and debugging.withGrantId
(String grantId) Unique identifier of the grant to be retired.withGrantToken
(String grantToken) Token that identifies the grant to be retired.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, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
RetireGrantRequest
public RetireGrantRequest()
-
-
Method Details
-
setGrantToken
Token that identifies the grant to be retired.
- Parameters:
grantToken
- Token that identifies the grant to be retired.
-
getGrantToken
Token that identifies the grant to be retired.
- Returns:
- Token that identifies the grant to be retired.
-
withGrantToken
Token that identifies the grant to be retired.
- Parameters:
grantToken
- Token that identifies the grant to be retired.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKeyId
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
- 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
-
-
-
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
- 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
-
-
-
withKeyId
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
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
-
setGrantId
Unique identifier of the grant to be retired. The grant ID is returned by the
CreateGrant
function.-
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
- Parameters:
grantId
- Unique identifier of the grant to be retired. The grant ID is returned by theCreateGrant
function.-
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
-
-
-
getGrantId
Unique identifier of the grant to be retired. The grant ID is returned by the
CreateGrant
function.-
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
- Returns:
- Unique identifier of the grant to be retired. The grant ID is
returned by the
CreateGrant
function.-
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
-
-
-
withGrantId
Unique identifier of the grant to be retired. The grant ID is returned by the
CreateGrant
function.-
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
- Parameters:
grantId
- Unique identifier of the grant to be retired. The grant ID is returned by theCreateGrant
function.-
Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-