Class: AWSCDK::DynamoDB::MaxThroughputProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
dynamo_db/max_throughput_props.rb

Overview

Properties used to configure maximum throughput for an on-demand table.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(max_read_request_units: nil, max_write_request_units: nil) ⇒ MaxThroughputProps

Returns a new instance of MaxThroughputProps.

Parameters:

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

    The max read request units.

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

    The max write request units.



9
10
11
12
13
14
 
# File 'dynamo_db/max_throughput_props.rb', line 9

def initialize(max_read_request_units: nil, max_write_request_units: nil)
  @max_read_request_units = max_read_request_units
  Jsii::Type.check_type(@max_read_request_units, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxReadRequestUnits") unless @max_read_request_units.nil?
  @max_write_request_units = max_write_request_units
  Jsii::Type.check_type(@max_write_request_units, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxWriteRequestUnits") unless @max_write_request_units.nil?
end

Instance Attribute Details

#max_read_request_units ⇒ Numeric? (readonly)

Note:

Default: - if table mode is on-demand and this property is undefined, no maximum throughput limit will be put in place for read requests. This property is only applicable for tables using on-demand mode.

The max read request units.

Returns:

  • (Numeric, nil) 


20
21
22
 
# File 'dynamo_db/max_throughput_props.rb', line 20

def max_read_request_units
  @max_read_request_units
end

#max_write_request_units ⇒ Numeric? (readonly)

Note:

Default: - if table mode is on-demand and this property is undefined, no maximum throughput limit will be put in place for write requests. This property is only applicable for tables using on-demand mode.

The max write request units.

Returns:

  • (Numeric, nil) 


25
26
27
 
# File 'dynamo_db/max_throughput_props.rb', line 25

def max_write_request_units
  @max_write_request_units
end

Class Method Details

.jsii_properties ⇒ Object 



27
28
29
30
31
32
 
# File 'dynamo_db/max_throughput_props.rb', line 27

def self.jsii_properties
  {
    :max_read_request_units => "maxReadRequestUnits",
    :max_write_request_units => "maxWriteRequestUnits",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'dynamo_db/max_throughput_props.rb', line 34

def to_jsii
  result = {}
  result.merge!({
    "maxReadRequestUnits" => @max_read_request_units,
    "maxWriteRequestUnits" => @max_write_request_units,
  })
  result.compact
end