com.amazonaws.services.kms.model.EnableKeyRotationRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2019-2024 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EnableKeyRotationRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*/
private String keyId;
/**
*
* Use this parameter to specify a custom period of time between each rotation date. If no value is specified, the
* default value is 365 days.
*
*
* The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your
* key material, and the number of days between each automatic rotation thereafter.
*
*
* You can use the kms:RotationPeriodInDays condition key to further constrain the values that principals can
* specify in the RotationPeriodInDays parameter.
*
*
*
*/
private Integer rotationPeriodInDays;
/**
*
* 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:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* @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:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* 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:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* @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:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*/
public String getKeyId() {
return this.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:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
*
*
* @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:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnableKeyRotationRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* Use this parameter to specify a custom period of time between each rotation date. If no value is specified, the
* default value is 365 days.
*
*
* The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your
* key material, and the number of days between each automatic rotation thereafter.
*
*
* You can use the kms:RotationPeriodInDays condition key to further constrain the values that principals can
* specify in the RotationPeriodInDays parameter.
*
*
*
*
* @param rotationPeriodInDays
* Use this parameter to specify a custom period of time between each rotation date. If no value is
* specified, the default value is 365 days.
*
* The rotation period defines the number of days after you enable automatic key rotation that KMS will
* rotate your key material, and the number of days between each automatic rotation thereafter.
*
*
* You can use the kms:RotationPeriodInDays condition key to further constrain the values that principals
* can specify in the RotationPeriodInDays parameter.
*
*
*/
public void setRotationPeriodInDays(Integer rotationPeriodInDays) {
this.rotationPeriodInDays = rotationPeriodInDays;
}
/**
*
* Use this parameter to specify a custom period of time between each rotation date. If no value is specified, the
* default value is 365 days.
*
*
* The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your
* key material, and the number of days between each automatic rotation thereafter.
*
*
* You can use the kms:RotationPeriodInDays condition key to further constrain the values that principals can
* specify in the RotationPeriodInDays parameter.
*
*
*
*
* @return Use this parameter to specify a custom period of time between each rotation date. If no value is
* specified, the default value is 365 days.
*
* The rotation period defines the number of days after you enable automatic key rotation that KMS will
* rotate your key material, and the number of days between each automatic rotation thereafter.
*
*
* You can use the kms:RotationPeriodInDays condition key to further constrain the values that
* principals can specify in the RotationPeriodInDays parameter.
*
*
*/
public Integer getRotationPeriodInDays() {
return this.rotationPeriodInDays;
}
/**
*
* Use this parameter to specify a custom period of time between each rotation date. If no value is specified, the
* default value is 365 days.
*
*
* The rotation period defines the number of days after you enable automatic key rotation that KMS will rotate your
* key material, and the number of days between each automatic rotation thereafter.
*
*
* You can use the kms:RotationPeriodInDays condition key to further constrain the values that principals can
* specify in the RotationPeriodInDays parameter.
*
*
*
*
* @param rotationPeriodInDays
* Use this parameter to specify a custom period of time between each rotation date. If no value is
* specified, the default value is 365 days.
*
* The rotation period defines the number of days after you enable automatic key rotation that KMS will
* rotate your key material, and the number of days between each automatic rotation thereafter.
*
*
* You can use the kms:RotationPeriodInDays condition key to further constrain the values that principals
* can specify in the RotationPeriodInDays parameter.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EnableKeyRotationRequest withRotationPeriodInDays(Integer rotationPeriodInDays) {
setRotationPeriodInDays(rotationPeriodInDays);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @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: ").append(getKeyId()).append(",");
if (getRotationPeriodInDays() != null)
sb.append("RotationPeriodInDays: ").append(getRotationPeriodInDays());
sb.append("}");
return sb.toString();
}
@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;
if (other.getRotationPeriodInDays() == null ^ this.getRotationPeriodInDays() == null)
return false;
if (other.getRotationPeriodInDays() != null && other.getRotationPeriodInDays().equals(this.getRotationPeriodInDays()) == 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 + ((getRotationPeriodInDays() == null) ? 0 : getRotationPeriodInDays().hashCode());
return hashCode;
}
@Override
public EnableKeyRotationRequest clone() {
return (EnableKeyRotationRequest) super.clone();
}
}