DataSourceArgs class

The set of arguments for DataSource. The set of arguments for DataSource.

Constructors

DataSourceArgs({Input<DataSourceConfiguration?>? configuration, Input<DataSourceCustomDocumentEnrichmentConfiguration?>? customDocumentEnrichmentConfiguration, Input<String?>? description, required Input<String> indexId, Input<String?>? languageCode, Input<String?>? name, Input<String?>? region, Input<String?>? roleArn, Input<String?>? schedule, Input<Map<String, String>?>? tags, required Input<String> type})
Creates a new DataSourceArgs. configuration A block with the configuration information to connect to your Data Source repository. You can't specify the configuration block when the type parameter is set to CUSTOM. Detailed below. customDocumentEnrichmentConfiguration A block with the configuration information for altering document metadata and content during the document ingestion process. For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process. Detailed below. description A description for the Data Source connector. indexId The identifier of the index for your Amazon Kendra data source. languageCode The code for a language. This allows you to support a language for all documents when creating the Data Source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English. name A name for your data source connector. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. roleArn ARN of a role with permission to access the data source connector. For more information, see IAM roles for Amazon Kendra. You can't specify the roleArn parameter when the type parameter is set to CUSTOM. The roleArn parameter is required for all other data sources. schedule Sets the frequency for Amazon Kendra to check the documents in your Data Source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index. tags Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. type The type of data source repository. For an updated list of values, refer to Valid Values for Type.
const
DataSourceArgs.fromMap(Map<String, dynamic> map)
factory

Properties

configuration → Input<DataSourceConfiguration?>?
A block with the configuration information to connect to your Data Source repository. You can't specify the configuration block when the type parameter is set to CUSTOM. Detailed below.
final
customDocumentEnrichmentConfiguration → Input<DataSourceCustomDocumentEnrichmentConfiguration?>?
A block with the configuration information for altering document metadata and content during the document ingestion process. For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process. Detailed below.
final
description → Input<String?>?
A description for the Data Source connector.
final
hashCode → int
The hash code for this object.
no setterinherited
indexId → Input<String>
The identifier of the index for your Amazon Kendra data source.
final
languageCode → Input<String?>?
The code for a language. This allows you to support a language for all documents when creating the Data Source connector. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.
final
name → Input<String?>?
A name for your data source connector.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
roleArn → Input<String?>?
ARN of a role with permission to access the data source connector. For more information, see IAM roles for Amazon Kendra. You can't specify the roleArn parameter when the type parameter is set to CUSTOM. The roleArn parameter is required for all other data sources.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schedule → Input<String?>?
Sets the frequency for Amazon Kendra to check the documents in your Data Source repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob API to update the index.
final
tags → Input<Map<String, String>?>?
Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
type → Input<String>
The type of data source repository. For an updated list of values, refer to Valid Values for Type.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited