You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Kendra::Types::ConfluenceConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::ConfluenceConfiguration
- Defined in:
- (unknown)
Overview
When passing ConfluenceConfiguration as input to an Aws::Client method, you can use a vanilla Hash:
{
server_url: "Url", # required
secret_arn: "SecretArn", # required
version: "CLOUD", # required, accepts CLOUD, SERVER
space_configuration: {
crawl_personal_spaces: false,
crawl_archived_spaces: false,
include_spaces: ["ConfluenceSpaceIdentifier"],
exclude_spaces: ["ConfluenceSpaceIdentifier"],
space_field_mappings: [
{
data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName",
},
],
},
page_configuration: {
page_field_mappings: [
{
data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName",
},
],
},
blog_configuration: {
blog_field_mappings: [
{
data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName",
},
],
},
attachment_configuration: {
crawl_attachments: false,
attachment_field_mappings: [
{
data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
date_field_format: "DataSourceDateFieldFormat",
index_field_name: "IndexFieldName",
},
],
},
vpc_configuration: {
subnet_ids: ["SubnetId"], # required
security_group_ids: ["VpcSecurityGroupId"], # required
},
inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
}
Provides configuration information for data sources that connect to Confluence.
Returned by:
Instance Attribute Summary collapse
-
#attachment_configuration ⇒ Types::ConfluenceAttachmentConfiguration
Specifies configuration information for indexing attachments to Confluence blogs and pages.
-
#blog_configuration ⇒ Types::ConfluenceBlogConfiguration
Specifies configuration information for indexing Confluence blogs.
-
#exclusion_patterns ⇒ Array<String>
A list of regular expression patterns that apply to a URL on the Confluence server.
-
#inclusion_patterns ⇒ Array<String>
A list of regular expression patterns that apply to a URL on the Confluence server.
-
#page_configuration ⇒ Types::ConfluencePageConfiguration
Specifies configuration information for indexing Confluence pages.
-
#secret_arn ⇒ String
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server.
-
#server_url ⇒ String
The URL of your Confluence instance.
-
#space_configuration ⇒ Types::ConfluenceSpaceConfiguration
Specifies configuration information for indexing Confluence spaces.
-
#version ⇒ String
Specifies the version of the Confluence installation that you are connecting to.
-
#vpc_configuration ⇒ Types::DataSourceVpcConfiguration
Specifies the information for connecting to an Amazon VPC.
Instance Attribute Details
#attachment_configuration ⇒ Types::ConfluenceAttachmentConfiguration
Specifies configuration information for indexing attachments to Confluence blogs and pages.
#blog_configuration ⇒ Types::ConfluenceBlogConfiguration
Specifies configuration information for indexing Confluence blogs.
#exclusion_patterns ⇒ Array<String>
A list of regular expression patterns that apply to a URL on the Confluence server. An exclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the pattern are excluded from the index. Items that don\'t match the pattern are included in the index. If a item matches both an exclusion pattern and an inclusion pattern, the item isn\'t included in the index.
#inclusion_patterns ⇒ Array<String>
A list of regular expression patterns that apply to a URL on the Confluence server. An inclusion pattern can apply to a blog post, a page, a space, or an attachment. Items that match the patterns are included in the index. Items that don\'t match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, the item isn\'t included in the index.
#page_configuration ⇒ Types::ConfluencePageConfiguration
Specifies configuration information for indexing Confluence pages.
#secret_arn ⇒ String
The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Confluence server. The secret must contain a JSON structure with the following keys:
username - The user name or email address of a user with administrative privileges for the Confluence server.
password - The password associated with the user logging in to the Confluence server.
#server_url ⇒ String
The URL of your Confluence instance. Use the full URL of the server. For
example, https://server.example.com:port/
. You can also use an IP
address, for example, https://192.168.1.113/
.
#space_configuration ⇒ Types::ConfluenceSpaceConfiguration
Specifies configuration information for indexing Confluence spaces.
#version ⇒ String
Specifies the version of the Confluence installation that you are connecting to.
Possible values:
- CLOUD
- SERVER
#vpc_configuration ⇒ Types::DataSourceVpcConfiguration
Specifies the information for connecting to an Amazon VPC.