ScheduleKeyDeletionRequest (AWS Java SDK for AWS KMS 1.10.27 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.ScheduleKeyDeletionRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class ScheduleKeyDeletionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Container for the parameters to the ScheduleKeyDeletion operation.
Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the state of the CMK changes to PendingDeletion . Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that point to it.

IMPORTANT: Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.

For more information about scheduling a CMK for deletion, go to Deleting Customer Master Keys in the AWS Key Management Service Developer Guide .

See Also:
AWSKMS.scheduleKeyDeletion(ScheduleKeyDeletionRequest), Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

ScheduleKeyDeletionRequest()

Constructors
Constructor and Description
`ScheduleKeyDeletionRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`ScheduleKeyDeletionRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getKeyId()` The unique identifier for the customer master key (CMK) to delete.
`Integer`	`getPendingWindowInDays()` The waiting period, specified in number of days.
`int`	`hashCode()`
`void`	`setKeyId(String keyId)` The unique identifier for the customer master key (CMK) to delete.
`void`	`setPendingWindowInDays(Integer pendingWindowInDays)` The waiting period, specified in number of days.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ScheduleKeyDeletionRequest`	`withKeyId(String keyId)` The unique identifier for the customer master key (CMK) to delete.
`ScheduleKeyDeletionRequest`	`withPendingWindowInDays(Integer pendingWindowInDays)` The waiting period, specified in number of days.

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
  - ScheduleKeyDeletionRequest
```
public ScheduleKeyDeletionRequest()
```
- Method Detail
  - getKeyId
```
public String getKeyId()
```
    The unique identifier for the customer master key (CMK) to delete.
    To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
    - Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
    Constraints:
    Length: 1 - 256
    Returns:
    The unique identifier for the customer master key (CMK) to delete.
    To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
    
    Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
  - setKeyId
```
public void setKeyId(String keyId)
```
    The unique identifier for the customer master key (CMK) to delete.
    To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
    - Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
    Constraints:
    Length: 1 - 256
    Parameters:
    keyId - The unique identifier for the customer master key (CMK) to delete.
    To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
    
    Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
  - withKeyId
```
public ScheduleKeyDeletionRequest withKeyId(String keyId)
```
    The unique identifier for the customer master key (CMK) to delete.
    To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
    - Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    - Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 256
    Parameters:
    keyId - The unique identifier for the customer master key (CMK) to delete.
    To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:
    
    Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
    
    Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
    
    To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPendingWindowInDays
```
public Integer getPendingWindowInDays()
```
    The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).
    This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
    Constraints:
    Range: 1 - 365
    
    Returns:
    The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).
    This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
  - setPendingWindowInDays
```
public void setPendingWindowInDays(Integer pendingWindowInDays)
```
    The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).
    This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
    Constraints:
    Range: 1 - 365
    
    Parameters:
    pendingWindowInDays - The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).
    This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
  - withPendingWindowInDays
```
public ScheduleKeyDeletionRequest withPendingWindowInDays(Integer pendingWindowInDays)
```
    The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).
    This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 1 - 365
    
    Parameters:
    pendingWindowInDays - The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).
    This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
    
    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 ScheduleKeyDeletionRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class ScheduleKeyDeletionRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ScheduleKeyDeletionRequest

Method Detail

getKeyId

setKeyId

withKeyId

getPendingWindowInDays

setPendingWindowInDays

withPendingWindowInDays

toString

hashCode

equals

clone