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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attachment_field_mappingsArray<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



6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_mappingsArray<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



6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_patternsArray<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>)


6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_patternsArray<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>)


6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_mappingsArray<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



6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_filterArray<String>

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

Returns:

  • (Array<String>)


6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_typeArray<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>)


6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_urlString

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

Returns:

  • (String)


6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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

#projectArray<String>

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

Returns:

  • (Array<String>)


6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_mappingsArray<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



6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_arnString

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)


6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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

#statusArray<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>)


6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_logBoolean

‘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)


6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_configurationTypes::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



6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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_mappingsArray<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



6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
# 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