interface S3DataSourceConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Kendra.CfnDataSource.S3DataSourceConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_S3DataSourceConfigurationProperty`
Java	`software.amazon.awscdk.services.kendra.CfnDataSource.S3DataSourceConfigurationProperty`
Python	`aws_cdk.aws_kendra.CfnDataSource.S3DataSourceConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_kendra` » `CfnDataSource` » `S3DataSourceConfigurationProperty`

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

Amazon Kendra now supports an upgraded Amazon S3 connector.

You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const s3DataSourceConfigurationProperty: kendra.CfnDataSource.S3DataSourceConfigurationProperty = {
  bucketName: 'bucketName',

  // the properties below are optional
  accessControlListConfiguration: {
    keyPath: 'keyPath',
  },
  documentsMetadataConfiguration: {
    s3Prefix: 's3Prefix',
  },
  exclusionPatterns: ['exclusionPatterns'],
  inclusionPatterns: ['inclusionPatterns'],
  inclusionPrefixes: ['inclusionPrefixes'],
};

Properties

Name	Type	Description
bucketName	`string`	The name of the bucket that contains the documents.
accessControlListConfiguration?	`IResolvable` `\|` `AccessControlListConfigurationProperty`	Provides the path to the S3 bucket that contains the user context filtering files for the data source.
documentsMetadataConfiguration?	`IResolvable` `\|` `DocumentsMetadataConfigurationProperty`	Specifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.
exclusionPatterns?	`string[]`	A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index.
inclusionPatterns?	`string[]`	A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index.
inclusionPrefixes?	`string[]`	A list of S3 prefixes for the documents that should be included in the index.

bucketName

Type: string

The name of the bucket that contains the documents.

accessControlListConfiguration?

Type: IResolvable | AccessControlListConfigurationProperty (optional)

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 .

documentsMetadataConfiguration?

Type: IResolvable | DocumentsMetadataConfigurationProperty (optional)

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.

exclusionPatterns?

Type: string[] (optional)

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to exclude from your index.

If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

- /myapp/config/** —All files inside config directory.
*** /.png —All .png files in all directories.
*** /.{png, ico, md} —All .png, .ico or .md files in all directories.
- /myapp/src/** /.ts —All .ts files inside src directory (and all its subdirectories).
*** /!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
*** /internal* —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

inclusionPatterns?

Type: string[] (optional)

A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for certain file names and file types to include in your index.

If a document matches both an inclusion and exclusion prefix or pattern, the exclusion prefix takes precendence and the document is not indexed. Examples of glob patterns include:

- /myapp/config/** —All files inside config directory.
*** /.png —All .png files in all directories.
*** /.{png, ico, md} —All .png, .ico or .md files in all directories.
- /myapp/src/** /.ts —All .ts files inside src directory (and all its subdirectories).
*** /!(.module).ts —All .ts files but not .module.ts
**.png , .jpg —All PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
internal —All files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
*** /internal* —All internal-related files in a directory and its subdirectories.

For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.

inclusionPrefixes?

Type: string[] (optional)

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