Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.JiraConfiguration

Description

Synopsis

Documentation

data JiraConfiguration Source #

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

See: newJiraConfiguration smart constructor.

Constructors

JiraConfiguration'

Fields

attachmentFieldMappings :: Maybe (NonEmpty 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.
commentFieldMappings :: Maybe (NonEmpty 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.
exclusionPatterns :: Maybe [Text]
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.
inclusionPatterns :: Maybe [Text]
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.
issueFieldMappings :: Maybe (NonEmpty 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.
issueSubEntityFilter :: Maybe [IssueSubEntity]
Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.
issueType :: Maybe [Text]
Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.
project :: Maybe [Text]
Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.
projectFieldMappings :: Maybe (NonEmpty 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.
status :: Maybe [Text]
Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.
useChangeLog :: Maybe Bool
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.
vpcConfiguration :: Maybe DataSourceVpcConfiguration
Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.
workLogFieldMappings :: Maybe (NonEmpty 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.
jiraAccountUrl :: Text
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.
secretArn :: Text
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 username.
- jiraCredentials—The Jira API token. For more information on creating an API token in Jira, see Using a Jira data source.

Instances

Instances details

FromJSON JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods parseJSON :: Value -> Parser JiraConfiguration # parseJSONList :: Value -> Parser [JiraConfiguration] #
ToJSON JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods toJSON :: JiraConfiguration -> Value # toEncoding :: JiraConfiguration -> Encoding # toJSONList :: [JiraConfiguration] -> Value # toEncodingList :: [JiraConfiguration] -> Encoding #
Generic JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Associated Types type Rep JiraConfiguration :: Type -> Type # Methods from :: JiraConfiguration -> Rep JiraConfiguration x # to :: Rep JiraConfiguration x -> JiraConfiguration #
Read JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods readsPrec :: Int -> ReadS JiraConfiguration # readList :: ReadS [JiraConfiguration] # readPrec :: ReadPrec JiraConfiguration # readListPrec :: ReadPrec [JiraConfiguration] #
Show JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods showsPrec :: Int -> JiraConfiguration -> ShowS # show :: JiraConfiguration -> String # showList :: [JiraConfiguration] -> ShowS #
NFData JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods rnf :: JiraConfiguration -> () #
Eq JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods (==) :: JiraConfiguration -> JiraConfiguration -> Bool # (/=) :: JiraConfiguration -> JiraConfiguration -> Bool #
Hashable JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration Methods hashWithSalt :: Int -> JiraConfiguration -> Int # hash :: JiraConfiguration -> Int #
type Rep JiraConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.JiraConfiguration type Rep JiraConfiguration = D1 ('MetaData "JiraConfiguration" "Amazonka.Kendra.Types.JiraConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "JiraConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: (S1 ('MetaSel ('Just "commentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping))) :: S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "issueFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "issueSubEntityFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IssueSubEntity])) :: S1 ('MetaSel ('Just "issueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: (((S1 ('MetaSel ('Just "project") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "projectFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "useChangeLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)) :: S1 ('MetaSel ('Just "workLogFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :: (S1 ('MetaSel ('Just "jiraAccountUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newJiraConfiguration Source #

Arguments

:: Text	`$sel:jiraAccountUrl:JiraConfiguration'`
-> Text	`$sel:secretArn:JiraConfiguration'`
-> JiraConfiguration

Create a value of JiraConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentFieldMappings:JiraConfiguration', jiraConfiguration_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.

$sel:commentFieldMappings:JiraConfiguration', jiraConfiguration_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.

$sel:exclusionPatterns:JiraConfiguration', jiraConfiguration_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.

$sel:inclusionPatterns:JiraConfiguration', jiraConfiguration_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.

$sel:issueFieldMappings:JiraConfiguration', jiraConfiguration_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.

$sel:issueSubEntityFilter:JiraConfiguration', jiraConfiguration_issueSubEntityFilter - Specify whether to crawl comments, attachments, and work logs. You can specify one or more of these options.

$sel:issueType:JiraConfiguration', jiraConfiguration_issueType - Specify which issue types to crawl in your Jira data source. You can specify one or more of these options to crawl.

$sel:project:JiraConfiguration', jiraConfiguration_project - Specify which projects to crawl in your Jira data source. You can specify one or more Jira project IDs.

$sel:projectFieldMappings:JiraConfiguration', jiraConfiguration_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.

$sel:status:JiraConfiguration', jiraConfiguration_status - Specify which statuses to crawl in your Jira data source. You can specify one or more of these options to crawl.

$sel:useChangeLog:JiraConfiguration', jiraConfiguration_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.

$sel:vpcConfiguration:JiraConfiguration', jiraConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Jira. Your Jira account must reside inside your VPC.

$sel:workLogFieldMappings:JiraConfiguration', jiraConfiguration_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.

$sel:jiraAccountUrl:JiraConfiguration', jiraConfiguration_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.

$sel:secretArn:JiraConfiguration', jiraConfiguration_secretArn - 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 username.
jiraCredentials—The Jira API token. For more information on creating an API token in Jira, see Using a Jira data source.

jiraConfiguration_attachmentFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

jiraConfiguration_commentFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

jiraConfiguration_exclusionPatterns :: Lens' JiraConfiguration (Maybe [Text]) Source #

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.

jiraConfiguration_inclusionPatterns :: Lens' JiraConfiguration (Maybe [Text]) Source #

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.

jiraConfiguration_issueFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

jiraConfiguration_issueSubEntityFilter :: Lens' JiraConfiguration (Maybe [IssueSubEntity]) Source #

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

jiraConfiguration_issueType :: Lens' JiraConfiguration (Maybe [Text]) Source #

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

jiraConfiguration_project :: Lens' JiraConfiguration (Maybe [Text]) Source #

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

jiraConfiguration_projectFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

jiraConfiguration_status :: Lens' JiraConfiguration (Maybe [Text]) Source #

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

jiraConfiguration_useChangeLog :: Lens' JiraConfiguration (Maybe Bool) Source #

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.

jiraConfiguration_vpcConfiguration :: Lens' JiraConfiguration (Maybe DataSourceVpcConfiguration) Source #

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

jiraConfiguration_workLogFieldMappings :: Lens' JiraConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #

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.

jiraConfiguration_jiraAccountUrl :: Lens' JiraConfiguration Text Source #

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.

jiraConfiguration_secretArn :: Lens' JiraConfiguration Text Source #

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 username.
jiraCredentials—The Jira API token. For more information on creating an API token in Jira, see Using a Jira data source.