RetrieverArgs

data class RetrieverArgs(val applicationId: Output<String>? = null, val configuration: Output<Either<RetrieverConfiguration0PropertiesArgs, RetrieverConfiguration1PropertiesArgs>>? = null, val displayName: Output<String>? = null, val roleArn: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val type: Output<RetrieverType>? = null) : ConvertibleToJava<RetrieverArgs>

Definition of AWS::QBusiness::Retriever Resource Type

Constructors

Link copied to clipboard
constructor(applicationId: Output<String>? = null, configuration: Output<Either<RetrieverConfiguration0PropertiesArgs, RetrieverConfiguration1PropertiesArgs>>? = null, displayName: Output<String>? = null, roleArn: Output<String>? = null, tags: Output<List<TagArgs>>? = null, type: Output<RetrieverType>? = null)

Properties

Link copied to clipboard
val applicationId: Output<String>? = null

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

Link copied to clipboard

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

Link copied to clipboard
val displayName: Output<String>? = null

The name of your retriever.

Link copied to clipboard
val roleArn: Output<String>? = null

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

Link copied to clipboard
val tags: Output<List<TagArgs>>? = null

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

Link copied to clipboard
val type: Output<RetrieverType>? = null

The type of your retriever.

Functions

Link copied to clipboard
open override fun toJava(): RetrieverArgs