Class: Aws::Kendra::Types::QuipConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::QuipConfiguration

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information to connect to Quip as your data source.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attachment_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names.

• #crawl_attachments ⇒ Boolean

  TRUE to index attachments.

• #crawl_chat_rooms ⇒ Boolean

  TRUE to index the contents of chat rooms.

• #crawl_file_comments ⇒ Boolean

  TRUE to index file comments.

• #domain ⇒ String

  The Quip site domain.

• #exclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to exclude certain files in your Quip file system.

• #folder_ids ⇒ Array<String>

  The identifiers of the Quip folders you want to index.

• #inclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to include certain files in your Quip file system.

• #message_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names.

• #secret_arn ⇒ String

  The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip.

• #thread_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names.

• #vpc_configuration ⇒ Types::DataSourceVpcConfiguration

  Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip.

Instance Attribute Details

#attachment_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

Returns:

• (Array<Types::DataSourceToIndexFieldMapping>)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_attachments ⇒ Boolean

TRUE to index attachments.

Returns:

• (Boolean)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_chat_rooms ⇒ Boolean

TRUE to index the contents of chat rooms.

Returns:

• (Boolean)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_file_comments ⇒ Boolean

TRUE to index file comments.

Returns:

• (Boolean)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#domain ⇒ String

The Quip site domain. For example, *https://quip-company.quipdomain.com/browse*. The domain in this example is "quipdomain".

Returns:

• (String)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain files in your Quip file system. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

Returns:

• (Array<String>)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#folder_ids ⇒ Array<String>

The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, *https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name*. The folder ID in this example is "zlLuOVNSarTL".

Returns:

• (Array<String>)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ Array<String>

A list of regular expression patterns to include certain files in your Quip file system. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

Returns:

• (Array<String>)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#message_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip messages to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

Returns:

• (Array<Types::DataSourceToIndexFieldMapping>)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:

• accessToken—The token created in Quip. For more information, see Using a Quip data source.

^

Returns:

• (String)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#thread_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of DataSourceToIndexFieldMapping objects that map attributes or field names of Quip threads to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Quip fields. For more information, see Mapping data source fields. The Quip field names must exist in your Quip custom metadata.

Returns:

• (Array<Types::DataSourceToIndexFieldMapping>)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.

Returns:

• (Types::DataSourceVpcConfiguration)

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

class QuipConfiguration < Struct.new(
  :domain,
  :secret_arn,
  :crawl_file_comments,
  :crawl_chat_rooms,
  :crawl_attachments,
  :folder_ids,
  :thread_field_mappings,
  :message_field_mappings,
  :attachment_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end