Amazonka.Kendra.Types.ConfluenceConfiguration

Documentation

data ConfluenceConfiguration

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

See: newConfluenceConfiguration smart constructor.

Constructors

ConfluenceConfiguration'

Fields

• attachmentConfiguration :: Maybe ConfluenceAttachmentConfiguration

  Configuration information for indexing attachments to Confluence blogs and pages.

• authenticationType :: Maybe 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.

• blogConfiguration :: Maybe ConfluenceBlogConfiguration

  Configuration information for indexing Confluence blogs.

• exclusionPatterns :: Maybe [Text]

  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.

• inclusionPatterns :: Maybe [Text]

  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.

• pageConfiguration :: Maybe ConfluencePageConfiguration

  Configuration information for indexing Confluence pages.

• proxyConfiguration :: Maybe 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.

• spaceConfiguration :: Maybe ConfluenceSpaceConfiguration

  Configuration information for indexing Confluence spaces.

• vpcConfiguration :: Maybe DataSourceVpcConfiguration

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

• serverUrl :: Text

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

• secretArn :: Text

  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.

Instances

FromJSON ConfluenceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Methods

parseJSON :: Value -> Parser ConfluenceConfiguration

parseJSONList :: Value -> Parser [ConfluenceConfiguration]

ToJSON ConfluenceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Methods

toJSON :: ConfluenceConfiguration -> Value

toEncoding :: ConfluenceConfiguration -> Encoding

toJSONList :: [ConfluenceConfiguration] -> Value

toEncodingList :: [ConfluenceConfiguration] -> Encoding

Generic ConfluenceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Associated Types

type Rep ConfluenceConfiguration :: Type -> Type

Methods

from :: ConfluenceConfiguration -> Rep ConfluenceConfiguration x

to :: Rep ConfluenceConfiguration x -> ConfluenceConfiguration

Read ConfluenceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Methods

readsPrec :: Int -> ReadS ConfluenceConfiguration

readList :: ReadS [ConfluenceConfiguration]

readPrec :: ReadPrec ConfluenceConfiguration

readListPrec :: ReadPrec [ConfluenceConfiguration]

Show ConfluenceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Methods

showsPrec :: Int -> ConfluenceConfiguration -> ShowS

show :: ConfluenceConfiguration -> String

showList :: [ConfluenceConfiguration] -> ShowS

NFData ConfluenceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Methods

rnf :: ConfluenceConfiguration -> ()

Eq ConfluenceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Methods

(==) :: ConfluenceConfiguration -> ConfluenceConfiguration -> Bool

(/=) :: ConfluenceConfiguration -> ConfluenceConfiguration -> Bool

Hashable ConfluenceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

Methods

hashWithSalt :: Int -> ConfluenceConfiguration -> Int

hash :: ConfluenceConfiguration -> Int

type Rep ConfluenceConfiguration

Defined in Amazonka.Kendra.Types.ConfluenceConfiguration

type Rep ConfluenceConfiguration = D1 ('MetaData "ConfluenceConfiguration" "Amazonka.Kendra.Types.ConfluenceConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attachmentConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceAttachmentConfiguration)) :*: (S1 ('MetaSel ('Just "authenticationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceAuthenticationType)) :*: S1 ('MetaSel ('Just "blogConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceBlogConfiguration)))) :*: (S1 ('MetaSel ('Just "exclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "inclusionPatterns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "pageConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluencePageConfiguration))))) :*: ((S1 ('MetaSel ('Just "proxyConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProxyConfiguration)) :*: (S1 ('MetaSel ('Just "spaceConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConfluenceSpaceConfiguration)) :*: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceVpcConfiguration)))) :*: (S1 ('MetaSel ('Just "serverUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "secretArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ConfluenceVersion))))))

newConfluenceConfiguration

Arguments

:: Text

$sel:serverUrl:ConfluenceConfiguration'

-> Text

$sel:secretArn:ConfluenceConfiguration'

-> ConfluenceVersion

$sel:version:ConfluenceConfiguration'

-> ConfluenceConfiguration

Create a value of ConfluenceConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attachmentConfiguration:ConfluenceConfiguration', confluenceConfiguration_attachmentConfiguration - Configuration information for indexing attachments to Confluence blogs and pages.

$sel:authenticationType:ConfluenceConfiguration', confluenceConfiguration_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.

$sel:blogConfiguration:ConfluenceConfiguration', confluenceConfiguration_blogConfiguration - Configuration information for indexing Confluence blogs.

$sel:exclusionPatterns:ConfluenceConfiguration', confluenceConfiguration_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.

$sel:inclusionPatterns:ConfluenceConfiguration', confluenceConfiguration_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.

$sel:pageConfiguration:ConfluenceConfiguration', confluenceConfiguration_pageConfiguration - Configuration information for indexing Confluence pages.

$sel:proxyConfiguration:ConfluenceConfiguration', confluenceConfiguration_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.

$sel:spaceConfiguration:ConfluenceConfiguration', confluenceConfiguration_spaceConfiguration - Configuration information for indexing Confluence spaces.

$sel:vpcConfiguration:ConfluenceConfiguration', confluenceConfiguration_vpcConfiguration - Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence. For more information, see Configuring a VPC.

$sel:serverUrl:ConfluenceConfiguration', confluenceConfiguration_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/.

$sel:secretArn:ConfluenceConfiguration', confluenceConfiguration_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.

$sel:version:ConfluenceConfiguration', confluenceConfiguration_version - The version or the type of Confluence installation to connect to.

confluenceConfiguration_attachmentConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluenceAttachmentConfiguration)

Configuration information for indexing attachments to Confluence blogs and pages.

confluenceConfiguration_authenticationType :: Lens' ConfluenceConfiguration (Maybe 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.

confluenceConfiguration_blogConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluenceBlogConfiguration)

Configuration information for indexing Confluence blogs.

confluenceConfiguration_exclusionPatterns :: Lens' ConfluenceConfiguration (Maybe [Text])

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.

confluenceConfiguration_inclusionPatterns :: Lens' ConfluenceConfiguration (Maybe [Text])

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.

confluenceConfiguration_pageConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluencePageConfiguration)

Configuration information for indexing Confluence pages.

confluenceConfiguration_proxyConfiguration :: Lens' ConfluenceConfiguration (Maybe 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.

confluenceConfiguration_spaceConfiguration :: Lens' ConfluenceConfiguration (Maybe ConfluenceSpaceConfiguration)

Configuration information for indexing Confluence spaces.

confluenceConfiguration_vpcConfiguration :: Lens' ConfluenceConfiguration (Maybe DataSourceVpcConfiguration)

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

confluenceConfiguration_serverUrl :: Lens' ConfluenceConfiguration Text

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

confluenceConfiguration_secretArn :: Lens' ConfluenceConfiguration Text

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.

confluenceConfiguration_version :: Lens' ConfluenceConfiguration ConfluenceVersion

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