Interface CfnGlobalTable.TimeToLiveSpecificationProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnGlobalTable.TimeToLiveSpecificationProperty extends
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.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 TimeToLiveSpecificationProperty timeToLiveSpecificationProperty = TimeToLiveSpecificationProperty.builder()
         // the properties below are optional
  • Method Details

    • getEnabled

      @Stability(Stable) @NotNull Object getEnabled()
      Indicates whether TTL is to be enabled (true) or disabled (false) on the table.
    • 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.

    • builder

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