@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class S3DataSourceConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
Provides the configuration information to connect to an Amazon S3 bucket.
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.
| Constructor and Description |
|---|
S3DataSourceConfiguration() |
| Modifier and Type | Method and Description |
|---|---|
S3DataSourceConfiguration |
clone() |
boolean |
equals(Object obj) |
AccessControlListConfiguration |
getAccessControlListConfiguration()
Provides the path to the S3 bucket that contains the user context filtering files for the data source.
|
String |
getBucketName()
The name of the bucket that contains the documents.
|
DocumentsMetadataConfiguration |
getDocumentsMetadataConfiguration() |
List<String> |
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.
|
List<String> |
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.
|
List<String> |
getInclusionPrefixes()
A list of S3 prefixes for the documents that should be included in the index.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
void |
setAccessControlListConfiguration(AccessControlListConfiguration accessControlListConfiguration)
Provides the path to the S3 bucket that contains the user context filtering files for the data source.
|
void |
setBucketName(String bucketName)
The name of the bucket that contains the documents.
|
void |
setDocumentsMetadataConfiguration(DocumentsMetadataConfiguration documentsMetadataConfiguration) |
void |
setExclusionPatterns(Collection<String> 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.
|
void |
setInclusionPatterns(Collection<String> 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.
|
void |
setInclusionPrefixes(Collection<String> inclusionPrefixes)
A list of S3 prefixes for the documents that should be included in the index.
|
String |
toString()
Returns a string representation of this object.
|
S3DataSourceConfiguration |
withAccessControlListConfiguration(AccessControlListConfiguration accessControlListConfiguration)
Provides the path to the S3 bucket that contains the user context filtering files for the data source.
|
S3DataSourceConfiguration |
withBucketName(String bucketName)
The name of the bucket that contains the documents.
|
S3DataSourceConfiguration |
withDocumentsMetadataConfiguration(DocumentsMetadataConfiguration documentsMetadataConfiguration) |
S3DataSourceConfiguration |
withExclusionPatterns(Collection<String> 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.
|
S3DataSourceConfiguration |
withExclusionPatterns(String... 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.
|
S3DataSourceConfiguration |
withInclusionPatterns(Collection<String> 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.
|
S3DataSourceConfiguration |
withInclusionPatterns(String... 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.
|
S3DataSourceConfiguration |
withInclusionPrefixes(Collection<String> inclusionPrefixes)
A list of S3 prefixes for the documents that should be included in the index.
|
S3DataSourceConfiguration |
withInclusionPrefixes(String... inclusionPrefixes)
A list of S3 prefixes for the documents that should be included in the index.
|
public void setBucketName(String bucketName)
The name of the bucket that contains the documents.
bucketName - The name of the bucket that contains the documents.public String getBucketName()
The name of the bucket that contains the documents.
public S3DataSourceConfiguration withBucketName(String bucketName)
The name of the bucket that contains the documents.
bucketName - The name of the bucket that contains the documents.public List<String> getInclusionPrefixes()
A list of S3 prefixes for the documents that should be included in the index.
public void setInclusionPrefixes(Collection<String> inclusionPrefixes)
A list of S3 prefixes for the documents that should be included in the index.
inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.public S3DataSourceConfiguration withInclusionPrefixes(String... inclusionPrefixes)
A list of S3 prefixes for the documents that should be included in the index.
NOTE: This method appends the values to the existing list (if any). Use
setInclusionPrefixes(java.util.Collection) or withInclusionPrefixes(java.util.Collection) if
you want to override the existing values.
inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.public S3DataSourceConfiguration withInclusionPrefixes(Collection<String> inclusionPrefixes)
A list of S3 prefixes for the documents that should be included in the index.
inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.public List<String> 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 Amazon Web Services CLI Command Reference.
/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 Amazon Web Services CLI Command Reference.
public void setInclusionPatterns(Collection<String> 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. 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 Amazon Web Services 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. 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 Amazon Web Services CLI Command Reference.
public S3DataSourceConfiguration withInclusionPatterns(String... 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. 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 Amazon Web Services CLI Command Reference.
NOTE: This method appends the values to the existing list (if any). Use
setInclusionPatterns(java.util.Collection) or withInclusionPatterns(java.util.Collection) if
you want to override the existing values.
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. 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 Amazon Web Services CLI Command Reference.
public S3DataSourceConfiguration withInclusionPatterns(Collection<String> 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. 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 Amazon Web Services 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. 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 Amazon Web Services CLI Command Reference.
public List<String> 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 Amazon Web Services CLI Command Reference.
/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 Amazon Web Services CLI Command Reference.
public void setExclusionPatterns(Collection<String> 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. 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 Amazon Web Services CLI Command Reference.
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. 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 Amazon Web Services CLI Command Reference.
public S3DataSourceConfiguration withExclusionPatterns(String... 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. 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 Amazon Web Services CLI Command Reference.
NOTE: This method appends the values to the existing list (if any). Use
setExclusionPatterns(java.util.Collection) or withExclusionPatterns(java.util.Collection) if
you want to override the existing values.
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. 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 Amazon Web Services CLI Command Reference.
public S3DataSourceConfiguration withExclusionPatterns(Collection<String> 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. 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 Amazon Web Services CLI Command Reference.
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. 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 Amazon Web Services CLI Command Reference.
public void setDocumentsMetadataConfiguration(DocumentsMetadataConfiguration documentsMetadataConfiguration)
documentsMetadataConfiguration - public DocumentsMetadataConfiguration getDocumentsMetadataConfiguration()
public S3DataSourceConfiguration withDocumentsMetadataConfiguration(DocumentsMetadataConfiguration documentsMetadataConfiguration)
documentsMetadataConfiguration - public void setAccessControlListConfiguration(AccessControlListConfiguration accessControlListConfiguration)
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.
accessControlListConfiguration - 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.public AccessControlListConfiguration 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.
public S3DataSourceConfiguration withAccessControlListConfiguration(AccessControlListConfiguration accessControlListConfiguration)
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.
accessControlListConfiguration - 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.public String toString()
toString in class ObjectObject.toString()public S3DataSourceConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.