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

Interface ScheduleKeyDeletionRequest.Builder

    • Method Detail

      • keyId

        ScheduleKeyDeletionRequest.Builder keyId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • pendingWindowInDays

        ScheduleKeyDeletionRequest.Builder pendingWindowInDays​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.