Package software.amazon.awscdk.services.qbusiness

Interface CfnRetriever.RetrieverConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRetriever.RetrieverConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnRetriever

@Stability(Stable)
public static interface CfnRetriever.RetrieverConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Provides information on how the retriever used for your Amazon Q Business application is configured.

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.*;
 RetrieverConfigurationProperty retrieverConfigurationProperty = RetrieverConfigurationProperty.builder()
         .kendraIndexConfiguration(KendraIndexConfigurationProperty.builder()
                 .indexId("indexId")
                 .build())
         .nativeIndexConfiguration(NativeIndexConfigurationProperty.builder()
                 .indexId("indexId")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRetriever.RetrieverConfigurationProperty.Builder	builder()
default Object	getKendraIndexConfiguration()	Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
default Object	getNativeIndexConfiguration()	Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKendraIndexConfiguration

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

Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.

Returns union: either IResolvable or CfnRetriever.KendraIndexConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverconfiguration.html#cfn-qbusiness-retriever-retrieverconfiguration-kendraindexconfiguration

getNativeIndexConfiguration

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

Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.

Returns union: either IResolvable or CfnRetriever.NativeIndexConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-retriever-retrieverconfiguration.html#cfn-qbusiness-retriever-retrieverconfiguration-nativeindexconfiguration

builder

@Stability(Stable)
static CfnRetriever.RetrieverConfigurationProperty.Builder builder()

Returns:

a CfnRetriever.RetrieverConfigurationProperty.Builder of CfnRetriever.RetrieverConfigurationProperty