class Aws::Kendra::Types::ConfluenceConfiguration

Provides configuration information for data sources that connect to Confluence.

@note When making an API call, you may pass ConfluenceConfiguration

data as a 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"],
    }

@!attribute [rw] server_url

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/`.
@return [String]

@!attribute [rw] secret_arn

The Amazon Resource Name (ARN) of an Secrets Managersecret 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.
@return [String]

@!attribute [rw] version

Specifies the version of the Confluence installation that you are
connecting to.
@return [String]

@!attribute [rw] space_configuration

Specifies configuration information for indexing Confluence spaces.
@return [Types::ConfluenceSpaceConfiguration]

@!attribute [rw] page_configuration

Specifies configuration information for indexing Confluence pages.
@return [Types::ConfluencePageConfiguration]

@!attribute [rw] blog_configuration

Specifies configuration information for indexing Confluence blogs.
@return [Types::ConfluenceBlogConfiguration]

@!attribute [rw] attachment_configuration

Specifies configuration information for indexing attachments to
Confluence blogs and pages.
@return [Types::ConfluenceAttachmentConfiguration]

@!attribute [rw] vpc_configuration

Specifies the information for connecting to an Amazon VPC.
@return [Types::DataSourceVpcConfiguration]

@!attribute [rw] inclusion_patterns

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.
@return [Array<String>]

@!attribute [rw] exclusion_patterns

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.
@return [Array<String>]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceConfiguration AWS API Documentation

Constants

SENSITIVE