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

Description

Synopsis

Documentation

data ElasticsearchDestinationDescription Source #

The destination description in Amazon ES.

See: newElasticsearchDestinationDescription smart constructor.

Constructors

ElasticsearchDestinationDescription'

Fields

bufferingHints :: Maybe ElasticsearchBufferingHints
The buffering options.
cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
The Amazon CloudWatch logging options.
clusterEndpoint :: Maybe Text
The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.
domainARN :: Maybe Text
The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
indexName :: Maybe Text
The Elasticsearch index name.
indexRotationPeriod :: Maybe ElasticsearchIndexRotationPeriod
The Elasticsearch index rotation period
processingConfiguration :: Maybe ProcessingConfiguration
The data processing configuration.
retryOptions :: Maybe ElasticsearchRetryOptions
The Amazon ES retry options.
roleARN :: Maybe Text
The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
s3BackupMode :: Maybe ElasticsearchS3BackupMode
The Amazon S3 backup mode.
s3DestinationDescription :: Maybe S3DestinationDescription
The Amazon S3 destination.
typeName :: Maybe Text
The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
vpcConfigurationDescription :: Maybe VpcConfigurationDescription
The details of the VPC of the Amazon ES destination.

Instances

Instances details

FromJSON ElasticsearchDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription Methods parseJSON :: Value -> Parser ElasticsearchDestinationDescription # parseJSONList :: Value -> Parser [ElasticsearchDestinationDescription] #
Generic ElasticsearchDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription Associated Types type Rep ElasticsearchDestinationDescription :: Type -> Type # Methods from :: ElasticsearchDestinationDescription -> Rep ElasticsearchDestinationDescription x # to :: Rep ElasticsearchDestinationDescription x -> ElasticsearchDestinationDescription #
Read ElasticsearchDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription Methods readsPrec :: Int -> ReadS ElasticsearchDestinationDescription # readList :: ReadS [ElasticsearchDestinationDescription] # readPrec :: ReadPrec ElasticsearchDestinationDescription # readListPrec :: ReadPrec [ElasticsearchDestinationDescription] #
Show ElasticsearchDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription Methods showsPrec :: Int -> ElasticsearchDestinationDescription -> ShowS # show :: ElasticsearchDestinationDescription -> String # showList :: [ElasticsearchDestinationDescription] -> ShowS #
NFData ElasticsearchDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription Methods rnf :: ElasticsearchDestinationDescription -> () #
Eq ElasticsearchDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription Methods (==) :: ElasticsearchDestinationDescription -> ElasticsearchDestinationDescription -> Bool # (/=) :: ElasticsearchDestinationDescription -> ElasticsearchDestinationDescription -> Bool #
Hashable ElasticsearchDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription Methods hashWithSalt :: Int -> ElasticsearchDestinationDescription -> Int # hash :: ElasticsearchDestinationDescription -> Int #
type Rep ElasticsearchDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.ElasticsearchDestinationDescription type Rep ElasticsearchDestinationDescription = D1 ('MetaData "ElasticsearchDestinationDescription" "Amazonka.Firehose.Types.ElasticsearchDestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "ElasticsearchDestinationDescription'" '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 "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ElasticsearchS3BackupMode)) :: S1 ('MetaSel ('Just "s3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription))) :: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "vpcConfigurationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConfigurationDescription)))))))

newElasticsearchDestinationDescription :: ElasticsearchDestinationDescription Source #

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

ElasticsearchDestinationDescription, elasticsearchDestinationDescription_bufferingHints - The buffering options.

ElasticsearchDestinationDescription, elasticsearchDestinationDescription_cloudWatchLoggingOptions - The Amazon CloudWatch logging options.

$sel:clusterEndpoint:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_clusterEndpoint - The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

$sel:domainARN:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_domainARN - The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

$sel:indexName:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_indexName - The Elasticsearch index name.

$sel:indexRotationPeriod:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_indexRotationPeriod - The Elasticsearch index rotation period

$sel:processingConfiguration:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_processingConfiguration - The data processing configuration.

$sel:retryOptions:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_retryOptions - The Amazon ES retry options.

ElasticsearchDestinationDescription, elasticsearchDestinationDescription_roleARN - The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

$sel:s3BackupMode:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_s3BackupMode - The Amazon S3 backup mode.

$sel:s3DestinationDescription:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_s3DestinationDescription - The Amazon S3 destination.

$sel:typeName:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_typeName - The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

$sel:vpcConfigurationDescription:ElasticsearchDestinationDescription', elasticsearchDestinationDescription_vpcConfigurationDescription - The details of the VPC of the Amazon ES destination.

elasticsearchDestinationDescription_bufferingHints :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchBufferingHints) Source #

The buffering options.

elasticsearchDestinationDescription_cloudWatchLoggingOptions :: Lens' ElasticsearchDestinationDescription (Maybe CloudWatchLoggingOptions) Source #

The Amazon CloudWatch logging options.

elasticsearchDestinationDescription_clusterEndpoint :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #

The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

elasticsearchDestinationDescription_domainARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #

The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

elasticsearchDestinationDescription_indexName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #

The Elasticsearch index name.

elasticsearchDestinationDescription_indexRotationPeriod :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchIndexRotationPeriod) Source #

The Elasticsearch index rotation period

elasticsearchDestinationDescription_processingConfiguration :: Lens' ElasticsearchDestinationDescription (Maybe ProcessingConfiguration) Source #

The data processing configuration.

elasticsearchDestinationDescription_retryOptions :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchRetryOptions) Source #

The Amazon ES retry options.

elasticsearchDestinationDescription_roleARN :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

elasticsearchDestinationDescription_s3BackupMode :: Lens' ElasticsearchDestinationDescription (Maybe ElasticsearchS3BackupMode) Source #

The Amazon S3 backup mode.

elasticsearchDestinationDescription_s3DestinationDescription :: Lens' ElasticsearchDestinationDescription (Maybe S3DestinationDescription) Source #

The Amazon S3 destination.

elasticsearchDestinationDescription_typeName :: Lens' ElasticsearchDestinationDescription (Maybe Text) Source #

The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

elasticsearchDestinationDescription_vpcConfigurationDescription :: Lens' ElasticsearchDestinationDescription (Maybe VpcConfigurationDescription) Source #

The details of the VPC of the Amazon ES destination.