interface CfnRetrieverProps
Language | Type name |
---|---|
![]() | Amazon.CDK.aws_qbusiness.CfnRetrieverProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnRetrieverProps |
![]() | software.amazon.awscdk.services.qbusiness.CfnRetrieverProps |
![]() | aws_cdk.aws_qbusiness.CfnRetrieverProps |
![]() | aws-cdk-lib » aws_qbusiness » CfnRetrieverProps |
Properties for defining a CfnRetriever
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html
Example
// 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 cfnRetrieverProps: qbusiness.CfnRetrieverProps = {
applicationId: 'applicationId',
configuration: {
kendraIndexConfiguration: {
indexId: 'indexId',
},
nativeIndexConfiguration: {
indexId: 'indexId',
},
},
displayName: 'displayName',
type: 'type',
// the properties below are optional
roleArn: 'roleArn',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
application | string | The identifier of the Amazon Q Business application using the retriever. |
configuration | IResolvable | Retriever | Provides information on how the retriever used for your Amazon Q Business application is configured. |
display | string | The name of your retriever. |
type | string | The type of your retriever. |
role | string | The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret. |
tags? | Cfn [] | A list of key-value pairs that identify or categorize the retriever. |
applicationId
Type:
string
The identifier of the Amazon Q Business application using the retriever.
configuration
Type:
IResolvable
|
Retriever
Provides information on how the retriever used for your Amazon Q Business application is configured.
displayName
Type:
string
The name of your retriever.
type
Type:
string
The type of your retriever.
roleArn?
Type:
string
(optional)
The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
tags?
Type:
Cfn
[]
(optional)
A list of key-value pairs that identify or categorize the retriever.
You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + -