Class: AWSCDK::DynamoDB::CfnTable::TimeToLiveSpecificationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::DynamoDB::CfnTable::TimeToLiveSpecificationProperty

Defined in:

dynamo_db/cfn_table.rb

Overview

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

See Also:

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

Instance Attribute Summary

• #attribute_name ⇒ String^? readonly

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

• #enabled ⇒ Boolean, AWSCDK::IResolvable readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(enabled:, attribute_name: nil) ⇒ TimeToLiveSpecificationProperty constructor

  A new instance of TimeToLiveSpecificationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(enabled:, attribute_name: nil) ⇒ TimeToLiveSpecificationProperty

Returns a new instance of TimeToLiveSpecificationProperty.

Parameters:

• enabled (Boolean, AWSCDK::IResolvable) —

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

• attribute_name (String, nil) (defaults to: nil) —

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

# File 'dynamo_db/cfn_table.rb', line 1755

def initialize(enabled:, attribute_name: nil)
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled")
  @attribute_name = attribute_name
  Jsii::Type.check_type(@attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName") unless @attribute_name.nil?
end

Instance Attribute Details

#attribute_name ⇒ String^? (readonly)

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.

Returns:

• (String, nil)

See Also:

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

# File 'dynamo_db/cfn_table.rb', line 1774

def attribute_name
  @attribute_name
end

#enabled ⇒ Boolean, AWSCDK::IResolvable (readonly)

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

Returns:

• (Boolean, AWSCDK::IResolvable)

See Also:

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

# File 'dynamo_db/cfn_table.rb', line 1766

def enabled
  @enabled
end

Class Method Details

.jsii_properties ⇒ Object

# File 'dynamo_db/cfn_table.rb', line 1776

def self.jsii_properties
  {
    :enabled => "enabled",
    :attribute_name => "attributeName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'dynamo_db/cfn_table.rb', line 1783

def to_jsii
  result = {}
  result.merge!({
    "enabled" => @enabled,
    "attributeName" => @attribute_name,
  })
  result.compact
end