Class: AWSCDK::Kendra::CfnIndex::CapacityUnitsConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kendra/cfn_index.rb

Overview

Specifies additional capacity units configured for your Enterprise Edition index.

You can add and remove capacity units to fit your usage requirements.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(query_capacity_units:, storage_capacity_units:) ⇒ CapacityUnitsConfigurationProperty

Returns a new instance of CapacityUnitsConfigurationProperty.

Parameters:

  • query_capacity_units (Numeric) —

    The amount of extra query capacity for an index and GetQuerySuggestions capacity.

  • storage_capacity_units (Numeric) —

    The amount of extra storage capacity for an index.



679
680
681
682
683
684
 
# File 'kendra/cfn_index.rb', line 679

def initialize(query_capacity_units:, storage_capacity_units:)
  @query_capacity_units = query_capacity_units
  Jsii::Type.check_type(@query_capacity_units, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "queryCapacityUnits")
  @storage_capacity_units = storage_capacity_units
  Jsii::Type.check_type(@storage_capacity_units, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "storageCapacityUnits")
end

Instance Attribute Details

#query_capacity_units ⇒ Numeric (readonly)

The amount of extra query capacity for an index and GetQuerySuggestions capacity.

A single extra capacity unit for an index provides 0.1 queries per second or approximately 8,000 queries per day. You can add up to 100 extra capacity units.

GetQuerySuggestions capacity is five times the provisioned query capacity for an index, or the base capacity of 2.5 calls per second, whichever is higher. For example, the base capacity for an index is 0.1 queries per second, and GetQuerySuggestions capacity has a base of 2.5 calls per second. If you add another 0.1 queries per second to total 0.2 queries per second for an index, the GetQuerySuggestions capacity is 2.5 calls per second (higher than five times 0.2 queries per second).

Returns:

  • (Numeric)

See Also:



694
695
696
 
# File 'kendra/cfn_index.rb', line 694

def query_capacity_units
  @query_capacity_units
end

#storage_capacity_units ⇒ Numeric (readonly)

The amount of extra storage capacity for an index.

A single capacity unit provides 30 GB of storage space or 100,000 documents, whichever is reached first. You can add up to 100 extra capacity units.

Returns:

  • (Numeric)

See Also:



701
702
703
 
# File 'kendra/cfn_index.rb', line 701

def storage_capacity_units
  @storage_capacity_units
end

Class Method Details

.jsii_properties ⇒ Object 



703
704
705
706
707
708
 
# File 'kendra/cfn_index.rb', line 703

def self.jsii_properties
  {
    :query_capacity_units => "queryCapacityUnits",
    :storage_capacity_units => "storageCapacityUnits",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



710
711
712
713
714
715
716
717
 
# File 'kendra/cfn_index.rb', line 710

def to_jsii
  result = {}
  result.merge!({
    "queryCapacityUnits" => @query_capacity_units,
    "storageCapacityUnits" => @storage_capacity_units,
  })
  result.compact
end