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

Class ScheduleKeyDeletionRequest

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.ScheduleKeyDeletionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ScheduleKeyDeletionRequest.Builder,ScheduleKeyDeletionRequest>
@Generated("software.amazon.awssdk:codegen") public final class ScheduleKeyDeletionRequest extends KmsRequest implements ToCopyableBuilder<ScheduleKeyDeletionRequest.Builder,ScheduleKeyDeletionRequest>

  • Method Details

    • keyId

      public final String keyId()

      The unique identifier of the KMS key to delete.

      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:
      The unique identifier of the KMS key to delete.

      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.

    • pendingWindowInDays

      public final Integer pendingWindowInDays()

      The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

      If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

      This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30. You can use the kms:ScheduleKeyDeletionPendingWindowInDays condition key to further constrain the values that principals can specify in the PendingWindowInDays parameter.

      Returns:
      The waiting period, specified in number of days. After the waiting period ends, KMS deletes the KMS key.

      If the KMS key is a multi-Region primary key with replica keys, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.

      This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30. You can use the kms:ScheduleKeyDeletionPendingWindowInDays condition key to further constrain the values that principals can specify in the PendingWindowInDays parameter.

    • toBuilder

      public ScheduleKeyDeletionRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ScheduleKeyDeletionRequest.Builder,ScheduleKeyDeletionRequest>
      Specified by:
      toBuilder in class KmsRequest

    • builder

      public static ScheduleKeyDeletionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ScheduleKeyDeletionRequest.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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo