com.amazonaws.services.kms.model.ScheduleKeyDeletionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not
* use this file except in compliance with the License. A copy of the License is
* located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.kms.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
*/
public class ScheduleKeyDeletionRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private String keyId;
/**
*
* 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.
*
*/
private Integer pendingWindowInDays;
/**
*
* 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.
*
*
* @param 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.
*/
public void setKeyId(String keyId) {
this.keyId = 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.
*
*
* @return 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.
*/
public String getKeyId() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ScheduleKeyDeletionRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setPendingWindowInDays(Integer pendingWindowInDays) {
this.pendingWindowInDays = 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.
*
*
* @return 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.
*/
public Integer getPendingWindowInDays() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ScheduleKeyDeletionRequest withPendingWindowInDays(
Integer pendingWindowInDays) {
setPendingWindowInDays(pendingWindowInDays);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getKeyId() != null)
sb.append("KeyId: " + getKeyId() + ",");
if (getPendingWindowInDays() != null)
sb.append("PendingWindowInDays: " + getPendingWindowInDays());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ScheduleKeyDeletionRequest == false)
return false;
ScheduleKeyDeletionRequest other = (ScheduleKeyDeletionRequest) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null
&& other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getPendingWindowInDays() == null
^ this.getPendingWindowInDays() == null)
return false;
if (other.getPendingWindowInDays() != null
&& other.getPendingWindowInDays().equals(
this.getPendingWindowInDays()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime
* hashCode
+ ((getPendingWindowInDays() == null) ? 0
: getPendingWindowInDays().hashCode());
return hashCode;
}
@Override
public ScheduleKeyDeletionRequest clone() {
return (ScheduleKeyDeletionRequest) super.clone();
}
}