Package software.amazon.awssdk.services.kms.model

Class EnableKeyRotationRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kms.model.KmsRequest

software.amazon.awssdk.services.kms.model.EnableKeyRotationRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<EnableKeyRotationRequest.Builder,EnableKeyRotationRequest>

@Generated("software.amazon.awssdk:codegen")
public final class EnableKeyRotationRequest
extends KmsRequest
implements ToCopyableBuilder<EnableKeyRotationRequest.Builder,EnableKeyRotationRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EnableKeyRotationRequest.Builder

Method Summary

Modifier and Type	Method	Description
static EnableKeyRotationRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId()	Identifies a symmetric encryption KMS key.
Integer	rotationPeriodInDays()	Use this parameter to specify a custom period of time between each rotation date.
List<SdkField<?>>	sdkFields()
static Class<? extends EnableKeyRotationRequest.Builder>	serializableBuilderClass()
EnableKeyRotationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

keyId

public final 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:

• 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.

Returns:

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.

rotationPeriodInDays

public final Integer 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.

Returns:

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.

toBuilder

public EnableKeyRotationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EnableKeyRotationRequest.Builder,EnableKeyRotationRequest>

Specified by:

toBuilder in class KmsRequest

builder

public static EnableKeyRotationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends EnableKeyRotationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo