S3DataSourceConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.S3DataSourceConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class S3DataSourceConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides configuration information for a data source to index documents in an Amazon S3 bucket.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

S3DataSourceConfiguration()

Constructors
Constructor and Description
`S3DataSourceConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
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 for documents that should not be indexed.
`List<String>`	`getInclusionPatterns()` A list of glob patterns for documents that should be indexed.
`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 for documents that should not be indexed.
`void`	`setInclusionPatterns(Collection<String> inclusionPatterns)` A list of glob patterns for documents that should be indexed.
`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 for documents that should not be indexed.
`S3DataSourceConfiguration`	`withExclusionPatterns(String... exclusionPatterns)` A list of glob patterns for documents that should not be indexed.
`S3DataSourceConfiguration`	`withInclusionPatterns(Collection<String> inclusionPatterns)` A list of glob patterns for documents that should be indexed.
`S3DataSourceConfiguration`	`withInclusionPatterns(String... inclusionPatterns)` A list of glob patterns for documents that should be indexed.
`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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - S3DataSourceConfiguration
```
public S3DataSourceConfiguration()
```
- Method Detail
  - setBucketName
```
public void setBucketName(String bucketName)
```
    The name of the bucket that contains the documents.
    
    Parameters:
    
    bucketName - The name of the bucket that contains the documents.
  - getBucketName
```
public String getBucketName()
```
    The name of the bucket that contains the documents.
    
    Returns:
    
    The name of the bucket that contains the documents.
  - withBucketName
```
public S3DataSourceConfiguration withBucketName(String bucketName)
```
    The name of the bucket that contains the documents.
    
    Parameters:
    
    bucketName - The name of the bucket that contains the documents.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInclusionPrefixes
```
public List<String> getInclusionPrefixes()
```
    A list of S3 prefixes for the documents that should be included in the index.
    
    Returns:
    
    A list of S3 prefixes for the documents that should be included in the index.
  - setInclusionPrefixes
```
public void setInclusionPrefixes(Collection<String> inclusionPrefixes)
```
    A list of S3 prefixes for the documents that should be included in the index.
    
    Parameters:
    
    inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.
  - withInclusionPrefixes
```
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.
    
    Parameters:
    
    inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInclusionPrefixes
```
public S3DataSourceConfiguration withInclusionPrefixes(Collection<String> inclusionPrefixes)
```
    A list of S3 prefixes for the documents that should be included in the index.
    
    Parameters:
    
    inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInclusionPatterns
```
public 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'.
    Returns:
    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'.
  - setInclusionPatterns
```
public void setInclusionPatterns(Collection<String> inclusionPatterns)
```
    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'.
    Parameters:
    inclusionPatterns - 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'.
  - withInclusionPatterns
```
public S3DataSourceConfiguration withInclusionPatterns(String... inclusionPatterns)
```
    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'.
    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.
    Parameters:
    inclusionPatterns - 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'.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInclusionPatterns
```
public S3DataSourceConfiguration withInclusionPatterns(Collection<String> inclusionPatterns)
```
    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'.
    Parameters:
    inclusionPatterns - 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'.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExclusionPatterns
```
public 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.
    Returns:
    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.
  - setExclusionPatterns
```
public void setExclusionPatterns(Collection<String> exclusionPatterns)
```
    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.
    Parameters:
    exclusionPatterns - 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.
  - withExclusionPatterns
```
public S3DataSourceConfiguration withExclusionPatterns(String... exclusionPatterns)
```
    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.
    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.
    Parameters:
    exclusionPatterns - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExclusionPatterns
```
public S3DataSourceConfiguration withExclusionPatterns(Collection<String> exclusionPatterns)
```
    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.
    Parameters:
    exclusionPatterns - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentsMetadataConfiguration
```
public void setDocumentsMetadataConfiguration(DocumentsMetadataConfiguration documentsMetadataConfiguration)
```
    Parameters:
    
    documentsMetadataConfiguration -
  - getDocumentsMetadataConfiguration
```
public DocumentsMetadataConfiguration getDocumentsMetadataConfiguration()
```
    Returns:
  - withDocumentsMetadataConfiguration
```
public S3DataSourceConfiguration withDocumentsMetadataConfiguration(DocumentsMetadataConfiguration documentsMetadataConfiguration)
```
    Parameters:
    
    documentsMetadataConfiguration -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessControlListConfiguration
```
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.
    
    Parameters:
    
    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.
  - getAccessControlListConfiguration
```
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.
    
    Returns:
    
    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.
  - withAccessControlListConfiguration
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public S3DataSourceConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class S3DataSourceConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

S3DataSourceConfiguration

Method Detail

setBucketName

getBucketName

withBucketName

getInclusionPrefixes

setInclusionPrefixes

withInclusionPrefixes

withInclusionPrefixes

getInclusionPatterns

setInclusionPatterns

withInclusionPatterns

withInclusionPatterns

getExclusionPatterns

setExclusionPatterns

withExclusionPatterns

withExclusionPatterns

setDocumentsMetadataConfiguration

getDocumentsMetadataConfiguration

withDocumentsMetadataConfiguration

setAccessControlListConfiguration

getAccessControlListConfiguration

withAccessControlListConfiguration

toString

equals

hashCode

clone

marshall