Struct ConfluenceConfigurationBuilder 

#[non_exhaustive]
pub struct ConfluenceConfigurationBuilder { /* private fields */ }

A builder for ConfluenceConfiguration.

Implementations

impl ConfluenceConfigurationBuilder

pub fn server_url(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_server_url(self, input: Option<String>) -> Self

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 get_server_url(&self) -> &Option<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/.

pub fn secret_arn(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_secret_arn(self, input: Option<String>) -> Self

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 get_secret_arn(&self) -> &Option<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.

pub fn version(self, input: ConfluenceVersion) -> Self

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

This field is required.

pub fn set_version(self, input: Option<ConfluenceVersion>) -> Self

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

pub fn get_version(&self) -> &Option<ConfluenceVersion>

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

pub fn space_configuration(self, input: ConfluenceSpaceConfiguration) -> Self

Configuration information for indexing Confluence spaces.

pub fn set_space_configuration( self, input: Option<ConfluenceSpaceConfiguration>, ) -> Self

Configuration information for indexing Confluence spaces.

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

Configuration information for indexing Confluence spaces.

pub fn page_configuration(self, input: ConfluencePageConfiguration) -> Self

Configuration information for indexing Confluence pages.

pub fn set_page_configuration( self, input: Option<ConfluencePageConfiguration>, ) -> Self

Configuration information for indexing Confluence pages.

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

Configuration information for indexing Confluence pages.

pub fn blog_configuration(self, input: ConfluenceBlogConfiguration) -> Self

Configuration information for indexing Confluence blogs.

pub fn set_blog_configuration( self, input: Option<ConfluenceBlogConfiguration>, ) -> Self

Configuration information for indexing Confluence blogs.

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

Configuration information for indexing Confluence blogs.

pub fn attachment_configuration( self, input: ConfluenceAttachmentConfiguration, ) -> Self

Configuration information for indexing attachments to Confluence blogs and pages.

pub fn set_attachment_configuration( self, input: Option<ConfluenceAttachmentConfiguration>, ) -> Self

Configuration information for indexing attachments to Confluence blogs and pages.

pub fn get_attachment_configuration( &self, ) -> &Option<ConfluenceAttachmentConfiguration>

Configuration information for indexing attachments to Confluence blogs and pages.

pub fn vpc_configuration(self, input: DataSourceVpcConfiguration) -> Self

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

pub fn set_vpc_configuration( self, input: Option<DataSourceVpcConfiguration>, ) -> Self

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

pub fn get_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, input: impl Into<String>) -> Self

Appends an item to inclusion_patterns.

To override the contents of this collection use set_inclusion_patterns.

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.

pub fn set_inclusion_patterns(self, input: Option<Vec<String>>) -> Self

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.

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

pub fn exclusion_patterns(self, input: impl Into<String>) -> Self

Appends an item to exclusion_patterns.

To override the contents of this collection use set_exclusion_patterns.

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.

pub fn set_exclusion_patterns(self, input: Option<Vec<String>>) -> Self

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.

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

pub fn proxy_configuration(self, input: ProxyConfiguration) -> Self

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 set_proxy_configuration(self, input: Option<ProxyConfiguration>) -> Self

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 get_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, input: ConfluenceAuthenticationType) -> Self

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.

pub fn set_authentication_type( self, input: Option<ConfluenceAuthenticationType>, ) -> Self

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.

pub fn get_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.

pub fn build(self) -> Result<ConfluenceConfiguration, BuildError>

Consumes the builder and constructs a ConfluenceConfiguration. This method will fail if any of the following fields are not set:

• server_url
• secret_arn
• version

Trait Implementations

impl Clone for ConfluenceConfigurationBuilder

fn clone(&self) -> ConfluenceConfigurationBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfluenceConfigurationBuilder

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

Formats the value using the given formatter.

impl Default for ConfluenceConfigurationBuilder

fn default() -> ConfluenceConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for ConfluenceConfigurationBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ConfluenceConfigurationBuilder