Class: AWSCDK::DynamoDB::CfnGlobalTable::ReadProvisionedThroughputSettingsProperty

Inherits:

Jsii::Struct

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

Defined in:

dynamo_db/cfn_global_table.rb

Overview

Allows you to specify the read capacity settings for a replica table or a replica global secondary index when the BillingMode is set to PROVISIONED .

You must specify a value for either ReadCapacityUnits or ReadCapacityAutoScalingSettings , but not both. You can switch between fixed capacity and auto scaling.

See Also:

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

Instance Attribute Summary

• #read_capacity_auto_scaling_settings ⇒ AWSCDK::IResolvable, ... readonly

  Specifies auto scaling settings for the replica table or global secondary index.

• #read_capacity_units ⇒ Numeric^? readonly

  Specifies a fixed read capacity for the replica table or global secondary index.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(read_capacity_auto_scaling_settings: nil, read_capacity_units: nil) ⇒ ReadProvisionedThroughputSettingsProperty constructor

  A new instance of ReadProvisionedThroughputSettingsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(read_capacity_auto_scaling_settings: nil, read_capacity_units: nil) ⇒ ReadProvisionedThroughputSettingsProperty

Returns a new instance of ReadProvisionedThroughputSettingsProperty.

Parameters:

• read_capacity_auto_scaling_settings (AWSCDK::IResolvable, AWSCDK::DynamoDB::CfnGlobalTable::CapacityAutoScalingSettingsProperty, nil) (defaults to: nil) —

  Specifies auto scaling settings for the replica table or global secondary index.

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

  Specifies a fixed read capacity for the replica table or global secondary index.

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

def initialize(read_capacity_auto_scaling_settings: nil, read_capacity_units: nil)
  @read_capacity_auto_scaling_settings = read_capacity_auto_scaling_settings.is_a?(Hash) ? ::AWSCDK::DynamoDB::CfnGlobalTable::CapacityAutoScalingSettingsProperty.new(**read_capacity_auto_scaling_settings.transform_keys(&:to_sym)) : read_capacity_auto_scaling_settings
  Jsii::Type.check_type(@read_capacity_auto_scaling_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19keW5hbW9kYi5DZm5HbG9iYWxUYWJsZS5DYXBhY2l0eUF1dG9TY2FsaW5nU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "readCapacityAutoScalingSettings") unless @read_capacity_auto_scaling_settings.nil?
  @read_capacity_units = read_capacity_units
  Jsii::Type.check_type(@read_capacity_units, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "readCapacityUnits") unless @read_capacity_units.nil?
end

Instance Attribute Details

#read_capacity_auto_scaling_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Specifies auto scaling settings for the replica table or global secondary index.

Returns:

• (AWSCDK::IResolvable, AWSCDK::DynamoDB::CfnGlobalTable::CapacityAutoScalingSettingsProperty, nil)

See Also:

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

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

def read_capacity_auto_scaling_settings
  @read_capacity_auto_scaling_settings
end

#read_capacity_units ⇒ Numeric^? (readonly)

Specifies a fixed read capacity for the replica table or global secondary index.

Returns:

• (Numeric, nil)

See Also:

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

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

def read_capacity_units
  @read_capacity_units
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :read_capacity_auto_scaling_settings => "readCapacityAutoScalingSettings",
    :read_capacity_units => "readCapacityUnits",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "readCapacityAutoScalingSettings" => @read_capacity_auto_scaling_settings,
    "readCapacityUnits" => @read_capacity_units,
  })
  result.compact
end