Struct aws_sdk_kms::operation::schedule_key_deletion::builders::ScheduleKeyDeletionInputBuilder

#[non_exhaustive]
pub struct ScheduleKeyDeletionInputBuilder { /* private fields */ }

A builder for ScheduleKeyDeletionInput.

Implementations

impl ScheduleKeyDeletionInputBuilder

pub fn key_id(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_key_id(self, input: Option<String>) -> Self

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.

pub fn get_key_id(&self) -> &Option<String>

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.

pub fn pending_window_in_days(self, input: i32) -> Self

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.

pub fn set_pending_window_in_days(self, input: Option<i32>) -> Self

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.

pub fn get_pending_window_in_days(&self) -> &Option<i32>

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.

pub fn build(self) -> Result<ScheduleKeyDeletionInput, BuildError>

Consumes the builder and constructs a ScheduleKeyDeletionInput.

impl ScheduleKeyDeletionInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<ScheduleKeyDeletionOutput, SdkError<ScheduleKeyDeletionError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ScheduleKeyDeletionInputBuilder

fn clone(&self) -> ScheduleKeyDeletionInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScheduleKeyDeletionInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScheduleKeyDeletionInputBuilder

fn default() -> ScheduleKeyDeletionInputBuilder

Returns the “default value” for a type.

impl PartialEq for ScheduleKeyDeletionInputBuilder

fn eq(&self, other: &ScheduleKeyDeletionInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ScheduleKeyDeletionInputBuilder