/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace kendra { namespace Model { /** *

Provides the configuration information to connect to an Amazon S3 * bucket.

See Also:

AWS * API Reference

*/ class S3DataSourceConfiguration { public: AWS_KENDRA_API S3DataSourceConfiguration(); AWS_KENDRA_API S3DataSourceConfiguration(Aws::Utils::Json::JsonView jsonValue); AWS_KENDRA_API S3DataSourceConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_KENDRA_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the bucket that contains the documents.

*/ inline const Aws::String& GetBucketName() const{ return m_bucketName; } /** *

The name of the bucket that contains the documents.

*/ inline bool BucketNameHasBeenSet() const { return m_bucketNameHasBeenSet; } /** *

The name of the bucket that contains the documents.

*/ inline void SetBucketName(const Aws::String& value) { m_bucketNameHasBeenSet = true; m_bucketName = value; } /** *

The name of the bucket that contains the documents.

*/ inline void SetBucketName(Aws::String&& value) { m_bucketNameHasBeenSet = true; m_bucketName = std::move(value); } /** *

The name of the bucket that contains the documents.

*/ inline void SetBucketName(const char* value) { m_bucketNameHasBeenSet = true; m_bucketName.assign(value); } /** *

The name of the bucket that contains the documents.

*/ inline S3DataSourceConfiguration& WithBucketName(const Aws::String& value) { SetBucketName(value); return *this;} /** *

The name of the bucket that contains the documents.

*/ inline S3DataSourceConfiguration& WithBucketName(Aws::String&& value) { SetBucketName(std::move(value)); return *this;} /** *

The name of the bucket that contains the documents.

*/ inline S3DataSourceConfiguration& WithBucketName(const char* value) { SetBucketName(value); return *this;} /** *

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

*/ inline const Aws::Vector& GetInclusionPrefixes() const{ return m_inclusionPrefixes; } /** *

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

*/ inline bool InclusionPrefixesHasBeenSet() const { return m_inclusionPrefixesHasBeenSet; } /** *

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

*/ inline void SetInclusionPrefixes(const Aws::Vector& value) { m_inclusionPrefixesHasBeenSet = true; m_inclusionPrefixes = value; } /** *

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

*/ inline void SetInclusionPrefixes(Aws::Vector&& value) { m_inclusionPrefixesHasBeenSet = true; m_inclusionPrefixes = std::move(value); } /** *

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

*/ inline S3DataSourceConfiguration& WithInclusionPrefixes(const Aws::Vector& value) { SetInclusionPrefixes(value); return *this;} /** *

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

*/ inline S3DataSourceConfiguration& WithInclusionPrefixes(Aws::Vector&& value) { SetInclusionPrefixes(std::move(value)); return *this;} /** *

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

*/ inline S3DataSourceConfiguration& AddInclusionPrefixes(const Aws::String& value) { m_inclusionPrefixesHasBeenSet = true; m_inclusionPrefixes.push_back(value); return *this; } /** *

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

*/ inline S3DataSourceConfiguration& AddInclusionPrefixes(Aws::String&& value) { m_inclusionPrefixesHasBeenSet = true; m_inclusionPrefixes.push_back(std::move(value)); return *this; } /** *

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

*/ inline S3DataSourceConfiguration& AddInclusionPrefixes(const char* value) { m_inclusionPrefixesHasBeenSet = true; m_inclusionPrefixes.push_back(value); return *this; } /** *

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'.

*/ inline const Aws::Vector& GetInclusionPatterns() const{ return m_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'.

*/ inline bool InclusionPatternsHasBeenSet() const { return m_inclusionPatternsHasBeenSet; } /** *

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'.

*/ inline void SetInclusionPatterns(const Aws::Vector& value) { m_inclusionPatternsHasBeenSet = true; m_inclusionPatterns = value; } /** *

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'.

*/ inline void SetInclusionPatterns(Aws::Vector&& value) { m_inclusionPatternsHasBeenSet = true; m_inclusionPatterns = std::move(value); } /** *

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'.

*/ inline S3DataSourceConfiguration& WithInclusionPatterns(const Aws::Vector& value) { SetInclusionPatterns(value); return *this;} /** *

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'.

*/ inline S3DataSourceConfiguration& WithInclusionPatterns(Aws::Vector&& value) { SetInclusionPatterns(std::move(value)); return *this;} /** *

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'.

*/ inline S3DataSourceConfiguration& AddInclusionPatterns(const Aws::String& value) { m_inclusionPatternsHasBeenSet = true; m_inclusionPatterns.push_back(value); return *this; } /** *

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'.

*/ inline S3DataSourceConfiguration& AddInclusionPatterns(Aws::String&& value) { m_inclusionPatternsHasBeenSet = true; m_inclusionPatterns.push_back(std::move(value)); return *this; } /** *

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'.

*/ inline S3DataSourceConfiguration& AddInclusionPatterns(const char* value) { m_inclusionPatternsHasBeenSet = true; m_inclusionPatterns.push_back(value); return *this; } /** *

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.

*/ inline const Aws::Vector& GetExclusionPatterns() const{ return m_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.

*/ inline bool ExclusionPatternsHasBeenSet() const { return m_exclusionPatternsHasBeenSet; } /** *

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.

*/ inline void SetExclusionPatterns(const Aws::Vector& value) { m_exclusionPatternsHasBeenSet = true; m_exclusionPatterns = value; } /** *

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.

*/ inline void SetExclusionPatterns(Aws::Vector&& value) { m_exclusionPatternsHasBeenSet = true; m_exclusionPatterns = std::move(value); } /** *

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.

*/ inline S3DataSourceConfiguration& WithExclusionPatterns(const Aws::Vector& value) { SetExclusionPatterns(value); return *this;} /** *

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.

*/ inline S3DataSourceConfiguration& WithExclusionPatterns(Aws::Vector&& value) { SetExclusionPatterns(std::move(value)); return *this;} /** *

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.

*/ inline S3DataSourceConfiguration& AddExclusionPatterns(const Aws::String& value) { m_exclusionPatternsHasBeenSet = true; m_exclusionPatterns.push_back(value); return *this; } /** *

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.

*/ inline S3DataSourceConfiguration& AddExclusionPatterns(Aws::String&& value) { m_exclusionPatternsHasBeenSet = true; m_exclusionPatterns.push_back(std::move(value)); return *this; } /** *

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.

*/ inline S3DataSourceConfiguration& AddExclusionPatterns(const char* value) { m_exclusionPatternsHasBeenSet = true; m_exclusionPatterns.push_back(value); return *this; } inline const DocumentsMetadataConfiguration& GetDocumentsMetadataConfiguration() const{ return m_documentsMetadataConfiguration; } inline bool DocumentsMetadataConfigurationHasBeenSet() const { return m_documentsMetadataConfigurationHasBeenSet; } inline void SetDocumentsMetadataConfiguration(const DocumentsMetadataConfiguration& value) { m_documentsMetadataConfigurationHasBeenSet = true; m_documentsMetadataConfiguration = value; } inline void SetDocumentsMetadataConfiguration(DocumentsMetadataConfiguration&& value) { m_documentsMetadataConfigurationHasBeenSet = true; m_documentsMetadataConfiguration = std::move(value); } inline S3DataSourceConfiguration& WithDocumentsMetadataConfiguration(const DocumentsMetadataConfiguration& value) { SetDocumentsMetadataConfiguration(value); return *this;} inline S3DataSourceConfiguration& WithDocumentsMetadataConfiguration(DocumentsMetadataConfiguration&& value) { SetDocumentsMetadataConfiguration(std::move(value)); return *this;} /** *

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.

*/ inline const AccessControlListConfiguration& GetAccessControlListConfiguration() const{ return m_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.

*/ inline bool AccessControlListConfigurationHasBeenSet() const { return m_accessControlListConfigurationHasBeenSet; } /** *

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.

*/ inline void SetAccessControlListConfiguration(const AccessControlListConfiguration& value) { m_accessControlListConfigurationHasBeenSet = true; m_accessControlListConfiguration = value; } /** *

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.

*/ inline void SetAccessControlListConfiguration(AccessControlListConfiguration&& value) { m_accessControlListConfigurationHasBeenSet = true; m_accessControlListConfiguration = std::move(value); } /** *

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.

*/ inline S3DataSourceConfiguration& WithAccessControlListConfiguration(const AccessControlListConfiguration& value) { SetAccessControlListConfiguration(value); return *this;} /** *

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.

*/ inline S3DataSourceConfiguration& WithAccessControlListConfiguration(AccessControlListConfiguration&& value) { SetAccessControlListConfiguration(std::move(value)); return *this;} private: Aws::String m_bucketName; bool m_bucketNameHasBeenSet = false; Aws::Vector m_inclusionPrefixes; bool m_inclusionPrefixesHasBeenSet = false; Aws::Vector m_inclusionPatterns; bool m_inclusionPatternsHasBeenSet = false; Aws::Vector m_exclusionPatterns; bool m_exclusionPatternsHasBeenSet = false; DocumentsMetadataConfiguration m_documentsMetadataConfiguration; bool m_documentsMetadataConfigurationHasBeenSet = false; AccessControlListConfiguration m_accessControlListConfiguration; bool m_accessControlListConfigurationHasBeenSet = false; }; } // namespace Model } // namespace kendra } // namespace Aws