You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DynamoDB::Types::TimeToLiveSpecification

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Note:

When making an API call, you may pass TimeToLiveSpecification data as a hash:

{
  enabled: false, # required
  attribute_name: "TimeToLiveAttributeName", # required
}

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

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

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

Returns:

  • (String)


4748
4749
4750
4751
4752
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4748

class TimeToLiveSpecification < Struct.new(
  :enabled,
  :attribute_name)
  include Aws::Structure
end

#enabledBoolean

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

Returns:

  • (Boolean)


4748
4749
4750
4751
4752
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4748

class TimeToLiveSpecification < Struct.new(
  :enabled,
  :attribute_name)
  include Aws::Structure
end