Interface CfnDataSourcePropsMixin.S3DataSourceConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSourcePropsMixin.S3DataSourceConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDataSourcePropsMixin
@Stability(Stable)
public static interface CfnDataSourcePropsMixin.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.cfnpropertymixins.services.kendra.*;
S3DataSourceConfigurationProperty s3DataSourceConfigurationProperty = S3DataSourceConfigurationProperty.builder()
.accessControlListConfiguration(AccessControlListConfigurationProperty.builder()
.keyPath("keyPath")
.build())
.bucketName("bucketName")
.documentsMetadataConfiguration(DocumentsMetadataConfigurationProperty.builder()
.s3Prefix("s3Prefix")
.build())
.exclusionPatterns(List.of("exclusionPatterns"))
.inclusionPatterns(List.of("inclusionPatterns"))
.inclusionPrefixes(List.of("inclusionPrefixes"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classstatic final classAn implementation forCfnDataSourcePropsMixin.S3DataSourceConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectProvides the path to the S3 bucket that contains the user context filtering files for the data source.default ObjectThe name of the bucket that contains the documents.default ObjectSpecifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.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.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.A list of S3 prefixes for the documents that should be included in the index.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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 .
Returns union: either
IResolvableorCfnDataSourcePropsMixin.AccessControlListConfigurationProperty- See Also:
-
getBucketName
The name of the bucket that contains the documents.Returns union: either
StringorIBucketRef- See Also:
-
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.
Returns union: either
IResolvableorCfnDataSourcePropsMixin.DocumentsMetadataConfigurationProperty- See Also:
-
getExclusionPatterns
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.
- See Also:
-
getInclusionPatterns
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.
- See Also:
-
getInclusionPrefixes
A list of S3 prefixes for the documents that should be included in the index.- See Also:
-
builder
@Stability(Stable) static CfnDataSourcePropsMixin.S3DataSourceConfigurationProperty.Builder builder()
-