Interface CfnDataSource.IS3DataSourceConfigurationProperty
Provides the configuration information to connect to an Amazon S3 bucket.
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IS3DataSourceConfigurationProperty
Syntax (vb)
Public Interface IS3DataSourceConfigurationProperty
Remarks
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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var s3DataSourceConfigurationProperty = new S3DataSourceConfigurationProperty {
BucketName = "bucketName",
// the properties below are optional
AccessControlListConfiguration = new AccessControlListConfigurationProperty {
KeyPath = "keyPath"
},
DocumentsMetadataConfiguration = new DocumentsMetadataConfigurationProperty {
S3Prefix = "s3Prefix"
},
ExclusionPatterns = new [] { "exclusionPatterns" },
InclusionPatterns = new [] { "inclusionPatterns" },
InclusionPrefixes = new [] { "inclusionPrefixes" }
};
Synopsis
Properties
AccessControlListConfiguration | Provides the path to the S3 bucket that contains the user context filtering files for the data source. |
BucketName | The name of the bucket that contains the documents. |
DocumentsMetadataConfiguration | Specifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. |
ExclusionPatterns | 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 | 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 | A list of S3 prefixes for the documents that should be included in the index. |
Properties
AccessControlListConfiguration
Provides the path to the S3 bucket that contains the user context filtering files for the data source.
virtual object AccessControlListConfiguration { get; }
Property Value
System.Object
Remarks
BucketName
The name of the bucket that contains the documents.
string BucketName { get; }
Property Value
System.String
Remarks
DocumentsMetadataConfiguration
Specifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.
virtual object DocumentsMetadataConfiguration { get; }
Property Value
System.Object
Remarks
Each metadata file contains metadata about a single document.
ExclusionPatterns
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.
virtual string[] ExclusionPatterns { get; }
Property Value
System.String[]
Remarks
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:
For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.
InclusionPatterns
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.
virtual string[] InclusionPatterns { get; }
Property Value
System.String[]
Remarks
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:
For more examples, see Use of Exclude and Include Filters in the AWS CLI Command Reference.
InclusionPrefixes
A list of S3 prefixes for the documents that should be included in the index.
virtual string[] InclusionPrefixes { get; }
Property Value
System.String[]