JiraConfiguration - Amazon Kendra

JiraConfiguration

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

Contents

AttachmentFieldMappings

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.

Type: Array of DataSourceToIndexFieldMapping objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

CommentFieldMappings

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.

Type: Array of DataSourceToIndexFieldMapping objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

ExclusionPatterns

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 150.

Required: No

InclusionPatterns

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 150.

Required: No

IssueFieldMappings

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.

Type: Array of DataSourceToIndexFieldMapping objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

IssueSubEntityFilter

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 3 items.

Valid Values: COMMENTS | ATTACHMENTS | WORKLOGS

Required: No

IssueType

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

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

JiraAccountUrl

The URL of the Jira account. For example, company.atlassian.net or https://jira.company.com. You can find your Jira account URL in the URL of your profile page for Jira desktop.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^https:\/\/[a-zA-Z0-9_\-\.]+(\.atlassian\.net\/)$

Required: Yes

Project

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

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

ProjectFieldMappings

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.

Type: Array of DataSourceToIndexFieldMapping objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

SecretArn

The Amazon Resource Name (ARN) of a secret in AWS 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:

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

Status

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

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

UseChangeLog

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.

Type: Boolean

Required: No

VpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.

Type: DataSourceVpcConfiguration object

Required: No

WorkLogFieldMappings

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.

Type: Array of DataSourceToIndexFieldMapping objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: