Class: AWSCDK::DynamoDB::CfnGlobalTable::WarmThroughputProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::DynamoDB::CfnGlobalTable::WarmThroughputProperty

Defined in:

dynamo_db/cfn_global_table.rb

Overview

Provides visibility into the number of read and write operations your table or secondary index can instantaneously support.

The settings can be modified using the UpdateTable operation to meet the throughput requirements of an upcoming peak event.

See Also:

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

Instance Attribute Summary

• #read_units_per_second ⇒ Numeric^? readonly

  Represents the number of read operations your base table can instantaneously support.

• #write_units_per_second ⇒ Numeric^? readonly

  Represents the number of write operations your base table can instantaneously support.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(read_units_per_second: nil, write_units_per_second: nil) ⇒ WarmThroughputProperty constructor

  A new instance of WarmThroughputProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(read_units_per_second: nil, write_units_per_second: nil) ⇒ WarmThroughputProperty

Returns a new instance of WarmThroughputProperty.

Parameters:

• read_units_per_second (Numeric, nil) (defaults to: nil) —

  Represents the number of read operations your base table can instantaneously support.

• write_units_per_second (Numeric, nil) (defaults to: nil) —

  Represents the number of write operations your base table can instantaneously support.

# File 'dynamo_db/cfn_global_table.rb', line 2071

def initialize(read_units_per_second: nil, write_units_per_second: nil)
  @read_units_per_second = read_units_per_second
  Jsii::Type.check_type(@read_units_per_second, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "readUnitsPerSecond") unless @read_units_per_second.nil?
  @write_units_per_second = write_units_per_second
  Jsii::Type.check_type(@write_units_per_second, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "writeUnitsPerSecond") unless @write_units_per_second.nil?
end

Instance Attribute Details

#read_units_per_second ⇒ Numeric^? (readonly)

Represents the number of read operations your base table can instantaneously support.

Returns:

• (Numeric, nil)

See Also:

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

# File 'dynamo_db/cfn_global_table.rb', line 2082

def read_units_per_second
  @read_units_per_second
end

#write_units_per_second ⇒ Numeric^? (readonly)

Represents the number of write operations your base table can instantaneously support.

Returns:

• (Numeric, nil)

See Also:

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

# File 'dynamo_db/cfn_global_table.rb', line 2087

def write_units_per_second
  @write_units_per_second
end

Class Method Details

.jsii_properties ⇒ Object

# File 'dynamo_db/cfn_global_table.rb', line 2089

def self.jsii_properties
  {
    :read_units_per_second => "readUnitsPerSecond",
    :write_units_per_second => "writeUnitsPerSecond",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'dynamo_db/cfn_global_table.rb', line 2096

def to_jsii
  result = {}
  result.merge!({
    "readUnitsPerSecond" => @read_units_per_second,
    "writeUnitsPerSecond" => @write_units_per_second,
  })
  result.compact
end