Package software.amazon.awscdk.services.kendra

Class CfnDataSource.S3DataSourceConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.kendra.CfnDataSource.S3DataSourceConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnDataSource.S3DataSourceConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDataSource.S3DataSourceConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnDataSource.S3DataSourceConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDataSource.S3DataSourceConfigurationProperty

An implementation for CfnDataSource.S3DataSourceConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kendra.CfnDataSource.S3DataSourceConfigurationProperty

CfnDataSource.S3DataSourceConfigurationProperty.Builder, CfnDataSource.S3DataSourceConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDataSource.S3DataSourceConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDataSource.S3DataSourceConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAccessControlListConfiguration()	Provides the path to the S3 bucket that contains the user context filtering files for the data source.
final String	getBucketName()	The name of the bucket that contains the documents.
final Object	getDocumentsMetadataConfiguration()	Specifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.
final 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.
final 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.
final List<String>	getInclusionPrefixes()	A list of S3 prefixes for the documents that should be included in the index.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDataSource.S3DataSourceConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDataSource.S3DataSourceConfigurationProperty.Builder.

Method Details

getBucketName

public final String getBucketName()

Description copied from interface: CfnDataSource.S3DataSourceConfigurationProperty

The name of the bucket that contains the documents.

Specified by:

getBucketName in interface CfnDataSource.S3DataSourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-bucketname

getAccessControlListConfiguration

public final Object getAccessControlListConfiguration()

Description copied from interface: CfnDataSource.S3DataSourceConfigurationProperty

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 IResolvable or CfnDataSource.AccessControlListConfigurationProperty

Specified by:

getAccessControlListConfiguration in interface CfnDataSource.S3DataSourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-accesscontrollistconfiguration

getDocumentsMetadataConfiguration

public final Object getDocumentsMetadataConfiguration()

Description copied from interface: CfnDataSource.S3DataSourceConfigurationProperty

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 IResolvable or CfnDataSource.DocumentsMetadataConfigurationProperty

Specified by:

getDocumentsMetadataConfiguration in interface CfnDataSource.S3DataSourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-documentsmetadataconfiguration

getExclusionPatterns

public final List<String> getExclusionPatterns()

Description copied from interface: CfnDataSource.S3DataSourceConfigurationProperty

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.

Specified by:

getExclusionPatterns in interface CfnDataSource.S3DataSourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-exclusionpatterns

getInclusionPatterns

public final List<String> getInclusionPatterns()

Description copied from interface: CfnDataSource.S3DataSourceConfigurationProperty

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.

Specified by:

getInclusionPatterns in interface CfnDataSource.S3DataSourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-inclusionpatterns

getInclusionPrefixes

public final List<String> getInclusionPrefixes()

Description copied from interface: CfnDataSource.S3DataSourceConfigurationProperty

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

Specified by:

getInclusionPrefixes in interface CfnDataSource.S3DataSourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-inclusionprefixes

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object