Class: Aws::Kendra::Types::ConfluenceConfiguration

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

Overview

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

Provides configuration information for data sources that connect to Confluence.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attachment_configurationTypes::ConfluenceAttachmentConfiguration

Specifies configuration information for indexing attachments to Confluence blogs and pages.



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1355

class ConfluenceConfiguration < Struct.new(
  :server_url,
  :secret_arn,
  :version,
  :space_configuration,
  :page_configuration,
  :blog_configuration,
  :attachment_configuration,
  :vpc_configuration,
  :inclusion_patterns,
  :exclusion_patterns)
  SENSITIVE = []
  include Aws::Structure
end

#blog_configurationTypes::ConfluenceBlogConfiguration

Specifies configuration information for indexing Confluence blogs.



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1355

class ConfluenceConfiguration < Struct.new(
  :server_url,
  :secret_arn,
  :version,
  :space_configuration,
  :page_configuration,
  :blog_configuration,
  :attachment_configuration,
  :vpc_configuration,
  :inclusion_patterns,
  :exclusion_patterns)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patternsArray<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.

Returns:

  • (Array<String>)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1355

class ConfluenceConfiguration < Struct.new(
  :server_url,
  :secret_arn,
  :version,
  :space_configuration,
  :page_configuration,
  :blog_configuration,
  :attachment_configuration,
  :vpc_configuration,
  :inclusion_patterns,
  :exclusion_patterns)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patternsArray<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.

Returns:

  • (Array<String>)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1355

class ConfluenceConfiguration < Struct.new(
  :server_url,
  :secret_arn,
  :version,
  :space_configuration,
  :page_configuration,
  :blog_configuration,
  :attachment_configuration,
  :vpc_configuration,
  :inclusion_patterns,
  :exclusion_patterns)
  SENSITIVE = []
  include Aws::Structure
end

#page_configurationTypes::ConfluencePageConfiguration

Specifies configuration information for indexing Confluence pages.



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1355

class ConfluenceConfiguration < Struct.new(
  :server_url,
  :secret_arn,
  :version,
  :space_configuration,
  :page_configuration,
  :blog_configuration,
  :attachment_configuration,
  :vpc_configuration,
  :inclusion_patterns,
  :exclusion_patterns)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arnString

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.

Returns:

  • (String)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1355

class ConfluenceConfiguration < Struct.new(
  :server_url,
  :secret_arn,
  :version,
  :space_configuration,
  :page_configuration,
  :blog_configuration,
  :attachment_configuration,
  :vpc_configuration,
  :inclusion_patterns,
  :exclusion_patterns)
  SENSITIVE = []
  include Aws::Structure
end

#server_urlString

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/.

Returns:

  • (String)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1355

class ConfluenceConfiguration < Struct.new(
  :server_url,
  :secret_arn,
  :version,
  :space_configuration,
  :page_configuration,
  :blog_configuration,
  :attachment_configuration,
  :vpc_configuration,
  :inclusion_patterns,
  :exclusion_patterns)
  SENSITIVE = []
  include Aws::Structure
end

#space_configurationTypes::ConfluenceSpaceConfiguration

Specifies configuration information for indexing Confluence spaces.



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1355

class ConfluenceConfiguration < Struct.new(
  :server_url,
  :secret_arn,
  :version,
  :space_configuration,
  :page_configuration,
  :blog_configuration,
  :attachment_configuration,
  :vpc_configuration,
  :inclusion_patterns,
  :exclusion_patterns)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

Specifies the version of the Confluence installation that you are connecting to.

Returns:

  • (String)


1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1355

class ConfluenceConfiguration < Struct.new(
  :server_url,
  :secret_arn,
  :version,
  :space_configuration,
  :page_configuration,
  :blog_configuration,
  :attachment_configuration,
  :vpc_configuration,
  :inclusion_patterns,
  :exclusion_patterns)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configurationTypes::DataSourceVpcConfiguration

Specifies the information for connecting to an Amazon VPC.



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1355

class ConfluenceConfiguration < Struct.new(
  :server_url,
  :secret_arn,
  :version,
  :space_configuration,
  :page_configuration,
  :blog_configuration,
  :attachment_configuration,
  :vpc_configuration,
  :inclusion_patterns,
  :exclusion_patterns)
  SENSITIVE = []
  include Aws::Structure
end