software.amazon.awscdk.services.kendra

Class CfnDataSource.S3DataSourceConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.kendra.CfnDataSource.S3DataSourceConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSource.S3DataSourceConfigurationProperty>

Enclosing interface:

CfnDataSource.S3DataSourceConfigurationProperty

@Stability(value=Stable)
public static final class CfnDataSource.S3DataSourceConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSource.S3DataSourceConfigurationProperty>

A builder for CfnDataSource.S3DataSourceConfigurationProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnDataSource.S3DataSourceConfigurationProperty.Builder	accessControlListConfiguration(CfnDataSource.AccessControlListConfigurationProperty accessControlListConfiguration) Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getAccessControlListConfiguration()
CfnDataSource.S3DataSourceConfigurationProperty.Builder	accessControlListConfiguration(IResolvable accessControlListConfiguration) Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getAccessControlListConfiguration()
CfnDataSource.S3DataSourceConfigurationProperty.Builder	bucketName(String bucketName) Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getBucketName()
CfnDataSource.S3DataSourceConfigurationProperty	build() Builds the configured instance.
CfnDataSource.S3DataSourceConfigurationProperty.Builder	documentsMetadataConfiguration(CfnDataSource.DocumentsMetadataConfigurationProperty documentsMetadataConfiguration) Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getDocumentsMetadataConfiguration()
CfnDataSource.S3DataSourceConfigurationProperty.Builder	documentsMetadataConfiguration(IResolvable documentsMetadataConfiguration) Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getDocumentsMetadataConfiguration()
CfnDataSource.S3DataSourceConfigurationProperty.Builder	exclusionPatterns(List<String> exclusionPatterns) Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getExclusionPatterns()
CfnDataSource.S3DataSourceConfigurationProperty.Builder	inclusionPatterns(List<String> inclusionPatterns) Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getInclusionPatterns()
CfnDataSource.S3DataSourceConfigurationProperty.Builder	inclusionPrefixes(List<String> inclusionPrefixes) Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getInclusionPrefixes()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

bucketName

@Stability(value=Stable)
public CfnDataSource.S3DataSourceConfigurationProperty.Builder bucketName(String bucketName)

Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getBucketName()

Parameters:

bucketName - The name of the bucket that contains the documents. This parameter is required.

Returns:

this

accessControlListConfiguration

@Stability(value=Stable)
public CfnDataSource.S3DataSourceConfigurationProperty.Builder accessControlListConfiguration(CfnDataSource.AccessControlListConfigurationProperty accessControlListConfiguration)

Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getAccessControlListConfiguration()

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:

this

accessControlListConfiguration

@Stability(value=Stable)
public CfnDataSource.S3DataSourceConfigurationProperty.Builder accessControlListConfiguration(IResolvable accessControlListConfiguration)

Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getAccessControlListConfiguration()

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:

this

documentsMetadataConfiguration

@Stability(value=Stable)
public CfnDataSource.S3DataSourceConfigurationProperty.Builder documentsMetadataConfiguration(CfnDataSource.DocumentsMetadataConfigurationProperty documentsMetadataConfiguration)

Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getDocumentsMetadataConfiguration()

Parameters:

documentsMetadataConfiguration - 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:

this

documentsMetadataConfiguration

@Stability(value=Stable)
public CfnDataSource.S3DataSourceConfigurationProperty.Builder documentsMetadataConfiguration(IResolvable documentsMetadataConfiguration)

Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getDocumentsMetadataConfiguration()

Parameters:

documentsMetadataConfiguration - 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:

this

exclusionPatterns

@Stability(value=Stable)
public CfnDataSource.S3DataSourceConfigurationProperty.Builder exclusionPatterns(List<String> exclusionPatterns)

Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getExclusionPatterns()

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:

this

inclusionPatterns

@Stability(value=Stable)
public CfnDataSource.S3DataSourceConfigurationProperty.Builder inclusionPatterns(List<String> inclusionPatterns)

Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getInclusionPatterns()

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:

this

inclusionPrefixes

@Stability(value=Stable)
public CfnDataSource.S3DataSourceConfigurationProperty.Builder inclusionPrefixes(List<String> inclusionPrefixes)

Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getInclusionPrefixes()

Parameters:

inclusionPrefixes - A list of S3 prefixes for the documents that should be included in the index.

Returns:

this

build

@Stability(value=Stable)
public CfnDataSource.S3DataSourceConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataSource.S3DataSourceConfigurationProperty>

Returns:

a new instance of CfnDataSource.S3DataSourceConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided