time_to_lives

Creates, updates, deletes, gets or lists a time_to_lives resource.

Overview

Name	time_to_lives
Type	Resource
Id	aws.dynamodb.time_to_lives

Fields

The following fields are returned by SELECT queries:

describe_time_to_live

Name	Datatype	Description
attribute_name	string	The name of the TTL attribute for items in the table.
time_to_live_status	string	The TTL status for the table. (ENABLING, DISABLING, ENABLED, DISABLED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_time_to_live	select	region		Gives a description of the Time to Live (TTL) status on the specified table.
update_time_to_live	update	region, TableName, TimeToLiveSpecification		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_time_to_live

Gives a description of the Time to Live (TTL) status on the specified table.

SELECT
attribute_name,
time_to_live_status
FROM aws.dynamodb.time_to_lives
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_time_to_live

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.

UPDATE aws.dynamodb.time_to_lives
SET 
TableName = '{{ TableName }}',
TimeToLiveSpecification = '{{ TimeToLiveSpecification }}'
WHERE 
region = '{{ region }}' --required
AND TableName = '{{ TableName }}' --required
AND TimeToLiveSpecification = '{{ TimeToLiveSpecification }}' --required
RETURNING
time_to_live_specification;