/* * 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; /** *

* Enables automatic rotation of the key material of the specified symmetric * encryption KMS key. *

*

* When you enable automatic rotation of acustomer managed KMS key, KMS rotates the key material of the KMS key * one year (approximately 365 days) from the enable date and every year * thereafter. You can monitor rotation of the key material for your KMS keys in * CloudTrail and Amazon CloudWatch. To disable rotation of the key material in * a customer managed KMS key, use the DisableKeyRotation operation. *

*

* Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of * asymmetric KMS keys, HMAC * KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of * related multi-Region keys, set the property on the primary key. *

*

* You cannot enable or disable automatic rotation Amazon Web Services managed KMS keys. KMS always rotates the key * material of Amazon Web Services managed keys every year. Rotation of Amazon Web Services owned KMS keys varies. *

* *

* In May 2022, KMS changed the rotation schedule for Amazon Web Services * managed keys from every three years (approximately 1,095 days) to every year * (approximately 365 days). *

*

* New Amazon Web Services managed keys are automatically rotated one year after * they are created, and approximately every year thereafter. *

*

* Existing Amazon Web Services managed keys are automatically rotated one year * after their most recent rotation, and every year thereafter. *

* *

* 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:EnableKeyRotation (key policy) *

*

* Related operations: *

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

* Identifies a symmetric encryption KMS key. You cannot enable automatic * rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set * of related multi-Region keys, set the property on the primary 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; /** *

* Identifies a symmetric encryption KMS key. You cannot enable automatic * rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set * of related multi-Region keys, set the property on the primary 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

* Identifies a symmetric encryption KMS key. You cannot enable * automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of * a set of related multi-Region keys, set the property on the primary 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; } /** *

* Identifies a symmetric encryption KMS key. You cannot enable automatic * rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set * of related multi-Region keys, set the property on the primary 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

* Identifies a symmetric encryption KMS key. You cannot enable * automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation * of a set of related multi-Region keys, set the property on the primary 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; } /** *

* Identifies a symmetric encryption KMS key. You cannot enable automatic * rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set * of related multi-Region keys, set the property on the primary 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

* Identifies a symmetric encryption KMS key. You cannot enable * automatic rotation of asymmetric KMS keys, HMAC KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation * of a set of related multi-Region keys, set the property on the primary 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 EnableKeyRotationRequest withKeyId(String keyId) { this.keyId = 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 int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof EnableKeyRotationRequest == false) return false; EnableKeyRotationRequest other = (EnableKeyRotationRequest) obj; if (other.getKeyId() == null ^ this.getKeyId() == null) return false; if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false) return false; return true; } }