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

Interface ScheduleKeyDeletionResponse.Builder

    • Method Detail

      • keyId

        ScheduleKeyDeletionResponse.Builder keyId​(String keyId)

        The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.

        Parameters:
        keyId - The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionDate

        ScheduleKeyDeletionResponse.Builder deletionDate​(Instant deletionDate)

        The date and time after which KMS deletes the KMS key.

        If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.

        Parameters:
        deletionDate - The date and time after which KMS deletes the KMS key.

        If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • keyState

        ScheduleKeyDeletionResponse.Builder keyState​(String keyState)

        The current status of the KMS key.

        For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

        Parameters:
        keyState - The current status of the KMS key.

        For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyState, KeyState

      • keyState

        ScheduleKeyDeletionResponse.Builder keyState​(KeyState keyState)

        The current status of the KMS key.

        For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

        Parameters:
        keyState - The current status of the KMS key.

        For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KeyState, KeyState

      • pendingWindowInDays

        ScheduleKeyDeletionResponse.Builder pendingWindowInDays​(Integer pendingWindowInDays)

        The waiting period before the KMS key is deleted.

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

        Parameters:
        pendingWindowInDays - The waiting period before the KMS key is deleted.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.