AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::QBusiness::Retriever

CfnRetriever

Adds a retriever to your Amazon Q Business application.

Import

import { CfnRetriever } from 'aws-cdk-lib/aws-qbusiness';

Or use the module namespace:

import * as qbusiness from 'aws-cdk-lib/aws-qbusiness';
// qbusiness.CfnRetriever

Properties

Configuration passed to the constructor as CfnRetrieverProps.

applicationIdRequired
string

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

configurationRequired
IResolvable | RetrieverConfigurationProperty

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

displayNameRequired
string

The name of your retriever.

typeRequired
string

The type of your retriever.

roleArnOptional
string

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

tagsOptional
CfnTag[]

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: _ . : / = + -

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::QBusiness::RetrieverView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-qbusiness
CFN TypeAWS::QBusiness::Retriever
Properties6

Related Constructs

Explore This Service

External Links