Package software.amazon.awscdk.services.dynamodb

Interface CfnTable.TimeToLiveSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.TimeToLiveSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnTable

@Stability(Stable)
public static interface CfnTable.TimeToLiveSpecificationProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dynamodb.*;
 TimeToLiveSpecificationProperty timeToLiveSpecificationProperty = TimeToLiveSpecificationProperty.builder()
         .enabled(false)
         // the properties below are optional
         .attributeName("attributeName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTable.TimeToLiveSpecificationProperty.Builder	A builder for CfnTable.TimeToLiveSpecificationProperty
static final class	CfnTable.TimeToLiveSpecificationProperty.Jsii$Proxy	An implementation for CfnTable.TimeToLiveSpecificationProperty

Method Summary

Modifier and Type	Method	Description
static CfnTable.TimeToLiveSpecificationProperty.Builder	builder()
default String	getAttributeName()	The name of the TTL attribute used to store the expiration time for items in the table.
Object	getEnabled()	Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@NotNull
Object getEnabled()

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

Returns union: either Boolean or IResolvable

See Also:

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

getAttributeName

@Stability(Stable)
@Nullable
default String getAttributeName()

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

builder

@Stability(Stable)
static CfnTable.TimeToLiveSpecificationProperty.Builder builder()

Returns:

a CfnTable.TimeToLiveSpecificationProperty.Builder of CfnTable.TimeToLiveSpecificationProperty