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.Firehose.Types.AmazonopensearchserviceDestinationConfiguration

Description

Synopsis

Documentation

data AmazonopensearchserviceDestinationConfiguration Source #

Describes the configuration of a destination in Amazon OpenSearch Service

See: newAmazonopensearchserviceDestinationConfiguration smart constructor.

Constructors

AmazonopensearchserviceDestinationConfiguration'

Fields

bufferingHints :: Maybe AmazonopensearchserviceBufferingHints
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
clusterEndpoint :: Maybe Text
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
domainARN :: Maybe Text
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
indexRotationPeriod :: Maybe AmazonopensearchserviceIndexRotationPeriod
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
processingConfiguration :: Maybe ProcessingConfiguration
retryOptions :: Maybe AmazonopensearchserviceRetryOptions
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
s3BackupMode :: Maybe AmazonopensearchserviceS3BackupMode
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.
typeName :: Maybe Text
The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.
vpcConfiguration :: Maybe VpcConfiguration
roleARN :: Text
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
indexName :: Text
The ElasticsearAmazon OpenSearch Service index name.
s3Configuration :: S3DestinationConfiguration

Instances

Instances details

ToJSON AmazonopensearchserviceDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration Methods toJSON :: AmazonopensearchserviceDestinationConfiguration -> Value # toEncoding :: AmazonopensearchserviceDestinationConfiguration -> Encoding # toJSONList :: [AmazonopensearchserviceDestinationConfiguration] -> Value # toEncodingList :: [AmazonopensearchserviceDestinationConfiguration] -> Encoding #
Generic AmazonopensearchserviceDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration Associated Types type Rep AmazonopensearchserviceDestinationConfiguration :: Type -> Type # Methods from :: AmazonopensearchserviceDestinationConfiguration -> Rep AmazonopensearchserviceDestinationConfiguration x # to :: Rep AmazonopensearchserviceDestinationConfiguration x -> AmazonopensearchserviceDestinationConfiguration #
Read AmazonopensearchserviceDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration Methods readsPrec :: Int -> ReadS AmazonopensearchserviceDestinationConfiguration # readList :: ReadS [AmazonopensearchserviceDestinationConfiguration] # readPrec :: ReadPrec AmazonopensearchserviceDestinationConfiguration # readListPrec :: ReadPrec [AmazonopensearchserviceDestinationConfiguration] #
Show AmazonopensearchserviceDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration Methods showsPrec :: Int -> AmazonopensearchserviceDestinationConfiguration -> ShowS # show :: AmazonopensearchserviceDestinationConfiguration -> String # showList :: [AmazonopensearchserviceDestinationConfiguration] -> ShowS #
NFData AmazonopensearchserviceDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration Methods rnf :: AmazonopensearchserviceDestinationConfiguration -> () #
Eq AmazonopensearchserviceDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration Methods (==) :: AmazonopensearchserviceDestinationConfiguration -> AmazonopensearchserviceDestinationConfiguration -> Bool # (/=) :: AmazonopensearchserviceDestinationConfiguration -> AmazonopensearchserviceDestinationConfiguration -> Bool #
Hashable AmazonopensearchserviceDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration Methods hashWithSalt :: Int -> AmazonopensearchserviceDestinationConfiguration -> Int # hash :: AmazonopensearchserviceDestinationConfiguration -> Int #
type Rep AmazonopensearchserviceDestinationConfiguration Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration type Rep AmazonopensearchserviceDestinationConfiguration = D1 ('MetaData "AmazonopensearchserviceDestinationConfiguration" "Amazonka.Firehose.Types.AmazonopensearchserviceDestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "AmazonopensearchserviceDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceBufferingHints)) :: (S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions)) :: S1 ('MetaSel ('Just "clusterEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "domainARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "indexRotationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceIndexRotationPeriod)) :: S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration))))) :: ((S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceRetryOptions)) :: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AmazonopensearchserviceS3BackupMode)) :: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((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))))))

newAmazonopensearchserviceDestinationConfiguration Source #

Arguments

:: Text	`AmazonopensearchserviceDestinationConfiguration`
-> Text	`$sel:indexName:AmazonopensearchserviceDestinationConfiguration'`
-> S3DestinationConfiguration	`$sel:s3Configuration:AmazonopensearchserviceDestinationConfiguration'`
-> AmazonopensearchserviceDestinationConfiguration

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

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

AmazonopensearchserviceDestinationConfiguration, amazonopensearchserviceDestinationConfiguration_cloudWatchLoggingOptions - Undocumented member.

$sel:clusterEndpoint:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_clusterEndpoint - The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

$sel:domainARN:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_domainARN - The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.

$sel:indexRotationPeriod:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_indexRotationPeriod - The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

$sel:processingConfiguration:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_processingConfiguration - Undocumented member.

$sel:retryOptions:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_retryOptions - The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).

$sel:s3BackupMode:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_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:typeName:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_typeName - The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.

$sel:vpcConfiguration:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_vpcConfiguration - Undocumented member.

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

$sel:indexName:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_indexName - The ElasticsearAmazon OpenSearch Service index name.

$sel:s3Configuration:AmazonopensearchserviceDestinationConfiguration', amazonopensearchserviceDestinationConfiguration_s3Configuration - Undocumented member.

amazonopensearchserviceDestinationConfiguration_bufferingHints :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceBufferingHints) Source #

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

amazonopensearchserviceDestinationConfiguration_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #

Undocumented member.

amazonopensearchserviceDestinationConfiguration_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

amazonopensearchserviceDestinationConfiguration_domainARN :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.

amazonopensearchserviceDestinationConfiguration_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceIndexRotationPeriod) Source #

The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

amazonopensearchserviceDestinationConfiguration_processingConfiguration :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe ProcessingConfiguration) Source #

Undocumented member.

amazonopensearchserviceDestinationConfiguration_retryOptions :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceRetryOptions) Source #

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

amazonopensearchserviceDestinationConfiguration_s3BackupMode :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe AmazonopensearchserviceS3BackupMode) Source #

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.

amazonopensearchserviceDestinationConfiguration_typeName :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe Text) Source #

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.

amazonopensearchserviceDestinationConfiguration_vpcConfiguration :: Lens' AmazonopensearchserviceDestinationConfiguration (Maybe VpcConfiguration) Source #

Undocumented member.

amazonopensearchserviceDestinationConfiguration_roleARN :: Lens' AmazonopensearchserviceDestinationConfiguration Text Source #

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

amazonopensearchserviceDestinationConfiguration_indexName :: Lens' AmazonopensearchserviceDestinationConfiguration Text Source #

The ElasticsearAmazon OpenSearch Service index name.

amazonopensearchserviceDestinationConfiguration_s3Configuration :: Lens' AmazonopensearchserviceDestinationConfiguration S3DestinationConfiguration Source #

Undocumented member.