/* * Copyright 2010-2023 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; /** *

* Updates the description of a KMS key. To see the description of a KMS key, * use DescribeKey. *

*

* The KMS key that you use for this operation must be in a compatible key * state. For details, see Key states of KMS keys in the Key Management Service Developer * Guide. *

*

* Cross-account use: No. You cannot perform this operation on a KMS key * in a different Amazon Web Services account. *

*

* Required permissions: kms:UpdateKeyDescription (key policy) *

*

* Related operations *

* */ public class UpdateKeyDescriptionRequest extends AmazonWebServiceRequest implements Serializable { /** *

* Updates the description of the specified KMS key. *

*

* Specify the key ID or key ARN of the KMS key. *

*

* For example: *

* *

* To get the key ID and key ARN for a KMS key, use ListKeys or * DescribeKey. *

*

* Constraints:
* Length: 1 - 2048
*/ private String keyId; /** *

* New description for the KMS key. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* Constraints:
* Length: 0 - 8192
*/ private String description; /** *

* Updates the description of the specified KMS key. *

*

* Specify the key ID or key ARN of the KMS key. *

*

* For example: *

* *

* To get the key ID and key ARN for a KMS key, use ListKeys or * DescribeKey. *

*

* Constraints:
* Length: 1 - 2048
* * @return

* Updates the description of the specified KMS key. *

*

* Specify the key ID or key ARN of the KMS key. *

*

* For example: *

* *

* To get the key ID and key ARN for a KMS key, use ListKeys * or DescribeKey. *

*/ public String getKeyId() { return keyId; } /** *

* Updates the description of the specified KMS key. *

*

* Specify the key ID or key ARN of the KMS key. *

*

* For example: *

* *

* To get the key ID and key ARN for a KMS key, use ListKeys or * DescribeKey. *

*

* Constraints:
* Length: 1 - 2048
* * @param keyId

* Updates the description of the specified KMS key. *

*

* Specify the key ID or key ARN of the KMS key. *

*

* For example: *

* *

* To get the key ID and key ARN for a KMS key, use * ListKeys or DescribeKey. *

*/ public void setKeyId(String keyId) { this.keyId = keyId; } /** *

* Updates the description of the specified KMS key. *

*

* Specify the key ID or key ARN of the KMS key. *

*

* For example: *

* *

* To get the key ID and key ARN for a KMS key, use ListKeys or * DescribeKey. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 2048
* * @param keyId

* Updates the description of the specified KMS key. *

*

* Specify the key ID or key ARN of the KMS key. *

*

* For example: *

* *

* To get the key ID and key ARN for a KMS key, use * ListKeys or DescribeKey. *

* @return A reference to this updated object so that method calls can be * chained together. */ public UpdateKeyDescriptionRequest withKeyId(String keyId) { this.keyId = keyId; return this; } /** *

* New description for the KMS key. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* Constraints:
* Length: 0 - 8192
* * @return

* New description for the KMS key. *

* *

* Do not include confidential or sensitive information in this * field. This field may be displayed in plaintext in CloudTrail * logs and other output. *

* */ public String getDescription() { return description; } /** *

* New description for the KMS key. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* Constraints:
* Length: 0 - 8192
* * @param description

* New description for the KMS key. *

* *

* Do not include confidential or sensitive information in this * field. This field may be displayed in plaintext in CloudTrail * logs and other output. *

* */ public void setDescription(String description) { this.description = description; } /** *

* New description for the KMS key. *

* *

* Do not include confidential or sensitive information in this field. This * field may be displayed in plaintext in CloudTrail logs and other output. *

* *

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 0 - 8192
* * @param description

* New description for the KMS key. *

* *

* Do not include confidential or sensitive information in this * field. This field may be displayed in plaintext in CloudTrail * logs and other output. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public UpdateKeyDescriptionRequest withDescription(String description) { this.description = description; 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 (getDescription() != null) sb.append("Description: " + getDescription()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof UpdateKeyDescriptionRequest == false) return false; UpdateKeyDescriptionRequest other = (UpdateKeyDescriptionRequest) obj; if (other.getKeyId() == null ^ this.getKeyId() == null) return false; if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; return true; } }