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< ? tags, required Input<String, String> ?>String> type}) -
Creates a new DataSourceArgs.
configurationA block with the configuration information to connect to your Data Source repository. You can't specify theconfigurationblock when thetypeparameter is set toCUSTOM. Detailed below.customDocumentEnrichmentConfigurationA 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.descriptionA description for the Data Source connector.indexIdThe identifier of the index for your Amazon Kendra data source.languageCodeThe 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.nameA name for your data source connector.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.roleArnARN of a role with permission to access the data source connector. For more information, see IAM roles for Amazon Kendra. You can't specify theroleArnparameter when thetypeparameter is set toCUSTOM. TheroleArnparameter is required for all other data sources.scheduleSets 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 theStartDataSourceSyncJobAPI to update the index.tagsKey-value map of resource tags. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.typeThe 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
configurationblock when thetypeparameter is set toCUSTOM. 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
roleArnparameter when thetypeparameter is set toCUSTOM. TheroleArnparameter 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
StartDataSourceSyncJobAPI to update the index.final -
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration 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