Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Documentation

data AmazonOpenSearchServerlessDestinationConfiguration

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

See: newAmazonOpenSearchServerlessDestinationConfiguration smart constructor.

Constructors

AmazonOpenSearchServerlessDestinationConfiguration'

Fields

• bufferingHints :: Maybe AmazonOpenSearchServerlessBufferingHints

  The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

• cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
• collectionEndpoint :: Maybe Text

  The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

• processingConfiguration :: Maybe ProcessingConfiguration
• retryOptions :: Maybe AmazonOpenSearchServerlessRetryOptions

  The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

• s3BackupMode :: Maybe AmazonOpenSearchServerlessS3BackupMode

  Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

• vpcConfiguration :: Maybe VpcConfiguration
• roleARN :: Text

  The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

• indexName :: Text

  The Serverless offering for Amazon OpenSearch Service index name.

• s3Configuration :: S3DestinationConfiguration

Instances

ToJSON AmazonOpenSearchServerlessDestinationConfiguration

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Methods

toJSON :: AmazonOpenSearchServerlessDestinationConfiguration -> Value

toEncoding :: AmazonOpenSearchServerlessDestinationConfiguration -> Encoding

toJSONList :: [AmazonOpenSearchServerlessDestinationConfiguration] -> Value

toEncodingList :: [AmazonOpenSearchServerlessDestinationConfiguration] -> Encoding

Generic AmazonOpenSearchServerlessDestinationConfiguration

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Associated Types

type Rep AmazonOpenSearchServerlessDestinationConfiguration :: Type -> Type

Methods

from :: AmazonOpenSearchServerlessDestinationConfiguration -> Rep AmazonOpenSearchServerlessDestinationConfiguration x

to :: Rep AmazonOpenSearchServerlessDestinationConfiguration x -> AmazonOpenSearchServerlessDestinationConfiguration

Read AmazonOpenSearchServerlessDestinationConfiguration

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Methods

readsPrec :: Int -> ReadS AmazonOpenSearchServerlessDestinationConfiguration

readList :: ReadS [AmazonOpenSearchServerlessDestinationConfiguration]

readPrec :: ReadPrec AmazonOpenSearchServerlessDestinationConfiguration

readListPrec :: ReadPrec [AmazonOpenSearchServerlessDestinationConfiguration]

Show AmazonOpenSearchServerlessDestinationConfiguration

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Methods

showsPrec :: Int -> AmazonOpenSearchServerlessDestinationConfiguration -> ShowS

show :: AmazonOpenSearchServerlessDestinationConfiguration -> String

showList :: [AmazonOpenSearchServerlessDestinationConfiguration] -> ShowS

NFData AmazonOpenSearchServerlessDestinationConfiguration

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Methods

rnf :: AmazonOpenSearchServerlessDestinationConfiguration -> ()

Eq AmazonOpenSearchServerlessDestinationConfiguration

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Methods

(==) :: AmazonOpenSearchServerlessDestinationConfiguration -> AmazonOpenSearchServerlessDestinationConfiguration -> Bool

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

Hashable AmazonOpenSearchServerlessDestinationConfiguration

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

Methods

hashWithSalt :: Int -> AmazonOpenSearchServerlessDestinationConfiguration -> Int

hash :: AmazonOpenSearchServerlessDestinationConfiguration -> Int

type Rep AmazonOpenSearchServerlessDestinationConfiguration

Defined in Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration

type Rep AmazonOpenSearchServerlessDestinationConfiguration = D1 ('MetaData "AmazonOpenSearchServerlessDestinationConfiguration" "Amazonka.Firehose.Types.AmazonOpenSearchServerlessDestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "AmazonOpenSearchServerlessDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessBufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "collectionEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessRetryOptions))))) :*: ((S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonOpenSearchServerlessS3BackupMode)) :*: S1 ('MetaSel ('Just "vpcConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfiguration))) :*: (S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationConfiguration))))))

newAmazonOpenSearchServerlessDestinationConfiguration

Arguments

:: Text

AmazonOpenSearchServerlessDestinationConfiguration

-> Text

$sel:indexName:AmazonOpenSearchServerlessDestinationConfiguration'

-> S3DestinationConfiguration

$sel:s3Configuration:AmazonOpenSearchServerlessDestinationConfiguration'

-> AmazonOpenSearchServerlessDestinationConfiguration

Create a value of AmazonOpenSearchServerlessDestinationConfiguration 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:

AmazonOpenSearchServerlessDestinationConfiguration, amazonOpenSearchServerlessDestinationConfiguration_bufferingHints - The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

AmazonOpenSearchServerlessDestinationConfiguration, amazonOpenSearchServerlessDestinationConfiguration_cloudWatchLoggingOptions - Undocumented member.

$sel:collectionEndpoint:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_collectionEndpoint - The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

$sel:processingConfiguration:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_processingConfiguration - Undocumented member.

$sel:retryOptions:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

$sel:s3BackupMode:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

$sel:vpcConfiguration:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_vpcConfiguration - Undocumented member.

AmazonOpenSearchServerlessDestinationConfiguration, amazonOpenSearchServerlessDestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

$sel:indexName:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_indexName - The Serverless offering for Amazon OpenSearch Service index name.

$sel:s3Configuration:AmazonOpenSearchServerlessDestinationConfiguration', amazonOpenSearchServerlessDestinationConfiguration_s3Configuration - Undocumented member.

amazonOpenSearchServerlessDestinationConfiguration_bufferingHints :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessBufferingHints)

The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

amazonOpenSearchServerlessDestinationConfiguration_cloudWatchLoggingOptions :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe CloudWatchLoggingOptions)

Undocumented member.

amazonOpenSearchServerlessDestinationConfiguration_collectionEndpoint :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe Text)

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

amazonOpenSearchServerlessDestinationConfiguration_processingConfiguration :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe ProcessingConfiguration)

Undocumented member.

amazonOpenSearchServerlessDestinationConfiguration_retryOptions :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessRetryOptions)

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).

amazonOpenSearchServerlessDestinationConfiguration_s3BackupMode :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe AmazonOpenSearchServerlessS3BackupMode)

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

amazonOpenSearchServerlessDestinationConfiguration_vpcConfiguration :: Lens' AmazonOpenSearchServerlessDestinationConfiguration (Maybe VpcConfiguration)

Undocumented member.

amazonOpenSearchServerlessDestinationConfiguration_roleARN :: Lens' AmazonOpenSearchServerlessDestinationConfiguration Text

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

amazonOpenSearchServerlessDestinationConfiguration_indexName :: Lens' AmazonOpenSearchServerlessDestinationConfiguration Text

The Serverless offering for Amazon OpenSearch Service index name.

amazonOpenSearchServerlessDestinationConfiguration_s3Configuration :: Lens' AmazonOpenSearchServerlessDestinationConfiguration S3DestinationConfiguration

Undocumented member.