Skip to content
v2.278.0

RetrieverConfigurationProperty Struct ​

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

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';
const retrieverConfigurationProperty: qbusiness.CfnRetriever.RetrieverConfigurationProperty = {
  kendraIndexConfiguration: {
    indexId: 'indexId',
  },
  nativeIndexConfiguration: {
    indexId: 'indexId',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_qbusiness as qbusiness

retriever_configuration_property = qbusiness.CfnRetriever.RetrieverConfigurationProperty(
    kendra_index_configuration=qbusiness.CfnRetriever.KendraIndexConfigurationProperty(
        index_id="indexId"
    ),
    native_index_configuration=qbusiness.CfnRetriever.NativeIndexConfigurationProperty(
        index_id="indexId"
    )
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QBusiness;

var retrieverConfigurationProperty = new RetrieverConfigurationProperty {
    KendraIndexConfiguration = new KendraIndexConfigurationProperty {
        IndexId = "indexId"
    },
    NativeIndexConfiguration = new NativeIndexConfigurationProperty {
        IndexId = "indexId"
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

retrieverConfigurationProperty := &RetrieverConfigurationProperty{
	KendraIndexConfiguration: &KendraIndexConfigurationProperty{
		IndexId: jsii.String("indexId"),
	},
	NativeIndexConfiguration: &NativeIndexConfigurationProperty{
		IndexId: jsii.String("indexId"),
	},
}

Properties ​

kendraIndexConfigurationoptionalIResolvable | CfnRetriever.KendraIndexConfigurationPropertykendra_index_configurationoptionaltyping.Union[IResolvable, KendraIndexConfigurationProperty]kendraIndexConfigurationoptionalIResolvableKendraIndexConfigurationoptionalIResolvableKendraIndexConfigurationoptionalinterface{} #
Provides information on how the Amazon Kendra index used as a retriever for your Amazon Q Business application is configured.
nativeIndexConfigurationoptionalIResolvable | CfnRetriever.NativeIndexConfigurationPropertynative_index_configurationoptionaltyping.Union[IResolvable, NativeIndexConfigurationProperty]nativeIndexConfigurationoptionalIResolvableNativeIndexConfigurationoptionalIResolvableNativeIndexConfigurationoptionalinterface{} #
Provides information on how a Amazon Q Business index used as a retriever for your Amazon Q Business application is configured.