Class ScheduleKeyDeletionRequest

    • Constructor Detail

      • ScheduleKeyDeletionRequest

        public ScheduleKeyDeletionRequest()
    • Method Detail

      • setKeyId

        public void setKeyId​(String keyId)

        The unique identifier for the customer master key (CMK) to delete.

        To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

        • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab

        To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

        Parameters:
        keyId - The unique identifier for the customer master key (CMK) to delete.

        To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

        • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab

        To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

      • getKeyId

        public String getKeyId()

        The unique identifier for the customer master key (CMK) to delete.

        To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

        • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab

        To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

        Returns:
        The unique identifier for the customer master key (CMK) to delete.

        To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

        • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd -56ef-1234567890ab

        To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

      • withKeyId

        public ScheduleKeyDeletionRequest withKeyId​(String keyId)

        The unique identifier for the customer master key (CMK) to delete.

        To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

        • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab

        To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

        Parameters:
        keyId - The unique identifier for the customer master key (CMK) to delete.

        To specify this value, use the unique key ID or the Amazon Resource Name (ARN) of the CMK. Examples:

        • Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

        • Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab

        To obtain the unique key ID and key ARN for a given CMK, use ListKeys or DescribeKey.

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

        public void setPendingWindowInDays​(Integer pendingWindowInDays)

        The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

        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.

        Parameters:
        pendingWindowInDays - The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

        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.

      • getPendingWindowInDays

        public Integer getPendingWindowInDays()

        The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

        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.

        Returns:
        The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

        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.

      • withPendingWindowInDays

        public ScheduleKeyDeletionRequest withPendingWindowInDays​(Integer pendingWindowInDays)

        The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

        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.

        Parameters:
        pendingWindowInDays - The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

        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.

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

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object