AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.Kendra.Model.ConfluenceConfiguration

Namespace: Amazon.Kendra.Model
Assembly: AWSSDK.Kendra.dll
Version: 3.x.y.z

Syntax

C#
public class ConfluenceConfiguration

The ConfluenceConfiguration type exposes the following members

Constructors

NameDescription
Public Method ConfluenceConfiguration()

Properties

NameTypeDescription
Public Property AttachmentConfiguration Amazon.Kendra.Model.ConfluenceAttachmentConfiguration

Gets and sets the property AttachmentConfiguration.

Configuration information for indexing attachments to Confluence blogs and pages.

Public Property AuthenticationType Amazon.Kendra.ConfluenceAuthenticationType

Gets and sets the property AuthenticationType.

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.

Public Property BlogConfiguration Amazon.Kendra.Model.ConfluenceBlogConfiguration

Gets and sets the property BlogConfiguration.

Configuration information for indexing Confluence blogs.

Public Property ExclusionPatterns System.Collections.Generic.List<System.String>

Gets and sets the property ExclusionPatterns.

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.

Public Property InclusionPatterns System.Collections.Generic.List<System.String>

Gets and sets the property InclusionPatterns.

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.

Public Property PageConfiguration Amazon.Kendra.Model.ConfluencePageConfiguration

Gets and sets the property PageConfiguration.

Configuration information for indexing Confluence pages.

Public Property ProxyConfiguration Amazon.Kendra.Model.ProxyConfiguration

Gets and sets the property 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.

Public Property SecretArn System.String

Gets and sets the property SecretArn.

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.

Public Property ServerUrl System.String

Gets and sets the property ServerUrl.

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

Public Property SpaceConfiguration Amazon.Kendra.Model.ConfluenceSpaceConfiguration

Gets and sets the property SpaceConfiguration.

Configuration information for indexing Confluence spaces.

Public Property Version Amazon.Kendra.ConfluenceVersion

Gets and sets the property Version.

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

Public Property VpcConfiguration Amazon.Kendra.Model.DataSourceVpcConfiguration

Gets and sets the property VpcConfiguration.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5