Class: Aws::Kendra::Types::JiraConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::JiraConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information to connect to Jira 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 Jira attachments to Amazon Kendra index field names.

• #comment_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira comments to Amazon Kendra index field names.

• #exclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to exclude certain file paths, file names, and file types in your Jira data source.

• #inclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to include certain file paths, file names, and file types in your Jira data source.

• #issue_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira issues to Amazon Kendra index field names.

• #issue_sub_entity_filter ⇒ Array<String>

  Specify whether to crawl comments, attachments, and work logs.

• #issue_type ⇒ Array<String>

  Specify which issue types to crawl in your Jira data source.

• #jira_account_url ⇒ String

  The URL of the Jira account.

• #project ⇒ Array<String>

  Specify which projects to crawl in your Jira data source.

• #project_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira projects to Amazon Kendra index field names.

• #secret_arn ⇒ String

  The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source.

• #status ⇒ Array<String>

  Specify which statuses to crawl in your Jira data source.

• #use_change_log ⇒ Boolean

  ‘TRUE` to use the Jira 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 Jira.

• #work_log_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira work logs to Amazon Kendra index field names.

Instance Attribute Details

#attachment_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira attachments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Jira fields. For more information, see [ Mapping data source fields]. The Jira data source field names must exist in your Jira 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 6765

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#comment_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira comments to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Jira fields. For more information, see [ Mapping data source fields]. The Jira data source field names must exist in your Jira 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 6765

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_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 file paths, file names, and file types in your Jira data source. 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 'lib/aws-sdk-kendra/types.rb', line 6765

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_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 file paths, file names, and file types in your Jira data source. 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 'lib/aws-sdk-kendra/types.rb', line 6765

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#issue_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira issues to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Jira fields. For more information, see [ Mapping data source fields]. The Jira data source field names must exist in your Jira 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 6765

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#issue_sub_entity_filter ⇒ Array<String>

Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

Returns:

• (Array<String>)

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

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#issue_type ⇒ Array<String>

Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.

Returns:

• (Array<String>)

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

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#jira_account_url ⇒ String

The URL of the Jira account. For example, company.atlassian.net.

Returns:

• (String)

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

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#project ⇒ Array<String>

Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.

Returns:

• (Array<String>)

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

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#project_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira projects to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Jira fields. For more information, see [ Mapping data source fields]. The Jira data source field names must exist in your Jira 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 6765

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The Amazon Resource Name (ARN) of a secret in Secrets Manager contains the key-value pairs required to connect to your Jira data source. The secret must contain a JSON structure with the following keys:

• jiraId—The Jira user name or email.

• jiraCredentials—The Jira API token. For more information, see [Using a Jira data source].

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

Returns:

• (String)

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

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Array<String>

Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.

Returns:

• (Array<String>)

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

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#use_change_log ⇒ Boolean

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

Returns:

• (Boolean)

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

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_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 to connect to your Jira. 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 6765

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#work_log_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Jira work logs to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Jira fields. For more information, see [ Mapping data source fields]. The Jira data source field names must exist in your Jira 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 6765

class JiraConfiguration < Struct.new(
  :jira_account_url,
  :secret_arn,
  :use_change_log,
  :project,
  :issue_type,
  :status,
  :issue_sub_entity_filter,
  :attachment_field_mappings,
  :comment_field_mappings,
  :issue_field_mappings,
  :project_field_mappings,
  :work_log_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end