Class: Aws::Kendra::Types::CreateDataSourceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::CreateDataSourceRequest
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_token ⇒ String
A token that you provide to identify the request to create a data source connector.
-
#configuration ⇒ Types::DataSourceConfiguration
Configuration information to connect to your data source repository.
-
#custom_document_enrichment_configuration ⇒ Types::CustomDocumentEnrichmentConfiguration
Configuration information for altering document metadata and content during the document ingestion process.
-
#description ⇒ String
A description for the data source connector.
-
#index_id ⇒ String
The identifier of the index you want to use with the data source connector.
-
#language_code ⇒ String
The code for a language.
-
#name ⇒ String
A name for the data source connector.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
-
#schedule ⇒ String
Sets the frequency for Amazon Kendra to check the documents in your data source repository and update the index.
-
#tags ⇒ Array<Types::Tag>
A list of key-value pairs that identify or categorize the data source connector.
-
#type ⇒ String
The type of data source repository.
-
#vpc_configuration ⇒ Types::DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your data source.
Instance Attribute Details
#client_token ⇒ String
A token that you provide to identify the request to create a data
source connector. Multiple calls to the CreateDataSource
API with
the same client token will create only one data source connector.
A suitable default value is auto-generated. You should normally not need to pass this option.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#configuration ⇒ Types::DataSourceConfiguration
Configuration information to connect to your data source repository.
You can't specify the Configuration
parameter when the Type
parameter is set to CUSTOM
. If you do, you receive a
ValidationException
exception.
The Configuration
parameter is required for all other data
sources.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#custom_document_enrichment_configuration ⇒ Types::CustomDocumentEnrichmentConfiguration
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.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description for the data source connector.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#index_id ⇒ String
The identifier of the index you want to use with the data source connector.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#language_code ⇒ 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.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A name for the data source connector.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. For more information, see IAM access roles for Amazon Kendra..
You can't specify the RoleArn
parameter when the Type
parameter
is set to CUSTOM
. If you do, you receive a ValidationException
exception.
The RoleArn
parameter is required for all other data sources.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#schedule ⇒ 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.
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.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
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: _ . : / = + - @.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The type of data source repository. For example, SHAREPOINT
.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |
#vpc_configuration ⇒ Types::DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your data source. For more information, see Configuring a VPC.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2070 class CreateDataSourceRequest < Struct.new( :name, :index_id, :type, :configuration, :vpc_configuration, :description, :schedule, :role_arn, :tags, :client_token, :language_code, :custom_document_enrichment_configuration) SENSITIVE = [] include Aws::Structure end |