Struct aws_sdk_kendra::types::ConfluenceConfiguration

#[non_exhaustive]
pub struct ConfluenceConfiguration {
    pub server_url: String,
    pub secret_arn: String,
    pub version: ConfluenceVersion,
    pub space_configuration: Option<ConfluenceSpaceConfiguration>,
    pub page_configuration: Option<ConfluencePageConfiguration>,
    pub blog_configuration: Option<ConfluenceBlogConfiguration>,
    pub attachment_configuration: Option<ConfluenceAttachmentConfiguration>,
    pub vpc_configuration: Option<DataSourceVpcConfiguration>,
    pub inclusion_patterns: Option<Vec<String>>,
    pub exclusion_patterns: Option<Vec<String>>,
    pub proxy_configuration: Option<ProxyConfiguration>,
    pub authentication_type: Option<ConfluenceAuthenticationType>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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

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.

version: ConfluenceVersion

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

space_configuration: Option<ConfluenceSpaceConfiguration>

Configuration information for indexing Confluence spaces.

page_configuration: Option<ConfluencePageConfiguration>

Configuration information for indexing Confluence pages.

blog_configuration: Option<ConfluenceBlogConfiguration>

Configuration information for indexing Confluence blogs.

attachment_configuration: Option<ConfluenceAttachmentConfiguration>

Configuration information for indexing attachments to Confluence blogs and pages.

vpc_configuration: Option<DataSourceVpcConfiguration>

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

inclusion_patterns: Option<Vec<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.

exclusion_patterns: Option<Vec<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.

proxy_configuration: Option<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.

authentication_type: Option<ConfluenceAuthenticationType>

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.

Implementations

impl ConfluenceConfiguration

pub fn server_url(&self) -> &str

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

pub fn secret_arn(&self) -> &str

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.

pub fn version(&self) -> &ConfluenceVersion

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

pub fn space_configuration(&self) -> Option<&ConfluenceSpaceConfiguration>

Configuration information for indexing Confluence spaces.

pub fn page_configuration(&self) -> Option<&ConfluencePageConfiguration>

Configuration information for indexing Confluence pages.

pub fn blog_configuration(&self) -> Option<&ConfluenceBlogConfiguration>

Configuration information for indexing Confluence blogs.

pub fn attachment_configuration( &self ) -> Option<&ConfluenceAttachmentConfiguration>

Configuration information for indexing attachments to Confluence blogs and pages.

pub fn vpc_configuration(&self) -> Option<&DataSourceVpcConfiguration>

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

pub fn inclusion_patterns(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inclusion_patterns.is_none().

pub fn exclusion_patterns(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclusion_patterns.is_none().

pub fn proxy_configuration(&self) -> Option<&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.

pub fn authentication_type(&self) -> Option<&ConfluenceAuthenticationType>

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.

impl ConfluenceConfiguration

pub fn builder() -> ConfluenceConfigurationBuilder

Creates a new builder-style object to manufacture ConfluenceConfiguration.

Trait Implementations

impl Clone for ConfluenceConfiguration

fn clone(&self) -> ConfluenceConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConfluenceConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ConfluenceConfiguration

fn eq(&self, other: &ConfluenceConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConfluenceConfiguration