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

Description

Synopsis

Documentation

data AmazonopensearchserviceDestinationUpdate Source #

Describes an update for a destination in Amazon OpenSearch Service.

See: newAmazonopensearchserviceDestinationUpdate smart constructor.

Constructors

AmazonopensearchserviceDestinationUpdate'

Fields

bufferingHints :: Maybe AmazonopensearchserviceBufferingHints
The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values 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 DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
indexName :: Maybe Text
The Amazon OpenSearch Service index name.
indexRotationPeriod :: Maybe AmazonopensearchserviceIndexRotationPeriod
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to 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).
roleARN :: Maybe 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.
s3Update :: Maybe S3DestinationUpdate
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 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 AmazonopensearchserviceDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate Methods toJSON :: AmazonopensearchserviceDestinationUpdate -> Value # toEncoding :: AmazonopensearchserviceDestinationUpdate -> Encoding # toJSONList :: [AmazonopensearchserviceDestinationUpdate] -> Value # toEncodingList :: [AmazonopensearchserviceDestinationUpdate] -> Encoding #
Generic AmazonopensearchserviceDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate Associated Types type Rep AmazonopensearchserviceDestinationUpdate :: Type -> Type # Methods from :: AmazonopensearchserviceDestinationUpdate -> Rep AmazonopensearchserviceDestinationUpdate x # to :: Rep AmazonopensearchserviceDestinationUpdate x -> AmazonopensearchserviceDestinationUpdate #
Read AmazonopensearchserviceDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate Methods readsPrec :: Int -> ReadS AmazonopensearchserviceDestinationUpdate # readList :: ReadS [AmazonopensearchserviceDestinationUpdate] # readPrec :: ReadPrec AmazonopensearchserviceDestinationUpdate # readListPrec :: ReadPrec [AmazonopensearchserviceDestinationUpdate] #
Show AmazonopensearchserviceDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate Methods showsPrec :: Int -> AmazonopensearchserviceDestinationUpdate -> ShowS # show :: AmazonopensearchserviceDestinationUpdate -> String # showList :: [AmazonopensearchserviceDestinationUpdate] -> ShowS #
NFData AmazonopensearchserviceDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate Methods rnf :: AmazonopensearchserviceDestinationUpdate -> () #
Eq AmazonopensearchserviceDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate Methods (==) :: AmazonopensearchserviceDestinationUpdate -> AmazonopensearchserviceDestinationUpdate -> Bool # (/=) :: AmazonopensearchserviceDestinationUpdate -> AmazonopensearchserviceDestinationUpdate -> Bool #
Hashable AmazonopensearchserviceDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate Methods hashWithSalt :: Int -> AmazonopensearchserviceDestinationUpdate -> Int # hash :: AmazonopensearchserviceDestinationUpdate -> Int #
type Rep AmazonopensearchserviceDestinationUpdate Source #
Instance details Defined in Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate type Rep AmazonopensearchserviceDestinationUpdate = D1 ('MetaData "AmazonopensearchserviceDestinationUpdate" "Amazonka.Firehose.Types.AmazonopensearchserviceDestinationUpdate" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "AmazonopensearchserviceDestinationUpdate'" '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 "indexName") '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 "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)))))))

newAmazonopensearchserviceDestinationUpdate :: AmazonopensearchserviceDestinationUpdate Source #

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

AmazonopensearchserviceDestinationUpdate, amazonopensearchserviceDestinationUpdate_bufferingHints - The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.

AmazonopensearchserviceDestinationUpdate, amazonopensearchserviceDestinationUpdate_cloudWatchLoggingOptions - Undocumented member.

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

$sel:domainARN:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_domainARN - The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.

$sel:indexName:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_indexName - The Amazon OpenSearch Service index name.

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

$sel:processingConfiguration:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_processingConfiguration - Undocumented member.

$sel:retryOptions:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_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).

AmazonopensearchserviceDestinationUpdate, amazonopensearchserviceDestinationUpdate_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:s3Update:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_s3Update - Undocumented member.

$sel:typeName:AmazonopensearchserviceDestinationUpdate', amazonopensearchserviceDestinationUpdate_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 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.

amazonopensearchserviceDestinationUpdate_bufferingHints :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceBufferingHints) Source #

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

amazonopensearchserviceDestinationUpdate_cloudWatchLoggingOptions :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe CloudWatchLoggingOptions) Source #

Undocumented member.

amazonopensearchserviceDestinationUpdate_clusterEndpoint :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #

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

amazonopensearchserviceDestinationUpdate_domainARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #

The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.

amazonopensearchserviceDestinationUpdate_indexName :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe Text) Source #

The Amazon OpenSearch Service index name.

amazonopensearchserviceDestinationUpdate_indexRotationPeriod :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe AmazonopensearchserviceIndexRotationPeriod) Source #

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

amazonopensearchserviceDestinationUpdate_processingConfiguration :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe ProcessingConfiguration) Source #

Undocumented member.

amazonopensearchserviceDestinationUpdate_retryOptions :: Lens' AmazonopensearchserviceDestinationUpdate (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).

amazonopensearchserviceDestinationUpdate_roleARN :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe 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.

amazonopensearchserviceDestinationUpdate_s3Update :: Lens' AmazonopensearchserviceDestinationUpdate (Maybe S3DestinationUpdate) Source #

Undocumented member.

amazonopensearchserviceDestinationUpdate_typeName :: Lens' AmazonopensearchserviceDestinationUpdate (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 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.