Class: Aws::Kendra::Types::SlackConfiguration

Inherits:

Struct

Object
Struct
Aws::Kendra::Types::SlackConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-kendra/types.rb

Overview

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

<note markdown=“1”> Amazon Kendra now supports an upgraded Slack connector.

You must now use the [TemplateConfiguration][1] object instead of the

‘SlackConfiguration` 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.

</note>

[1]: docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#crawl_bot_message ⇒ Boolean

‘TRUE` to index bot messages from your Slack workspace team.
#exclude_archived ⇒ Boolean

‘TRUE` to exclude archived messages to index from your Slack workspace team.
#exclusion_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain attached files in your Slack workspace team.
#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map Slack data source attributes or field names to Amazon Kendra index field names.
#inclusion_patterns ⇒ Array<String>

A list of regular expression patterns to include certain attached files in your Slack workspace team.
#look_back_period ⇒ Integer

The number of hours for change log to look back from when you last synchronized your data.
#private_channel_filter ⇒ Array<String>

The list of private channel names from your Slack workspace team.
#public_channel_filter ⇒ Array<String>

The list of public channel names to index from your Slack workspace team.
#secret_arn ⇒ String

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Slack workspace team.
#since_crawl_date ⇒ String

The date to start crawling your data from your Slack workspace team.
#slack_entity_list ⇒ Array<String>

Specify whether to index public channels, private channels, group messages, and direct messages.
#team_id ⇒ String

The identifier of the team in the Slack workspace.
#use_change_log ⇒ Boolean

‘TRUE` to use the Slack change log to determine which documents require updating in the index.
#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Slack.

Instance Attribute Details

#crawl_bot_message ⇒ `Boolean`

‘TRUE` to index bot messages from your Slack workspace team.

Returns:

(Boolean)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_archived ⇒ `Boolean`

‘TRUE` to exclude archived messages to index from your Slack workspace team.

Returns:

(Boolean)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patterns ⇒ `Array<String>`

A list of regular expression patterns to exclude certain attached files in your Slack workspace team. 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 and exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

Returns:

(Array<String>)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ `Array<Types::DataSourceToIndexFieldMapping>`

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

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:

(Array<Types::DataSourceToIndexFieldMapping>)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ `Array<String>`

A list of regular expression patterns to include certain attached files in your Slack workspace team. 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 and exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

Returns:

(Array<String>)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#look_back_period ⇒ `Integer`

The number of hours for change log to look back from when you last synchronized your data. You can look back up to 7 days or 168 hours.

Change log updates your index only if new content was added since you last synced your data. Updated or deleted content from before you last synced does not get updated in your index. To capture updated or deleted content before you last synced, set the ‘LookBackPeriod` to the number of hours you want change log to look back.

Returns:

(Integer)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#private_channel_filter ⇒ `Array<String>`

The list of private channel names from your Slack workspace team. You use this if you want to index specific private channels, not all private channels. You can also use regular expression patterns to filter private channels.

Returns:

(Array<String>)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#public_channel_filter ⇒ `Array<String>`

The list of public channel names to index from your Slack workspace team. You use this if you want to index specific public channels, not all public channels. You can also use regular expression patterns to filter public channels.

Returns:

(Array<String>)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ `String`

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

slackToken—The user or bot token created in Slack. For more information on creating a token in Slack, see [Authentication for a Slack data source].

[1]: docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication

Returns:

(String)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#since_crawl_date ⇒ `String`

The date to start crawling your data from your Slack workspace team. The date must follow this format: ‘yyyy-mm-dd`.

Returns:

(String)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#slack_entity_list ⇒ `Array<String>`

Specify whether to index public channels, private channels, group messages, and direct messages. You can specify one or more of these options.

Returns:

(Array<String>)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#team_id ⇒ `String`

The identifier of the team in the Slack workspace. For example, T0123456789.

You can find your team ID in the URL of the main page of your Slack workspace. When you log in to Slack via a browser, you are directed to the URL of the main page. For example, *app.slack.com/client/T0123456789/…*.

Returns:

(String)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#use_change_log ⇒ `Boolean`

‘TRUE` to use the Slack change log to determine which documents require updating in the index. Depending on the Slack change log’s size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Slack.

Returns:

(Boolean)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configuration ⇒ `Types::DataSourceVpcConfiguration`

Configuration information for an Amazon Virtual Private Cloud to connect to your Slack. For more information, see [Configuring a VPC].

[1]: docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html

Returns:

(Types::DataSourceVpcConfiguration)

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

class SlackConfiguration < Struct.new(
  :team_id,
  :secret_arn,
  :vpc_configuration,
  :slack_entity_list,
  :use_change_log,
  :crawl_bot_message,
  :exclude_archived,
  :since_crawl_date,
  :look_back_period,
  :private_channel_filter,
  :public_channel_filter,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Kendra::Types::SlackConfiguration

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#crawl_bot_message ⇒ Boolean

#exclude_archived ⇒ Boolean

#exclusion_patterns ⇒ Array<String>

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

#inclusion_patterns ⇒ Array<String>

#look_back_period ⇒ Integer

#private_channel_filter ⇒ Array<String>

#public_channel_filter ⇒ Array<String>

#secret_arn ⇒ String

#since_crawl_date ⇒ String

#slack_entity_list ⇒ Array<String>

#team_id ⇒ String

#use_change_log ⇒ Boolean

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

#crawl_bot_message ⇒ `Boolean`

#exclude_archived ⇒ `Boolean`

#exclusion_patterns ⇒ `Array<String>`

#field_mappings ⇒ `Array<Types::DataSourceToIndexFieldMapping>`

#inclusion_patterns ⇒ `Array<String>`

#look_back_period ⇒ `Integer`

#private_channel_filter ⇒ `Array<String>`

#public_channel_filter ⇒ `Array<String>`

#secret_arn ⇒ `String`

#since_crawl_date ⇒ `String`

#slack_entity_list ⇒ `Array<String>`

#team_id ⇒ `String`

#use_change_log ⇒ `Boolean`

#vpc_configuration ⇒ `Types::DataSourceVpcConfiguration`