Interface CfnIndexProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnIndexProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-12T12:32:06.760Z")
@Stability(Stable)
public interface CfnIndexProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnIndex
.
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.qbusiness.*; CfnIndexProps cfnIndexProps = CfnIndexProps.builder() .applicationId("applicationId") .displayName("displayName") // the properties below are optional .capacityConfiguration(IndexCapacityConfigurationProperty.builder() .units(123) .build()) .description("description") .documentAttributeConfigurations(List.of(DocumentAttributeConfigurationProperty.builder() .name("name") .search("search") .type("type") .build())) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .type("type") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnIndexProps
static final class
An implementation forCfnIndexProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnIndexProps.Builder
builder()
The identifier of the Amazon Q Business application using the index.default Object
The capacity units you want to provision for your index.default String
A description for the Amazon Q Business index.The name of the index.default Object
Configuration information for document attributes.getTags()
A list of key-value pairs that identify or categorize the index.default String
getType()
The index type that's suitable for your needs.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApplicationId
The identifier of the Amazon Q Business application using the index.- See Also:
-
getDisplayName
The name of the index.- See Also:
-
getCapacityConfiguration
The capacity units you want to provision for your index.You can add and remove capacity to fit your usage needs.
- See Also:
-
getDescription
A description for the Amazon Q Business index.- See Also:
-
getDocumentAttributeConfigurations
Configuration information for document attributes.Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.
For more information, see Understanding document attributes .
- See Also:
-
getTags
A list of key-value pairs that identify or categorize the index.You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -
- See Also:
-
getType
The index type that's suitable for your needs.For more information on what's included in each type of index, see Amazon Q Business tiers .
- See Also:
-
builder
- Returns:
- a
CfnIndexProps.Builder
ofCfnIndexProps
-