Class: AWSCDK::DynamoDB::Capacity

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

Overview

Represents the amount of read and write operations supported by a DynamoDB table.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Capacity

Returns a new instance of Capacity.

Raises:

  • (NoMethodError)


8
9
10
# File 'dynamo_db/capacity.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_dynamodb.Capacity does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.autoscaled(options) ⇒ AWSCDK::DynamoDB::Capacity

Dynamically adjusts provisioned throughput capacity on your behalf in response to actual traffic patterns.

Parameters:

Returns:

  • (AWSCDK::DynamoDB::Capacity)


22
23
24
25
26
# File 'dynamo_db/capacity.rb', line 22

def self.autoscaled(options)
  options = options.is_a?(Hash) ? ::AWSCDK::DynamoDB::AutoscaledCapacityOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZHluYW1vZGIuQXV0b3NjYWxlZENhcGFjaXR5T3B0aW9ucyJ9")), "options")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dynamodb.Capacity", "autoscaled", [options])
end

.fixed(iops) ⇒ AWSCDK::DynamoDB::Capacity

Provisioned throughput capacity is configured with fixed capacity units.

Note: You cannot configure write capacity using fixed capacity mode.

Parameters:

  • iops (Numeric)

    the number of I/O operations per second.

Returns:

  • (AWSCDK::DynamoDB::Capacity)


34
35
36
37
# File 'dynamo_db/capacity.rb', line 34

def self.fixed(iops)
  Jsii::Type.check_type(iops, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "iops")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dynamodb.Capacity", "fixed", [iops])
end

.jsii_overridable_methodsObject



12
13
14
15
16
# File 'dynamo_db/capacity.rb', line 12

def self.jsii_overridable_methods
  {
    :mode => { kind: :property, name: "mode", is_optional: false },
  }
end

Instance Method Details

#modeAWSCDK::DynamoDB::CapacityMode



40
41
42
# File 'dynamo_db/capacity.rb', line 40

def mode()
  jsii_get_property("mode")
end