Class: Aws::Kendra::Types::S3DataSourceConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::S3DataSourceConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass S3DataSourceConfiguration data as a hash:

{
  bucket_name: "S3BucketName", # required
  inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
  inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
  exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
  documents_metadata_configuration: {
    s3_prefix: "S3ObjectKey",
  },
  access_control_list_configuration: {
    key_path: "S3ObjectKey",
  },
}

Provides configuration information for a data source to index documents in an Amazon S3 bucket.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_control_list_configuration ⇒ Types::AccessControlListConfiguration

  Provides the path to the S3 bucket that contains the user context filtering files for the data source.

• #bucket_name ⇒ String

  The name of the bucket that contains the documents.

• #documents_metadata_configuration ⇒ Types::DocumentsMetadataConfiguration

  Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes.

• #exclusion_patterns ⇒ Array<String>

  A list of glob patterns for documents that should not be indexed.

• #inclusion_patterns ⇒ Array<String>

  A list of glob patterns for documents that should be indexed.

• #inclusion_prefixes ⇒ Array<String>

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

Instance Attribute Details

#access_control_list_configuration ⇒ Types::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].

[1]: docs.aws.amazon.com/kendra/latest/dg/s3-acl.html

Returns:

• (Types::AccessControlListConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 4876

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#bucket_name ⇒ String

The name of the bucket that contains the documents.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 4876

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#documents_metadata_configuration ⇒ Types::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.

Returns:

• (Types::DocumentsMetadataConfiguration)

# File 'lib/aws-sdk-kendra/types.rb', line 4876

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patterns ⇒ Array<String>

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.

For more information about glob patterns, see [glob (programming)] in Wikipedia.

[1]: en.wikipedia.org/wiki/Glob_(programming)

Returns:

• (Array<String>)

# File 'lib/aws-sdk-kendra/types.rb', line 4876

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ Array<String>

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.

For more information about glob patterns, see [glob (programming)] in Wikipedia.

[1]: en.wikipedia.org/wiki/Glob_(programming)

Returns:

• (Array<String>)

# File 'lib/aws-sdk-kendra/types.rb', line 4876

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_prefixes ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-kendra/types.rb', line 4876

class S3DataSourceConfiguration < Struct.new(
  :bucket_name,
  :inclusion_prefixes,
  :inclusion_patterns,
  :exclusion_patterns,
  :documents_metadata_configuration,
  :access_control_list_configuration)
  SENSITIVE = []
  include Aws::Structure
end