Class: Aws::Kendra::Types::UpdateDataSourceRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::UpdateDataSourceRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #configuration ⇒ Types::DataSourceConfiguration

  Configuration information you want to update for the data source connector.

• #custom_document_enrichment_configuration ⇒ Types::CustomDocumentEnrichmentConfiguration

  Configuration information you want to update for altering document metadata and content during the document ingestion process.

• #description ⇒ String

  A new description for the data source connector.

• #id ⇒ String

  The identifier of the data source connector you want to update.

• #index_id ⇒ String

  The identifier of the index used with the data source connector.

• #language_code ⇒ String

  The code for a language you want to update for the data source connector.

• #name ⇒ String

  A new name for the data source connector.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources.

• #schedule ⇒ String

  The sync schedule you want to update for the data source connector.

• #vpc_configuration ⇒ Types::DataSourceVpcConfiguration

  Configuration information for an Amazon Virtual Private Cloud to connect to your data source.

Instance Attribute Details

#configuration ⇒ Types::DataSourceConfiguration

Configuration information you want to update for the data source connector.

Returns:

• (Types::DataSourceConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 10558

class UpdateDataSourceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :configuration,
  :vpc_configuration,
  :description,
  :schedule,
  :role_arn,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#custom_document_enrichment_configuration ⇒ Types::CustomDocumentEnrichmentConfiguration

Configuration information you want to update 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].

[1]: docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html

Returns:

• (Types::CustomDocumentEnrichmentConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 10558

class UpdateDataSourceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :configuration,
  :vpc_configuration,
  :description,
  :schedule,
  :role_arn,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A new description for the data source connector.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10558

class UpdateDataSourceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :configuration,
  :vpc_configuration,
  :description,
  :schedule,
  :role_arn,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier of the data source connector you want to update.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10558

class UpdateDataSourceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :configuration,
  :vpc_configuration,
  :description,
  :schedule,
  :role_arn,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index used with the data source connector.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10558

class UpdateDataSourceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :configuration,
  :vpc_configuration,
  :description,
  :schedule,
  :role_arn,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The code for a language you want to update for the data source connector. This allows you to support a language for all documents when updating the data source. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English].

[1]: docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10558

class UpdateDataSourceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :configuration,
  :vpc_configuration,
  :description,
  :schedule,
  :role_arn,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A new name for the data source connector.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10558

class UpdateDataSourceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :configuration,
  :vpc_configuration,
  :description,
  :schedule,
  :role_arn,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of a role with permission to access the data source and required resources. For more information, see [IAM roles for Amazon Kendra].

[1]: docs.aws.amazon.com/kendra/latest/dg/iam-roles.html

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10558

class UpdateDataSourceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :configuration,
  :vpc_configuration,
  :description,
  :schedule,
  :role_arn,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ String

The sync schedule you want to update for the data source connector.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 10558

class UpdateDataSourceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :configuration,
  :vpc_configuration,
  :description,
  :schedule,
  :role_arn,
  :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].

[1]: docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html

Returns:

• (Types::DataSourceVpcConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 10558

class UpdateDataSourceRequest < Struct.new(
  :id,
  :name,
  :index_id,
  :configuration,
  :vpc_configuration,
  :description,
  :schedule,
  :role_arn,
  :language_code,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end