2.233.0

interface CfnRetrieverMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.QBusiness.Mixins.CfnRetrieverMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsqbusiness/mixins#CfnRetrieverMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.qbusiness.mixins.CfnRetrieverMixinProps
Pythonaws_cdk.mixins_preview.aws_qbusiness.mixins.CfnRetrieverMixinProps
TypeScript @aws-cdk/mixins-preview » aws_qbusiness » mixins » CfnRetrieverMixinProps

Properties for CfnRetrieverPropsMixin.

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 { mixins as qbusiness_mixins } from '@aws-cdk/mixins-preview/aws-qbusiness';
const cfnRetrieverMixinProps: qbusiness_mixins.CfnRetrieverMixinProps = {
  applicationId: 'applicationId',
  configuration: {
    kendraIndexConfiguration: {
      indexId: 'indexId',
    },
    nativeIndexConfiguration: {
      indexId: 'indexId',
    },
  },
  displayName: 'displayName',
  roleArn: 'roleArn',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
};

Properties

NameTypeDescription
applicationId?stringThe identifier of the Amazon Q Business application using the retriever.
configuration?IResolvable | RetrieverConfigurationPropertyProvides information on how the retriever used for your Amazon Q Business application is configured.
displayName?stringThe name of your retriever.
roleArn?stringThe ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
tags?CfnTag[]A list of key-value pairs that identify or categorize the retriever.
type?stringThe type of your retriever.

applicationId?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-applicationid

configuration?

Type: IResolvable | RetrieverConfigurationProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-configuration

displayName?

Type: string (optional)

The name of your retriever.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-displayname

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-rolearn

tags?

Type: CfnTag[] (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: _ . : / = + -

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-tags

type?

Type: string (optional)

The type of your retriever.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html#cfn-qbusiness-retriever-type

← PreviousNext →