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

Description

Synopsis

Documentation

data ElasticsearchDestinationUpdate Source #

Describes an update for a destination in Amazon ES.

See: newElasticsearchDestinationUpdate smart constructor.

Constructors

ElasticsearchDestinationUpdate'

Fields

bufferingHints :: Maybe ElasticsearchBufferingHints
The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.
cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
The 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 IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Specify either ClusterEndpoint or DomainARN.
indexName :: Maybe Text
The Elasticsearch index name.
indexRotationPeriod :: Maybe ElasticsearchIndexRotationPeriod
The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. 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).
roleARN :: Maybe 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.
s3Update :: Maybe S3DestinationUpdate
The Amazon S3 destination.
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 runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Instances

Instances details

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

newElasticsearchDestinationUpdate :: ElasticsearchDestinationUpdate Source #

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

ElasticsearchDestinationUpdate, elasticsearchDestinationUpdate_bufferingHints - The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

ElasticsearchDestinationUpdate, elasticsearchDestinationUpdate_cloudWatchLoggingOptions - The CloudWatch logging options for your delivery stream.

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

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

Specify either ClusterEndpoint or DomainARN.

$sel:indexName:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_indexName - The Elasticsearch index name.

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

$sel:processingConfiguration:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_processingConfiguration - The data processing configuration.

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

ElasticsearchDestinationUpdate, elasticsearchDestinationUpdate_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:s3Update:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_s3Update - The Amazon S3 destination.

$sel:typeName:ElasticsearchDestinationUpdate', elasticsearchDestinationUpdate_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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

elasticsearchDestinationUpdate_bufferingHints :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchBufferingHints) Source #

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

elasticsearchDestinationUpdate_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #

The CloudWatch logging options for your delivery stream.

elasticsearchDestinationUpdate_clusterEndpoint :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #

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

elasticsearchDestinationUpdate_domainARN :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #

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

Specify either ClusterEndpoint or DomainARN.

elasticsearchDestinationUpdate_indexName :: Lens' ElasticsearchDestinationUpdate (Maybe Text) Source #

The Elasticsearch index name.

elasticsearchDestinationUpdate_indexRotationPeriod :: Lens' ElasticsearchDestinationUpdate (Maybe ElasticsearchIndexRotationPeriod) Source #

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

elasticsearchDestinationUpdate_processingConfiguration :: Lens' ElasticsearchDestinationUpdate (Maybe ProcessingConfiguration) Source #

The data processing configuration.

elasticsearchDestinationUpdate_retryOptions :: Lens' ElasticsearchDestinationUpdate (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).

elasticsearchDestinationUpdate_roleARN :: Lens' ElasticsearchDestinationUpdate (Maybe 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.

elasticsearchDestinationUpdate_s3Update :: Lens' ElasticsearchDestinationUpdate (Maybe S3DestinationUpdate) Source #

The Amazon S3 destination.

elasticsearchDestinationUpdate_typeName :: Lens' ElasticsearchDestinationUpdate (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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.