Struct aws_sdk_dynamodb::operation::update_time_to_live::builders::UpdateTimeToLiveFluentBuilder

pub struct UpdateTimeToLiveFluentBuilder { /* private fields */ }

Fluent builder constructing a request to UpdateTimeToLive.

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.

For more information, see Time To Live in the Amazon DynamoDB Developer Guide.

Implementations

impl UpdateTimeToLiveFluentBuilder

pub fn as_input(&self) -> &UpdateTimeToLiveInputBuilder

Access the UpdateTimeToLive as a reference.

pub async fn send( self, ) -> Result<UpdateTimeToLiveOutput, SdkError<UpdateTimeToLiveError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<UpdateTimeToLiveOutput, UpdateTimeToLiveError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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

The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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

The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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

The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

pub fn time_to_live_specification(self, input: TimeToLiveSpecification) -> Self

Represents the settings used to enable or disable Time to Live for the specified table.

pub fn set_time_to_live_specification( self, input: Option<TimeToLiveSpecification>, ) -> Self

Represents the settings used to enable or disable Time to Live for the specified table.

pub fn get_time_to_live_specification(&self) -> &Option<TimeToLiveSpecification>

Represents the settings used to enable or disable Time to Live for the specified table.

Trait Implementations

impl Clone for UpdateTimeToLiveFluentBuilder

fn clone(&self) -> UpdateTimeToLiveFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateTimeToLiveFluentBuilder

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

Formats the value using the given formatter.