Documentation

Provides the configuration information to connect to an Amazon S3 bucket.

See: newS3DataSourceConfiguration smart constructor.

Create a value of S3DataSourceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessControlListConfiguration:S3DataSourceConfiguration', s3DataSourceConfiguration_accessControlListConfiguration - Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

$sel:documentsMetadataConfiguration:S3DataSourceConfiguration', s3DataSourceConfiguration_documentsMetadataConfiguration - Undocumented member.

$sel:exclusionPatterns:S3DataSourceConfiguration', s3DataSourceConfiguration_exclusionPatterns - 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.

Some examples are:

• *.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
• *internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
• **/*internal* will exclude all internal-related files in a directory and its subdirectories.

$sel:inclusionPatterns:S3DataSourceConfiguration', s3DataSourceConfiguration_inclusionPatterns - 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.

Some examples are:

• *.txt will include all text files in a directory (files with the extension .txt).
• **/*.txt will include all text files in a directory and its subdirectories.
• *tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

$sel:inclusionPrefixes:S3DataSourceConfiguration', s3DataSourceConfiguration_inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.

$sel:bucketName:S3DataSourceConfiguration', s3DataSourceConfiguration_bucketName - The name of the bucket that contains the documents.

Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see Access control for S3 data sources.

Undocumented member.

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.

Some examples are:

• *.png , *.jpg will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
• *internal* will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
• **/*internal* will exclude all internal-related files in a directory and its subdirectories.

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.

Some examples are:

• *.txt will include all text files in a directory (files with the extension .txt).
• **/*.txt will include all text files in a directory and its subdirectories.
• *tax* will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.

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

The name of the bucket that contains the documents.