com.amazonaws.services.kms.model.CancelKeyDeletionRequest 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 CancelKeyDeletionRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {
    /**
     * 
     * The unique identifier for the customer master key (CMK) for which to
     * cancel deletion.
     * 
     * 
     * 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 unique identifier for the customer master key (CMK) for which to
     * cancel deletion.
     * 
     * 
     * 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) for which
     *        to cancel deletion.
     *        
     *        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) for which to
     * cancel deletion.
     * 
     * 
     * 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) for which
     *         to cancel deletion.
     *         
     *         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) for which to
     * cancel deletion.
     * 
     * 
     * 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) for which
     *        to cancel deletion.
     *        
     *        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 CancelKeyDeletionRequest withKeyId(String keyId) {
        setKeyId(keyId);
        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());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof CancelKeyDeletionRequest == false)
            return false;
        CancelKeyDeletionRequest other = (CancelKeyDeletionRequest) obj;
        if (other.getKeyId() == null ^ this.getKeyId() == null)
            return false;
        if (other.getKeyId() != null
                && other.getKeyId().equals(this.getKeyId()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
        return hashCode;
    }
    @Override
    public CancelKeyDeletionRequest clone() {
        return (CancelKeyDeletionRequest) super.clone();
    }
}