You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Kendra::Types::UpdateDataSourceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::UpdateDataSourceRequest
- Defined in:
- (unknown)
Overview
Note:
When passing UpdateDataSourceRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
id: "DataSourceId", # required
name: "DataSourceName",
index_id: "IndexId", # required
configuration: {
s3_configuration: {
bucket_name: "S3BucketName", # required
inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
documents_metadata_configuration: {
s3_prefix: "S3ObjectKey",
},
access_control_list_configuration: {
key_path: "S3ObjectKey",
},
},
share_point_configuration: {
share_point_version: "SHAREPOINT_ONLINE", # required, accepts SHAREPOINT_ONLINE
urls: ["Url"], # required
secret_arn: "SecretArn", # required
crawl_attachments: false,
use_change_log: false,
inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
vpc_configuration: {
subnet_ids: ["SubnetId"], # required
security_group_ids: ["VpcSecurityGroupId"], # required
},
field_mappings: [
{
data_source_field_name: "DataSourceFieldName", # required
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName", # required
},
],
document_title_field_name: "DataSourceFieldName",
disable_local_groups: false,
},
database_configuration: {
database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
connection_configuration: { # required
database_host: "DatabaseHost", # required
database_port: 1, # required
database_name: "DatabaseName", # required
table_name: "TableName", # required
secret_arn: "SecretArn", # required
},
vpc_configuration: {
subnet_ids: ["SubnetId"], # required
security_group_ids: ["VpcSecurityGroupId"], # required
},
column_configuration: { # required
document_id_column_name: "ColumnName", # required
document_data_column_name: "ColumnName", # required
document_title_column_name: "ColumnName",
field_mappings: [
{
data_source_field_name: "DataSourceFieldName", # required
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName", # required
},
],
change_detecting_columns: ["ColumnName"], # required
},
acl_configuration: {
allowed_groups_column_name: "ColumnName", # required
},
sql_configuration: {
query_identifiers_enclosing_option: "DOUBLE_QUOTES", # accepts DOUBLE_QUOTES, NONE
},
},
salesforce_configuration: {
server_url: "Url", # required
secret_arn: "SecretArn", # required
standard_object_configurations: [
{
name: "ACCOUNT", # required, accepts ACCOUNT, CAMPAIGN, CASE, CONTACT, CONTRACT, DOCUMENT, GROUP, IDEA, LEAD, OPPORTUNITY, PARTNER, PRICEBOOK, PRODUCT, PROFILE, SOLUTION, TASK, USER
document_data_field_name: "DataSourceFieldName", # required
document_title_field_name: "DataSourceFieldName",
field_mappings: [
{
data_source_field_name: "DataSourceFieldName", # required
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName", # required
},
],
},
],
knowledge_article_configuration: {
included_states: ["DRAFT"], # required, accepts DRAFT, PUBLISHED, ARCHIVED
standard_knowledge_article_type_configuration: {
document_data_field_name: "DataSourceFieldName", # required
document_title_field_name: "DataSourceFieldName",
field_mappings: [
{
data_source_field_name: "DataSourceFieldName", # required
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName", # required
},
],
},
custom_knowledge_article_type_configurations: [
{
name: "SalesforceCustomKnowledgeArticleTypeName", # required
document_data_field_name: "DataSourceFieldName", # required
document_title_field_name: "DataSourceFieldName",
field_mappings: [
{
data_source_field_name: "DataSourceFieldName", # required
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName", # required
},
],
},
],
},
chatter_feed_configuration: {
document_data_field_name: "DataSourceFieldName", # required
document_title_field_name: "DataSourceFieldName",
field_mappings: [
{
data_source_field_name: "DataSourceFieldName", # required
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName", # required
},
],
include_filter_types: ["ACTIVE_USER"], # accepts ACTIVE_USER, STANDARD_USER
},
crawl_attachments: false,
standard_object_attachment_configuration: {
document_title_field_name: "DataSourceFieldName",
field_mappings: [
{
data_source_field_name: "DataSourceFieldName", # required
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName", # required
},
],
},
include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
},
one_drive_configuration: {
tenant_domain: "TenantDomain", # required
secret_arn: "SecretArn", # required
one_drive_users: { # required
one_drive_user_list: ["OneDriveUser"],
one_drive_user_s3_path: {
bucket: "S3BucketName", # required
key: "S3ObjectKey", # required
},
},
inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
field_mappings: [
{
data_source_field_name: "DataSourceFieldName", # required
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName", # required
},
],
disable_local_groups: false,
},
service_now_configuration: {
host_url: "ServiceNowHostUrl", # required
secret_arn: "SecretArn", # required
service_now_build_version: "LONDON", # required, accepts LONDON, OTHERS
knowledge_article_configuration: {
crawl_attachments: false,
include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
document_data_field_name: "DataSourceFieldName", # required
document_title_field_name: "DataSourceFieldName",
field_mappings: [
{
data_source_field_name: "DataSourceFieldName", # required
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName", # required
},
],
},
service_catalog_configuration: {
crawl_attachments: false,
include_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
exclude_attachment_file_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
document_data_field_name: "DataSourceFieldName", # required
document_title_field_name: "DataSourceFieldName",
field_mappings: [
{
data_source_field_name: "DataSourceFieldName", # required
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName", # required
},
],
},
},
confluence_configuration: {
server_url: "Url", # required
secret_arn: "SecretArn", # required
version: "CLOUD", # required, accepts CLOUD, SERVER
space_configuration: {
crawl_personal_spaces: false,
crawl_archived_spaces: false,
include_spaces: ["ConfluenceSpaceIdentifier"],
exclude_spaces: ["ConfluenceSpaceIdentifier"],
space_field_mappings: [
{
data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName",
},
],
},
page_configuration: {
page_field_mappings: [
{
data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName",
},
],
},
blog_configuration: {
blog_field_mappings: [
{
data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName",
},
],
},
attachment_configuration: {
crawl_attachments: false,
attachment_field_mappings: [
{
data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName",
},
],
},
vpc_configuration: {
subnet_ids: ["SubnetId"], # required
security_group_ids: ["VpcSecurityGroupId"], # required
},
inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
},
},
description: "Description",
schedule: "ScanSchedule",
role_arn: "RoleArn",
}
Instance Attribute Summary collapse
-
#configuration ⇒ Types::DataSourceConfiguration
Configuration information for a Amazon Kendra data source.
.
-
#description ⇒ String
The new description for the data source.
-
#id ⇒ String
The unique identifier of the data source to update.
-
#index_id ⇒ String
The identifier of the index that contains the data source to update.
-
#name ⇒ String
The name of the data source to update.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.
-
#schedule ⇒ String
The new update schedule for the data source.
Instance Attribute Details
#configuration ⇒ Types::DataSourceConfiguration
Configuration information for a Amazon Kendra data source.
#description ⇒ String
The new description for the data source.
#id ⇒ String
The unique identifier of the data source to update.
#index_id ⇒ String
The identifier of the index that contains the data source to update.
#name ⇒ String
The name of the data source to update. The name of the data source can\'t be updated. To rename a data source you must delete the data source and re-create it.
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.
#schedule ⇒ String
The new update schedule for the data source.