AWS::DynamoDB::Table TimeToLiveSpecification - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::DynamoDB::Table TimeToLiveSpecification

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "AttributeName" : String,
  "Enabled" : Boolean
}

YAML

  AttributeName: String
  Enabled: Boolean

Properties

AttributeName

The name of the TTL attribute used to store the expiration time for items in the table.

Note

To update this property, you must first disable TTL then enable TTL with the new attribute name.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Update requires: No interruption

Enabled

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

Required: Yes

Type: Boolean

Update requires: No interruption