Package software.amazon.awscdk.services.dynamodb

Interface CfnGlobalTable.TimeToLiveSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalTable.TimeToLiveSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnGlobalTable

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

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

All replicas will have the same time to live configuration.

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-globaltable-timetolivespecification.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGlobalTable.TimeToLiveSpecificationProperty.Builder	builder()
default String	getAttributeName()	The name of the 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.

See Also:

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

getAttributeName

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

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

Currently, you cannot directly change the attribute name used to evaluate time to live. In order to do so, you must first disable time to live, and then re-enable it with the new attribute name. It can take up to one hour for changes to time to live to take effect. If you attempt to modify time to live within that time window, your stack operation might be delayed.

See Also:

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

builder

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

Returns:

a CfnGlobalTable.TimeToLiveSpecificationProperty.Builder of CfnGlobalTable.TimeToLiveSpecificationProperty