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

Description

Synopsis

Documentation

data ElasticsearchDestinationConfiguration Source #

Describes the configuration of a destination in Amazon ES.

See: newElasticsearchDestinationConfiguration smart constructor.

Constructors

ElasticsearchDestinationConfiguration'

Fields

bufferingHints :: Maybe ElasticsearchBufferingHints
The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.
cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
The Amazon CloudWatch logging options for your delivery stream.
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 ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Specify either ClusterEndpoint or DomainARN.
indexRotationPeriod :: Maybe ElasticsearchIndexRotationPeriod
The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.
processingConfiguration :: Maybe ProcessingConfiguration
The data processing configuration.
retryOptions :: Maybe ElasticsearchRetryOptions
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).
s3BackupMode :: Maybe ElasticsearchS3BackupMode
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. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.
You can't change this backup mode after you create the delivery stream.
typeName :: Maybe Text
The Elasticsearch 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.
For Elasticsearch 7.x, don't specify a TypeName.
vpcConfiguration :: Maybe VpcConfiguration
The details of the VPC of the Amazon ES destination.
roleARN :: Text
The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
indexName :: Text
The Elasticsearch index name.
s3Configuration :: S3DestinationConfiguration
The configuration for the backup Amazon S3 location.

Instances

Instances details

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

newElasticsearchDestinationConfiguration Source #

Arguments

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

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

ElasticsearchDestinationConfiguration, elasticsearchDestinationConfiguration_bufferingHints - The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

ElasticsearchDestinationConfiguration, elasticsearchDestinationConfiguration_cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

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

$sel:domainARN:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

$sel:indexRotationPeriod:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.

$sel:processingConfiguration:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_processingConfiguration - The data processing configuration.

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

$sel:s3BackupMode:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_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. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.

You can't change this backup mode after you create the delivery stream.

$sel:typeName:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_typeName - The Elasticsearch 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.

For Elasticsearch 7.x, don't specify a TypeName.

$sel:vpcConfiguration:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_vpcConfiguration - The details of the VPC of the Amazon ES destination.

ElasticsearchDestinationConfiguration, elasticsearchDestinationConfiguration_roleARN - The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:indexName:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_indexName - The Elasticsearch index name.

$sel:s3Configuration:ElasticsearchDestinationConfiguration', elasticsearchDestinationConfiguration_s3Configuration - The configuration for the backup Amazon S3 location.

elasticsearchDestinationConfiguration_bufferingHints :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchBufferingHints) Source #

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

elasticsearchDestinationConfiguration_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe CloudWatchLoggingOptions) Source #

The Amazon CloudWatch logging options for your delivery stream.

elasticsearchDestinationConfiguration_clusterEndpoint :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #

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

elasticsearchDestinationConfiguration_domainARN :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

elasticsearchDestinationConfiguration_indexRotationPeriod :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchIndexRotationPeriod) Source #

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.

elasticsearchDestinationConfiguration_processingConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe ProcessingConfiguration) Source #

The data processing configuration.

elasticsearchDestinationConfiguration_retryOptions :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchRetryOptions) Source #

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

elasticsearchDestinationConfiguration_s3BackupMode :: Lens' ElasticsearchDestinationConfiguration (Maybe ElasticsearchS3BackupMode) 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. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.

You can't change this backup mode after you create the delivery stream.

elasticsearchDestinationConfiguration_typeName :: Lens' ElasticsearchDestinationConfiguration (Maybe Text) Source #

The Elasticsearch 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.

For Elasticsearch 7.x, don't specify a TypeName.

elasticsearchDestinationConfiguration_vpcConfiguration :: Lens' ElasticsearchDestinationConfiguration (Maybe VpcConfiguration) Source #

The details of the VPC of the Amazon ES destination.

elasticsearchDestinationConfiguration_roleARN :: Lens' ElasticsearchDestinationConfiguration Text Source #

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

elasticsearchDestinationConfiguration_indexName :: Lens' ElasticsearchDestinationConfiguration Text Source #

The Elasticsearch index name.

elasticsearchDestinationConfiguration_s3Configuration :: Lens' ElasticsearchDestinationConfiguration S3DestinationConfiguration Source #

The configuration for the backup Amazon S3 location.