Struct S3DataSourceConfiguration 

#[non_exhaustive]
pub struct S3DataSourceConfiguration {
    pub bucket_name: String,
    pub inclusion_prefixes: Option<Vec<String>>,
    pub inclusion_patterns: Option<Vec<String>>,
    pub exclusion_patterns: Option<Vec<String>>,
    pub documents_metadata_configuration: Option<DocumentsMetadataConfiguration>,
    pub access_control_list_configuration: Option<AccessControlListConfiguration>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

bucket_name: String

The name of the bucket that contains the documents.

inclusion_prefixes: Option<Vec<String>>

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

inclusion_patterns: Option<Vec<String>>

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.

exclusion_patterns: Option<Vec<String>>

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.

documents_metadata_configuration: Option<DocumentsMetadataConfiguration>

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.

access_control_list_configuration: Option<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.

Implementations

impl S3DataSourceConfiguration

pub fn bucket_name(&self) -> &str

The name of the bucket that contains the documents.

pub fn inclusion_prefixes(&self) -> &[String]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inclusion_prefixes.is_none().

pub fn inclusion_patterns(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inclusion_patterns.is_none().

pub fn exclusion_patterns(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclusion_patterns.is_none().

pub fn documents_metadata_configuration( &self, ) -> Option<&DocumentsMetadataConfiguration>

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.

pub fn access_control_list_configuration( &self, ) -> Option<&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.

impl S3DataSourceConfiguration

pub fn builder() -> S3DataSourceConfigurationBuilder

Creates a new builder-style object to manufacture S3DataSourceConfiguration.

Trait Implementations

impl Clone for S3DataSourceConfiguration

fn clone(&self) -> S3DataSourceConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for S3DataSourceConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for S3DataSourceConfiguration

fn eq(&self, other: &S3DataSourceConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for S3DataSourceConfiguration