You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kendra::Types::S3DataSourceConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing S3DataSourceConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  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",
  },
}

Provides configuration information for a data source to index documents in an Amazon S3 bucket.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_list_configuration ⇒ Types::AccessControlListConfiguration

Provides the path to the S3 bucket that contains the user context filtering files for the data source.

Returns:

#bucket_name ⇒ String

The name of the bucket that contains the documents.

Returns:

  • (String) —

    The name of the bucket that contains the documents.

#documents_metadata_configuration ⇒ Types::DocumentsMetadataConfiguration

Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.

Returns:

  • (Types::DocumentsMetadataConfiguration) —

    Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.

#exclusion_patterns ⇒ Array<String>

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Returns:

  • (Array<String>) —

    A list of glob patterns for documents that should not be indexed.

#inclusion_patterns ⇒ Array<String>

A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.

For more information about glob patterns, see glob (programming) in Wikipedia.

Returns:

  • (Array<String>) —

    A list of glob patterns for documents that should be indexed.

#inclusion_prefixes ⇒ Array<String>

A list of S3 prefixes for the documents that should be included in the index.

Returns:

  • (Array<String>) —

    A list of S3 prefixes for the documents that should be included in the index.