Class CfnDataSource.S3DataSourceConfigurationProperty
Provides the configuration information to connect to an Amazon S3 bucket.
Inheritance
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.AWS.Kendra.dll
Syntax (csharp)
public class S3DataSourceConfigurationProperty : Object, CfnDataSource.IS3DataSourceConfigurationProperty
Syntax (vb)
Public Class S3DataSourceConfigurationProperty
Inherits Object
Implements CfnDataSource.IS3DataSourceConfigurationProperty
Remarks
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
Constructors
S3DataSourceConfigurationProperty() |
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 for documents that should not be indexed. |
InclusionPatterns | A list of glob patterns for documents that should be indexed. |
InclusionPrefixes | A list of S3 prefixes for the documents that should be included in the index. |
Constructors
S3DataSourceConfigurationProperty()
public S3DataSourceConfigurationProperty()
Properties
AccessControlListConfiguration
Provides the path to the S3 bucket that contains the user context filtering files for the data source.
public object AccessControlListConfiguration { get; set; }
Property Value
System.Object
Remarks
BucketName
The name of the bucket that contains the documents.
public string BucketName { get; set; }
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.
public object DocumentsMetadataConfiguration { get; set; }
Property Value
System.Object
Remarks
Each metadata file contains metadata about a single document.
ExclusionPatterns
A list of glob patterns for documents that should not be indexed.
public string[] ExclusionPatterns { get; set; }
Property Value
System.String[]
Remarks
If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.
Some examples are:
InclusionPatterns
A list of glob patterns for documents that should be indexed.
public string[] InclusionPatterns { get; set; }
Property Value
System.String[]
Remarks
If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.
Some examples are:
InclusionPrefixes
A list of S3 prefixes for the documents that should be included in the index.
public string[] InclusionPrefixes { get; set; }
Property Value
System.String[]