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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::ConfluenceConfiguration

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attachment_configuration ⇒ Types::ConfluenceAttachmentConfiguration

  Configuration information for indexing attachments to Confluence blogs and pages.

• #authentication_type ⇒ String

  Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token.

• #blog_configuration ⇒ Types::ConfluenceBlogConfiguration

  Configuration information for indexing Confluence blogs.

• #exclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.

• #inclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.

• #page_configuration ⇒ Types::ConfluencePageConfiguration

  Configuration information for indexing Confluence pages.

• #proxy_configuration ⇒ Types::ProxyConfiguration

  Configuration information to connect to your Confluence URL instance via a web proxy.

• #secret_arn ⇒ String

  The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance.

• #server_url ⇒ String

  The URL of your Confluence instance.

• #space_configuration ⇒ Types::ConfluenceSpaceConfiguration

  Configuration information for indexing Confluence spaces.

• #version ⇒ String

  The version or the type of Confluence installation to connect to.

• #vpc_configuration ⇒ Types::DataSourceVpcConfiguration

  Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.

Instance Attribute Details

#attachment_configuration ⇒ Types::ConfluenceAttachmentConfiguration

Configuration information for indexing attachments to Confluence blogs and pages.

Returns:

• (Types::ConfluenceAttachmentConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

#authentication_type ⇒ String

Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token. You can use a personal access token for Confluence Server.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

#blog_configuration ⇒ Types::ConfluenceBlogConfiguration

Configuration information for indexing Confluence blogs.

Returns:

• (Types::ConfluenceBlogConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

#exclusion_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are excluded from the index. Content that doesn't match the patterns is included in the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

#inclusion_patterns ⇒ Array<String>

A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence. Content that matches the patterns are included in the index. Content that doesn't match the patterns is excluded from the index. If content matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the content isn't included in the index.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

#page_configuration ⇒ Types::ConfluencePageConfiguration

Configuration information for indexing Confluence pages.

Returns:

• (Types::ConfluencePageConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

#proxy_configuration ⇒ Types::ProxyConfiguration

Configuration information to connect to your Confluence URL instance via a web proxy. You can use this option for Confluence Server.

You must provide the website host name and port number. For example, the host name of *https://a.example.com/page1.html* is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

Returns:

• (Types::ProxyConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

#secret_arn ⇒ String

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the Confluence instance. If you use Confluence Cloud, you use a generated API token as the password.

You can also provide authentication credentials in the form of a personal access token. For more information, see Using a Confluence data source.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

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

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

#space_configuration ⇒ Types::ConfluenceSpaceConfiguration

Configuration information for indexing Confluence spaces.

Returns:

• (Types::ConfluenceSpaceConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

#version ⇒ String

The version or the type of Confluence installation to connect to.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

Returns:

• (Types::DataSourceVpcConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1589

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