Package software.amazon.awscdk.services.qbusiness

Interface CfnIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:20.469Z")
@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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIndexProps.Builder	builder()
String	getApplicationId()	The identifier of the Amazon Q Business application using the index.
default Object	getCapacityConfiguration()	The capacity units you want to provision for your index.
default String	getDescription()	A description for the Amazon Q Business index.
String	getDisplayName()	The name of the index.
default Object	getDocumentAttributeConfigurations()	Configuration information for document attributes.
default List<CfnTag>	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

@Stability(Stable)
@NotNull
String getApplicationId()

The identifier of the Amazon Q Business application using the index.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-applicationid

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

The name of the index.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-displayname

getCapacityConfiguration

@Stability(Stable)
@Nullable
default Object getCapacityConfiguration()

The capacity units you want to provision for your index.

You can add and remove capacity to fit your usage needs.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-capacityconfiguration

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the Amazon Q Business index.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-description

getDocumentAttributeConfigurations

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-documentattributeconfigurations

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-tags

getType

@Stability(Stable)
@Nullable
default String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-index.html#cfn-qbusiness-index-type

builder

@Stability(Stable)
static CfnIndexProps.Builder builder()

Returns:

a CfnIndexProps.Builder of CfnIndexProps