Package software.amazon.awscdk.services.kendra

Interface CfnIndex.CapacityUnitsConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndex.CapacityUnitsConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnIndex

@Stability(Stable)
public static interface CfnIndex.CapacityUnitsConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies additional capacity units configured for your Enterprise Edition index.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendra.*;
 CapacityUnitsConfigurationProperty capacityUnitsConfigurationProperty = CapacityUnitsConfigurationProperty.builder()
         .queryCapacityUnits(123)
         .storageCapacityUnits(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnIndex.CapacityUnitsConfigurationProperty.Builder	A builder for CfnIndex.CapacityUnitsConfigurationProperty
static final class	CfnIndex.CapacityUnitsConfigurationProperty.Jsii$Proxy	An implementation for CfnIndex.CapacityUnitsConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnIndex.CapacityUnitsConfigurationProperty.Builder	builder()
Number	getQueryCapacityUnits()	The amount of extra query capacity for an index and GetQuerySuggestions capacity.
Number	getStorageCapacityUnits()	The amount of extra storage capacity for an index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getQueryCapacityUnits

@Stability(Stable)
@NotNull
Number getQueryCapacityUnits()

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).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html#cfn-kendra-index-capacityunitsconfiguration-querycapacityunits

getStorageCapacityUnits

@Stability(Stable)
@NotNull
Number getStorageCapacityUnits()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-index-capacityunitsconfiguration.html#cfn-kendra-index-capacityunitsconfiguration-storagecapacityunits

builder

@Stability(Stable)
static CfnIndex.CapacityUnitsConfigurationProperty.Builder builder()

Returns:

a CfnIndex.CapacityUnitsConfigurationProperty.Builder of CfnIndex.CapacityUnitsConfigurationProperty