Package software.amazon.awscdk.cfnpropertymixins.services.dynamodb

Interface CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty.Jsii$Proxy

Enclosing class:

CfnGlobalTablePropsMixin

@Stability(Stable)
public static interface CfnGlobalTablePropsMixin.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.cfnpropertymixins.services.dynamodb.*;
 TimeToLiveSpecificationProperty timeToLiveSpecificationProperty = TimeToLiveSpecificationProperty.builder()
         .attributeName("attributeName")
         .enabled(false)
         .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	CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty.Builder	A builder for CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty
static final class	CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty.Jsii$Proxy	An implementation for CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty

Method Summary

Modifier and Type	Method	Description
static CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty.Builder	builder()
default String	getAttributeName()	The name of the attribute used to store the expiration time for items in the table.
default 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

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

getEnabled

@Stability(Stable)
@Nullable
default 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-globaltable-timetolivespecification.html#cfn-dynamodb-globaltable-timetolivespecification-enabled

builder

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

Returns:

a CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty.Builder of CfnGlobalTablePropsMixin.TimeToLiveSpecificationProperty