Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration

Description

Documentation

data ConfluenceAttachmentConfiguration Source #

Configuration of attachment settings for the Confluence data source. Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.

See: newConfluenceAttachmentConfiguration smart constructor.

Constructors

ConfluenceAttachmentConfiguration'

Fields

attachmentFieldMappings :: Maybe (NonEmpty ConfluenceAttachmentToIndexFieldMapping)
Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.
crawlAttachments :: Maybe Bool
TRUE to index attachments of pages and blogs in Confluence.

Instances

Instances details

FromJSON ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods parseJSON :: Value -> Parser ConfluenceAttachmentConfiguration # parseJSONList :: Value -> Parser [ConfluenceAttachmentConfiguration] #
ToJSON ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods toJSON :: ConfluenceAttachmentConfiguration -> Value # toEncoding :: ConfluenceAttachmentConfiguration -> Encoding # toJSONList :: [ConfluenceAttachmentConfiguration] -> Value # toEncodingList :: [ConfluenceAttachmentConfiguration] -> Encoding #
Generic ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Associated Types type Rep ConfluenceAttachmentConfiguration :: Type -> Type # Methods from :: ConfluenceAttachmentConfiguration -> Rep ConfluenceAttachmentConfiguration x # to :: Rep ConfluenceAttachmentConfiguration x -> ConfluenceAttachmentConfiguration #
Read ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods readsPrec :: Int -> ReadS ConfluenceAttachmentConfiguration # readList :: ReadS [ConfluenceAttachmentConfiguration] # readPrec :: ReadPrec ConfluenceAttachmentConfiguration # readListPrec :: ReadPrec [ConfluenceAttachmentConfiguration] #
Show ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods showsPrec :: Int -> ConfluenceAttachmentConfiguration -> ShowS # show :: ConfluenceAttachmentConfiguration -> String # showList :: [ConfluenceAttachmentConfiguration] -> ShowS #
NFData ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods rnf :: ConfluenceAttachmentConfiguration -> () #
Eq ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods (==) :: ConfluenceAttachmentConfiguration -> ConfluenceAttachmentConfiguration -> Bool # (/=) :: ConfluenceAttachmentConfiguration -> ConfluenceAttachmentConfiguration -> Bool #
Hashable ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration Methods hashWithSalt :: Int -> ConfluenceAttachmentConfiguration -> Int # hash :: ConfluenceAttachmentConfiguration -> Int #
type Rep ConfluenceAttachmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration type Rep ConfluenceAttachmentConfiguration = D1 ('MetaData "ConfluenceAttachmentConfiguration" "Amazonka.Kendra.Types.ConfluenceAttachmentConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ConfluenceAttachmentConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attachmentFieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ConfluenceAttachmentToIndexFieldMapping))) :*: S1 ('MetaSel ('Just "crawlAttachments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newConfluenceAttachmentConfiguration :: ConfluenceAttachmentConfiguration Source #

Create a value of ConfluenceAttachmentConfiguration 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:attachmentFieldMappings:ConfluenceAttachmentConfiguration', confluenceAttachmentConfiguration_attachmentFieldMappings - Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

$sel:crawlAttachments:ConfluenceAttachmentConfiguration', confluenceAttachmentConfiguration_crawlAttachments - TRUE to index attachments of pages and blogs in Confluence.

confluenceAttachmentConfiguration_attachmentFieldMappings :: Lens' ConfluenceAttachmentConfiguration (Maybe (NonEmpty ConfluenceAttachmentToIndexFieldMapping)) Source #

Maps attributes or field names of Confluence attachments to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

confluenceAttachmentConfiguration_crawlAttachments :: Lens' ConfluenceAttachmentConfiguration (Maybe Bool) Source #

TRUE to index attachments of pages and blogs in Confluence.