DataSourceArgs

data class DataSourceArgs(val applicationId: Output<String>? = null, val configuration: Output<Any>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val documentEnrichmentConfiguration: Output<DataSourceDocumentEnrichmentConfigurationArgs>? = null, val indexId: Output<String>? = null, val roleArn: Output<String>? = null, val syncSchedule: Output<String>? = null, val tags: Output<List<TagArgs>>? = null, val vpcConfiguration: Output<DataSourceVpcConfigurationArgs>? = null) : ConvertibleToJava<DataSourceArgs>

Definition of AWS::QBusiness::DataSource Resource Type

Constructors

Link copied to clipboard
constructor(applicationId: Output<String>? = null, configuration: Output<Any>? = null, description: Output<String>? = null, displayName: Output<String>? = null, documentEnrichmentConfiguration: Output<DataSourceDocumentEnrichmentConfigurationArgs>? = null, indexId: Output<String>? = null, roleArn: Output<String>? = null, syncSchedule: Output<String>? = null, tags: Output<List<TagArgs>>? = null, vpcConfiguration: Output<DataSourceVpcConfigurationArgs>? = null)

Properties

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

The identifier of the Amazon Q Business application the data source will be attached to.

Link copied to clipboard
val configuration: Output<Any>? = null

Use this property to specify a JSON or YAML schema with configuration information specific to your data source connector to connect your data source repository to Amazon Q Business . You must use the JSON or YAML schema provided by Amazon Q . You can find configuration templates for your specific data source using the following steps:

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

A description for the data source connector.

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

The name of the Amazon Q Business data source.

Link copied to clipboard

Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment .

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

The identifier of the index the data source is attached to.

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

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

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

Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index. Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM . If you do, you receive a ValidationException exception.

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

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Link copied to clipboard

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .

Functions

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