AWS::Kendra::DataSource S3DataSourceConfiguration
Provides the configuration information to connect to an Amazon S3 bucket.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "AccessControlListConfiguration" :AccessControlListConfiguration, "BucketName" :String, "DocumentsMetadataConfiguration" :DocumentsMetadataConfiguration, "ExclusionPatterns" :[ String, ... ], "InclusionPatterns" :[ String, ... ], "InclusionPrefixes" :[ String, ... ]}
YAML
AccessControlListConfiguration:AccessControlListConfigurationBucketName:StringDocumentsMetadataConfiguration:DocumentsMetadataConfigurationExclusionPatterns:- StringInclusionPatterns:- StringInclusionPrefixes:- String
Properties
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.
Required: No
Type: AccessControlListConfiguration
Update requires: No interruption
BucketName-
The name of the bucket that contains the documents.
Required: Yes
Type: String
Minimum:
3Maximum:
63Pattern:
[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]Update requires: No interruption
DocumentsMetadataConfiguration-
Specifies 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.
Required: No
Type: DocumentsMetadataConfiguration
Update requires: No interruption
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.
Required: No
Type: List of String
Maximum:
250Update requires: No interruption
-
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'.
Required: No
Type: List of String
Maximum:
250Update requires: No interruption
-
InclusionPrefixes-
A list of S3 prefixes for the documents that should be included in the index.
Required: No
Type: List of String
Maximum:
250Update requires: No interruption