public static interface CfnDataSource.S3DataSourceConfigurationProperty
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.kendra.*; S3DataSourceConfigurationProperty s3DataSourceConfigurationProperty = S3DataSourceConfigurationProperty.builder() .bucketName("bucketName") // the properties below are optional .accessControlListConfiguration(AccessControlListConfigurationProperty.builder() .keyPath("keyPath") .build()) .documentsMetadataConfiguration(DocumentsMetadataConfigurationProperty.builder() .s3Prefix("s3Prefix") .build()) .exclusionPatterns(List.of("exclusionPatterns")) .inclusionPatterns(List.of("inclusionPatterns")) .inclusionPrefixes(List.of("inclusionPrefixes")) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnDataSource.S3DataSourceConfigurationProperty.Builder
A builder for
CfnDataSource.S3DataSourceConfigurationProperty |
static class |
CfnDataSource.S3DataSourceConfigurationProperty.Jsii$Proxy
An implementation for
CfnDataSource.S3DataSourceConfigurationProperty |
Modifier and Type | Method and Description |
---|---|
static CfnDataSource.S3DataSourceConfigurationProperty.Builder |
builder() |
default java.lang.Object |
getAccessControlListConfiguration()
Provides the path to the S3 bucket that contains the user context filtering files for the data source.
|
java.lang.String |
getBucketName()
The name of the bucket that contains the documents.
|
default java.lang.Object |
getDocumentsMetadataConfiguration()
Specifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.
|
default java.util.List<java.lang.String> |
getExclusionPatterns()
A list of glob patterns for documents that should not be indexed.
|
default java.util.List<java.lang.String> |
getInclusionPatterns()
A list of glob patterns for documents that should be indexed.
|
default java.util.List<java.lang.String> |
getInclusionPrefixes()
A list of S3 prefixes for the documents that should be included in the index.
|
java.lang.String getBucketName()
default java.lang.Object getAccessControlListConfiguration()
For the format of the file, see Access control for S3 data sources .
default java.lang.Object getDocumentsMetadataConfiguration()
Each metadata file contains metadata about a single document.
default java.util.List<java.lang.String> getExclusionPatterns()
If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.
Some examples are:
default java.util.List<java.lang.String> getInclusionPatterns()
If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed.
Some examples are:
default java.util.List<java.lang.String> getInclusionPrefixes()
static CfnDataSource.S3DataSourceConfigurationProperty.Builder builder()