2.248.0

interface TimeToLiveSpecificationProperty

LanguageType name
.NETAmazon.CDK.CfnPropertyMixins.AWS.DynamoDB.CfnTablePropsMixin.TimeToLiveSpecificationProperty
Gogithub.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsdynamodb#CfnTablePropsMixin_TimeToLiveSpecificationProperty
Javasoftware.amazon.awscdk.cfnpropertymixins.services.dynamodb.CfnTablePropsMixin.TimeToLiveSpecificationProperty
Pythonaws_cdk.cfn_property_mixins.aws_dynamodb.CfnTablePropsMixin.TimeToLiveSpecificationProperty
TypeScript @aws-cdk/cfn-property-mixins » aws_dynamodb » CfnTablePropsMixin » TimeToLiveSpecificationProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-timetolivespecification.html

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/cfn-property-mixins';
const timeToLiveSpecificationProperty: dynamodb.CfnTablePropsMixin.TimeToLiveSpecificationProperty = {
  attributeName: 'attributeName',
  enabled: false,
};

Properties

NameTypeDescription
attributeName?stringThe name of the TTL attribute used to store the expiration time for items in the table.
enabled?boolean | IResolvableIndicates whether TTL is to be enabled (true) or disabled (false) on the table.

attributeName?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-timetolivespecification.html#cfn-dynamodb-table-timetolivespecification-attributename

enabled?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-timetolivespecification.html#cfn-dynamodb-table-timetolivespecification-enabled

← PreviousNext →