AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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"],
  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:

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_list_configurationTypes::AccessControlListConfiguration

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

Returns:

#bucket_nameString

The name of the bucket that contains the documents.

Returns:

  • (String)

    The name of the bucket that contains the documents.

#documents_metadata_configurationTypes::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_patternsArray<String>

A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix 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_prefixesArray<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.