Package 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(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	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSource.S3DataSourceConfigurationProperty.Builder	accessControlListConfiguration(IResolvable accessControlListConfiguration)	Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getAccessControlListConfiguration()
CfnDataSource.S3DataSourceConfigurationProperty.Builder	accessControlListConfiguration(CfnDataSource.AccessControlListConfigurationProperty 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(IResolvable documentsMetadataConfiguration)	Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getDocumentsMetadataConfiguration()
CfnDataSource.S3DataSourceConfigurationProperty.Builder	documentsMetadataConfiguration(CfnDataSource.DocumentsMetadataConfigurationProperty 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 Details

Builder

public Builder()

Method Details

bucketName

@Stability(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(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

accessControlListConfiguration

@Stability(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

documentsMetadataConfiguration

@Stability(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

documentsMetadataConfiguration

@Stability(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

exclusionPatterns

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

Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getExclusionPatterns()

Parameters:

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 AWS CLI Command Reference.

Returns:

this

inclusionPatterns

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

Sets the value of CfnDataSource.S3DataSourceConfigurationProperty.getInclusionPatterns()

Parameters:

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 AWS CLI Command Reference.

Returns:

this

inclusionPrefixes

@Stability(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(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