aws-cdk-lib.aws_dynamodb.CfnTable.TimeToLiveSpecificationProperty

TimeToLiveSpecificationProperty Struct

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

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dynamodb as dynamodb } from 'aws-cdk-lib';
const timeToLiveSpecificationProperty: dynamodb.CfnTable.TimeToLiveSpecificationProperty = {
  enabled: false,

  // the properties below are optional
  attributeName: 'attributeName',
};

Properties

attributeName?optionalstringattribute_name?optionalstrattributeName?optionalStringAttributeName?optionalstringAttributeName?optional*string#

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

• The AttributeName property is required when enabling the TTL, or when TTL is already enabled.
• To update this property, you must first disable TTL and then enable TTL with the new attribute name.

enabledboolean | IResolvableenabledtyping.Union[bool, IResolvable]enabledBooleanEnabledboolEnabledinterface{}required#

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