Package software.amazon.awscdk.services.kendra

Interface CfnDataSource.S3DataSourceConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDataSource.S3DataSourceConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnDataSource
@Stability(Stable) public static interface CfnDataSource.S3DataSourceConfigurationProperty extends software.amazon.jsii.JsiiSerializable
Provides the configuration information to connect to an Amazon S3 bucket.

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();

  • Method Details

    • getBucketName

      @Stability(Stable) @NotNull String getBucketName()
      The name of the bucket that contains the documents.

    • getAccessControlListConfiguration

      @Stability(Stable) @Nullable default Object getAccessControlListConfiguration()
      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 .

    • getDocumentsMetadataConfiguration

      @Stability(Stable) @Nullable default Object getDocumentsMetadataConfiguration()
      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.

    • getExclusionPatterns

      @Stability(Stable) @Nullable default List<String> getExclusionPatterns()
      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.

    • getInclusionPatterns

      @Stability(Stable) @Nullable default List<String> getInclusionPatterns()
      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'.

    • getInclusionPrefixes

      @Stability(Stable) @Nullable default List<String> getInclusionPrefixes()
      A list of S3 prefixes for the documents that should be included in the index.

    • builder

      @Stability(Stable) static CfnDataSource.S3DataSourceConfigurationProperty.Builder builder()
      Returns:
      a CfnDataSource.S3DataSourceConfigurationProperty.Builder of CfnDataSource.S3DataSourceConfigurationProperty