DataSourceState class
Input properties used for looking up and filtering DataSource resources.
Constructors
-
DataSourceState({Input<
String?> ? arn, Input<DataSourceConfiguration?> ? configuration, Input<String?> ? createdAt, Input<DataSourceCustomDocumentEnrichmentConfiguration?> ? customDocumentEnrichmentConfiguration, Input<String?> ? dataSourceId, Input<String?> ? description, Input<String?> ? errorMessage, Input<String?> ? indexId, Input<String?> ? languageCode, Input<String?> ? name, Input<String?> ? region, Input<String?> ? roleArn, Input<String?> ? schedule, Input<String?> ? status, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? type, Input<String?> ? updatedAt}) -
Creates a new DataSourceState.
arnARN of the Data Source.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.createdAtThe Unix time stamp of when the Data Source was created.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.dataSourceIdThe unique identifiers of the Data Source.descriptionA description for the Data Source connector.errorMessageWhen the Status field value isFAILED, contains a description of the error that caused the Data Source to fail.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.statusThe current status of the Data Source. When the status isACTIVEthe Data Source is ready to use. When the status isFAILED, theerrorMessagefield contains the reason that the Data Source failed.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.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.typeThe type of data source repository. For an updated list of values, refer to Valid Values for Type.updatedAtThe Unix time stamp of when the Data Source was last updated.const -
DataSourceState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN of the Data Source.
final
-
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 -
createdAt
→ Input<
String?> ? -
The Unix time stamp of when the Data Source was created.
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
-
dataSourceId
→ Input<
String?> ? -
The unique identifiers of the Data Source.
final
-
description
→ Input<
String?> ? -
A description for the Data Source connector.
final
-
errorMessage
→ Input<
String?> ? -
When the Status field value is
FAILED, contains a description of the error that caused the Data Source to fail.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 -
status
→ Input<
String?> ? -
The current status of the Data Source. When the status is
ACTIVEthe Data Source is ready to use. When the status isFAILED, theerrorMessagefield contains the reason that the Data Source failed.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 -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
type
→ Input<
String?> ? -
The type of data source repository. For an updated list of values, refer to Valid Values for Type.
final
-
updatedAt
→ Input<
String?> ? -
The Unix time stamp of when the Data Source was last updated.
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