ConfluenceConfiguration.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>, SdkBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>, SdkPojo

Enclosing class:

ConfluenceConfiguration
```
public static interface ConfluenceConfiguration.Builder
extends SdkPojo, CopyableBuilder<ConfluenceConfiguration.Builder,ConfluenceConfiguration>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`ConfluenceConfiguration.Builder`	`attachmentConfiguration(ConfluenceAttachmentConfiguration attachmentConfiguration)` Configuration information for indexing attachments to Confluence blogs and pages.
`default ConfluenceConfiguration.Builder`	`attachmentConfiguration(Consumer<ConfluenceAttachmentConfiguration.Builder> attachmentConfiguration)` Configuration information for indexing attachments to Confluence blogs and pages.
`ConfluenceConfiguration.Builder`	`authenticationType(ConfluenceAuthenticationType authenticationType)` Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token.
`ConfluenceConfiguration.Builder`	`authenticationType(String authenticationType)` Whether you want to connect to Confluence using basic authentication of user name and password, or a personal access token.
`ConfluenceConfiguration.Builder`	`blogConfiguration(ConfluenceBlogConfiguration blogConfiguration)` Configuration information for indexing Confluence blogs.
`default ConfluenceConfiguration.Builder`	`blogConfiguration(Consumer<ConfluenceBlogConfiguration.Builder> blogConfiguration)` Configuration information for indexing Confluence blogs.
`ConfluenceConfiguration.Builder`	`exclusionPatterns(Collection<String> exclusionPatterns)` A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.
`ConfluenceConfiguration.Builder`	`exclusionPatterns(String... exclusionPatterns)` A list of regular expression patterns to exclude certain blog posts, pages, spaces, or attachments in your Confluence.
`ConfluenceConfiguration.Builder`	`inclusionPatterns(Collection<String> inclusionPatterns)` A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.
`ConfluenceConfiguration.Builder`	`inclusionPatterns(String... inclusionPatterns)` A list of regular expression patterns to include certain blog posts, pages, spaces, or attachments in your Confluence.
`ConfluenceConfiguration.Builder`	`pageConfiguration(ConfluencePageConfiguration pageConfiguration)` Configuration information for indexing Confluence pages.
`default ConfluenceConfiguration.Builder`	`pageConfiguration(Consumer<ConfluencePageConfiguration.Builder> pageConfiguration)` Configuration information for indexing Confluence pages.
`default ConfluenceConfiguration.Builder`	`proxyConfiguration(Consumer<ProxyConfiguration.Builder> proxyConfiguration)` Configuration information to connect to your Confluence URL instance via a web proxy.
`ConfluenceConfiguration.Builder`	`proxyConfiguration(ProxyConfiguration proxyConfiguration)` Configuration information to connect to your Confluence URL instance via a web proxy.
`ConfluenceConfiguration.Builder`	`secretArn(String 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.
`ConfluenceConfiguration.Builder`	`serverUrl(String serverUrl)` The URL of your Confluence instance.
`ConfluenceConfiguration.Builder`	`spaceConfiguration(ConfluenceSpaceConfiguration spaceConfiguration)` Configuration information for indexing Confluence spaces.
`default ConfluenceConfiguration.Builder`	`spaceConfiguration(Consumer<ConfluenceSpaceConfiguration.Builder> spaceConfiguration)` Configuration information for indexing Confluence spaces.
`ConfluenceConfiguration.Builder`	`version(ConfluenceVersion version)` The version or the type of Confluence installation to connect to.
`ConfluenceConfiguration.Builder`	`version(String version)` The version or the type of Confluence installation to connect to.
`default ConfluenceConfiguration.Builder`	`vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)` Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.
`ConfluenceConfiguration.Builder`	`vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)` Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - serverUrl
```
ConfluenceConfiguration.Builder serverUrl(String 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/.
    
    Parameters:
    
    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/.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - secretArn
```
ConfluenceConfiguration.Builder secretArn(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - version
```
ConfluenceConfiguration.Builder version(String version)
```
    The version or the type of Confluence installation to connect to.
    
    Parameters:
    
    version - The version or the type of Confluence installation to connect to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConfluenceVersion, ConfluenceVersion
  - version
```
ConfluenceConfiguration.Builder version(ConfluenceVersion version)
```
    The version or the type of Confluence installation to connect to.
    
    Parameters:
    
    version - The version or the type of Confluence installation to connect to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConfluenceVersion, ConfluenceVersion
  - spaceConfiguration
```
ConfluenceConfiguration.Builder spaceConfiguration(ConfluenceSpaceConfiguration spaceConfiguration)
```
    Configuration information for indexing Confluence spaces.
    
    Parameters:
    
    spaceConfiguration - Configuration information for indexing Confluence spaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - spaceConfiguration
```
default ConfluenceConfiguration.Builder spaceConfiguration(Consumer<ConfluenceSpaceConfiguration.Builder> spaceConfiguration)
```
    Configuration information for indexing Confluence spaces.
    This is a convenience method that creates an instance of the ConfluenceSpaceConfiguration.Builder avoiding the need to create one manually via ConfluenceSpaceConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to spaceConfiguration(ConfluenceSpaceConfiguration).
    
    Parameters:
    
    spaceConfiguration - a consumer that will call methods on ConfluenceSpaceConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    spaceConfiguration(ConfluenceSpaceConfiguration)
  - pageConfiguration
```
ConfluenceConfiguration.Builder pageConfiguration(ConfluencePageConfiguration pageConfiguration)
```
    Configuration information for indexing Confluence pages.
    
    Parameters:
    
    pageConfiguration - Configuration information for indexing Confluence pages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - pageConfiguration
```
default ConfluenceConfiguration.Builder pageConfiguration(Consumer<ConfluencePageConfiguration.Builder> pageConfiguration)
```
    Configuration information for indexing Confluence pages.
    This is a convenience method that creates an instance of the ConfluencePageConfiguration.Builder avoiding the need to create one manually via ConfluencePageConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to pageConfiguration(ConfluencePageConfiguration).
    
    Parameters:
    
    pageConfiguration - a consumer that will call methods on ConfluencePageConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    pageConfiguration(ConfluencePageConfiguration)
  - blogConfiguration
```
ConfluenceConfiguration.Builder blogConfiguration(ConfluenceBlogConfiguration blogConfiguration)
```
    Configuration information for indexing Confluence blogs.
    
    Parameters:
    
    blogConfiguration - Configuration information for indexing Confluence blogs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - blogConfiguration
```
default ConfluenceConfiguration.Builder blogConfiguration(Consumer<ConfluenceBlogConfiguration.Builder> blogConfiguration)
```
    Configuration information for indexing Confluence blogs.
    This is a convenience method that creates an instance of the ConfluenceBlogConfiguration.Builder avoiding the need to create one manually via ConfluenceBlogConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to blogConfiguration(ConfluenceBlogConfiguration).
    
    Parameters:
    
    blogConfiguration - a consumer that will call methods on ConfluenceBlogConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    blogConfiguration(ConfluenceBlogConfiguration)
  - attachmentConfiguration
```
ConfluenceConfiguration.Builder attachmentConfiguration(ConfluenceAttachmentConfiguration attachmentConfiguration)
```
    Configuration information for indexing attachments to Confluence blogs and pages.
    
    Parameters:
    
    attachmentConfiguration - Configuration information for indexing attachments to Confluence blogs and pages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - attachmentConfiguration
```
default ConfluenceConfiguration.Builder attachmentConfiguration(Consumer<ConfluenceAttachmentConfiguration.Builder> attachmentConfiguration)
```
    Configuration information for indexing attachments to Confluence blogs and pages.
    This is a convenience method that creates an instance of the ConfluenceAttachmentConfiguration.Builder avoiding the need to create one manually via ConfluenceAttachmentConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to attachmentConfiguration(ConfluenceAttachmentConfiguration).
    
    Parameters:
    
    attachmentConfiguration - a consumer that will call methods on ConfluenceAttachmentConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    attachmentConfiguration(ConfluenceAttachmentConfiguration)
  - vpcConfiguration
```
ConfluenceConfiguration.Builder vpcConfiguration(DataSourceVpcConfiguration vpcConfiguration)
```
    Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.
    
    Parameters:
    
    vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcConfiguration
```
default ConfluenceConfiguration.Builder vpcConfiguration(Consumer<DataSourceVpcConfiguration.Builder> vpcConfiguration)
```
    Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.
    This is a convenience method that creates an instance of the DataSourceVpcConfiguration.Builder avoiding the need to create one manually via DataSourceVpcConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(DataSourceVpcConfiguration).
    
    Parameters:
    
    vpcConfiguration - a consumer that will call methods on DataSourceVpcConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    vpcConfiguration(DataSourceVpcConfiguration)
  - inclusionPatterns
```
ConfluenceConfiguration.Builder inclusionPatterns(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - inclusionPatterns
```
ConfluenceConfiguration.Builder inclusionPatterns(String... 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - exclusionPatterns
```
ConfluenceConfiguration.Builder exclusionPatterns(Collection<String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - exclusionPatterns
```
ConfluenceConfiguration.Builder exclusionPatterns(String... 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - proxyConfiguration
```
ConfluenceConfiguration.Builder proxyConfiguration(ProxyConfiguration 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - proxyConfiguration
```
default ConfluenceConfiguration.Builder proxyConfiguration(Consumer<ProxyConfiguration.Builder> 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.
    This is a convenience method that creates an instance of the ProxyConfiguration.Builder avoiding the need to create one manually via ProxyConfiguration.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to proxyConfiguration(ProxyConfiguration).
    
    Parameters:
    
    proxyConfiguration - a consumer that will call methods on ProxyConfiguration.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    proxyConfiguration(ProxyConfiguration)
  - authenticationType
```
ConfluenceConfiguration.Builder authenticationType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConfluenceAuthenticationType, ConfluenceAuthenticationType
  - authenticationType
```
ConfluenceConfiguration.Builder authenticationType(ConfluenceAuthenticationType 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConfluenceAuthenticationType, ConfluenceAuthenticationType

Interface ConfluenceConfiguration.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

serverUrl

secretArn

version

version

spaceConfiguration

spaceConfiguration

pageConfiguration

pageConfiguration

blogConfiguration

blogConfiguration

attachmentConfiguration

attachmentConfiguration

vpcConfiguration

vpcConfiguration

inclusionPatterns

inclusionPatterns

exclusionPatterns

exclusionPatterns

proxyConfiguration

proxyConfiguration

authenticationType

authenticationType