Stratosphere.ResourceProperties.KinesisFirehoseElasticsearchDestinationConfiguration

ElasticsearchDestinationConfiguration is a property of the AWS::KinesisFirehose::DeliveryStream resource that specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Firehose (Firehose) delivers data to.

Documentation

data KinesisFirehoseElasticsearchDestinationConfiguration

Full data type definition for KinesisFirehoseElasticsearchDestinationConfiguration. See kinesisFirehoseElasticsearchDestinationConfiguration for a more convenient constructor.

Constructors

KinesisFirehoseElasticsearchDestinationConfiguration

Fields

• _kinesisFirehoseElasticsearchDestinationConfigurationBufferingHints :: KinesisFirehoseBufferingHints
• _kinesisFirehoseElasticsearchDestinationConfigurationCloudWatchLoggingOptions :: Maybe KinesisFirehoseCloudWatchLoggingOptions
• _kinesisFirehoseElasticsearchDestinationConfigurationDomainARN :: Val Text
• _kinesisFirehoseElasticsearchDestinationConfigurationIndexName :: Val Text
• _kinesisFirehoseElasticsearchDestinationConfigurationIndexRotationPeriod :: Val Text
• _kinesisFirehoseElasticsearchDestinationConfigurationRetryOptions :: Maybe KinesisFirehoseElasticsearchRetryOptions
• _kinesisFirehoseElasticsearchDestinationConfigurationRoleARN :: Val Text
• _kinesisFirehoseElasticsearchDestinationConfigurationS3BackupMode :: KinesisFirehoseElasticsearchS3BackupMode
• _kinesisFirehoseElasticsearchDestinationConfigurationS3Configuration :: Maybe KinesisFirehoseS3DestinationConfiguration
• _kinesisFirehoseElasticsearchDestinationConfigurationTypeName :: Val Text

Instances

Show KinesisFirehoseElasticsearchDestinationConfiguration

Methods

showsPrec :: Int -> KinesisFirehoseElasticsearchDestinationConfiguration -> ShowS

show :: KinesisFirehoseElasticsearchDestinationConfiguration -> String

showList :: [KinesisFirehoseElasticsearchDestinationConfiguration] -> ShowS

Generic KinesisFirehoseElasticsearchDestinationConfiguration

Associated Types

type Rep KinesisFirehoseElasticsearchDestinationConfiguration :: * -> *

Methods

from :: KinesisFirehoseElasticsearchDestinationConfiguration -> Rep KinesisFirehoseElasticsearchDestinationConfiguration x

to :: Rep KinesisFirehoseElasticsearchDestinationConfiguration x -> KinesisFirehoseElasticsearchDestinationConfiguration

ToJSON KinesisFirehoseElasticsearchDestinationConfiguration

Methods

toJSON :: KinesisFirehoseElasticsearchDestinationConfiguration -> Value

toEncoding :: KinesisFirehoseElasticsearchDestinationConfiguration -> Encoding

toJSONList :: [KinesisFirehoseElasticsearchDestinationConfiguration] -> Value

toEncodingList :: [KinesisFirehoseElasticsearchDestinationConfiguration] -> Encoding

FromJSON KinesisFirehoseElasticsearchDestinationConfiguration

Methods

parseJSON :: Value -> Parser KinesisFirehoseElasticsearchDestinationConfiguration

parseJSONList :: Value -> Parser [KinesisFirehoseElasticsearchDestinationConfiguration]

type Rep KinesisFirehoseElasticsearchDestinationConfiguration

type Rep KinesisFirehoseElasticsearchDestinationConfiguration = D1 (MetaData "KinesisFirehoseElasticsearchDestinationConfiguration" "Stratosphere.ResourceProperties.KinesisFirehoseElasticsearchDestinationConfiguration" "stratosphere-0.2.0-B1WeL9cnxuQ3qer3csMa6f" False) (C1 (MetaCons "KinesisFirehoseElasticsearchDestinationConfiguration" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_kinesisFirehoseElasticsearchDestinationConfigurationBufferingHints") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 KinesisFirehoseBufferingHints)) (S1 (MetaSel (Just Symbol "_kinesisFirehoseElasticsearchDestinationConfigurationCloudWatchLoggingOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe KinesisFirehoseCloudWatchLoggingOptions)))) ((:*:) (S1 (MetaSel (Just Symbol "_kinesisFirehoseElasticsearchDestinationConfigurationDomainARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) ((:*:) (S1 (MetaSel (Just Symbol "_kinesisFirehoseElasticsearchDestinationConfigurationIndexName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))) (S1 (MetaSel (Just Symbol "_kinesisFirehoseElasticsearchDestinationConfigurationIndexRotationPeriod") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_kinesisFirehoseElasticsearchDestinationConfigurationRetryOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe KinesisFirehoseElasticsearchRetryOptions))) (S1 (MetaSel (Just Symbol "_kinesisFirehoseElasticsearchDestinationConfigurationRoleARN") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_kinesisFirehoseElasticsearchDestinationConfigurationS3BackupMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 KinesisFirehoseElasticsearchS3BackupMode)) ((:*:) (S1 (MetaSel (Just Symbol "_kinesisFirehoseElasticsearchDestinationConfigurationS3Configuration") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe KinesisFirehoseS3DestinationConfiguration))) (S1 (MetaSel (Just Symbol "_kinesisFirehoseElasticsearchDestinationConfigurationTypeName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Val Text))))))))

kinesisFirehoseElasticsearchDestinationConfiguration

Arguments

:: KinesisFirehoseBufferingHints

kfedcBufferingHints

-> Val Text

kfedcDomainARN

-> Val Text

kfedcIndexName

-> Val Text

kfedcIndexRotationPeriod

-> Val Text

kfedcRoleARN

-> KinesisFirehoseElasticsearchS3BackupMode

kfedcS3BackupMode

-> Val Text

kfedcTypeName

-> KinesisFirehoseElasticsearchDestinationConfiguration

Constructor for KinesisFirehoseElasticsearchDestinationConfiguration containing required fields as arguments.

kfedcBufferingHints :: Lens' KinesisFirehoseElasticsearchDestinationConfiguration KinesisFirehoseBufferingHints

Configures how Firehose buffers incoming data while delivering it to the Amazon ES domain.

kfedcCloudWatchLoggingOptions :: Lens' KinesisFirehoseElasticsearchDestinationConfiguration (Maybe KinesisFirehoseCloudWatchLoggingOptions)

The Amazon CloudWatch Logs logging options for the delivery stream.

kfedcDomainARN :: Lens' KinesisFirehoseElasticsearchDestinationConfiguration (Val Text)

The Amazon Resource Name (ARN) of the Amazon ES domain that Firehose delivers data to.

kfedcIndexName :: Lens' KinesisFirehoseElasticsearchDestinationConfiguration (Val Text)

The name of the Elasticsearch index to which Firehose adds data for indexing.

kfedcIndexRotationPeriod :: Lens' KinesisFirehoseElasticsearchDestinationConfiguration (Val Text)

The frequency of Elasticsearch index rotation. If you enable index rotation, Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination in the Amazon Kinesis Firehose Developer Guide.

kfedcRetryOptions :: Lens' KinesisFirehoseElasticsearchDestinationConfiguration (Maybe KinesisFirehoseElasticsearchRetryOptions)

The retry behavior when Firehose is unable to deliver data to Amazon ES. Type: Amazon Kinesis Firehose DeliveryStream ElasticsearchDestinationConfiguration RetryOptions Type: String

kfedcRoleARN :: Lens' KinesisFirehoseElasticsearchDestinationConfiguration (Val Text)

The ARN of the AWS Identity and Access Management (IAM) role that grants Firehose access to your S3 bucket, AWS KMS (if you enable data encryption), and Amazon CloudWatch Logs (if you enable logging). For more information, see Grant Firehose Access to an Amazon Elasticsearch Service Destination in the Amazon Kinesis Firehose Developer Guide.

kfedcS3BackupMode :: Lens' KinesisFirehoseElasticsearchDestinationConfiguration KinesisFirehoseElasticsearchS3BackupMode

The condition under which Firehose delivers data to Amazon Simple Storage Service (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents that Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Firehose API Reference.

kfedcS3Configuration :: Lens' KinesisFirehoseElasticsearchDestinationConfiguration (Maybe KinesisFirehoseS3DestinationConfiguration)

The S3 bucket where Firehose backs up incoming data. Type: Amazon Kinesis Firehose DeliveryStream S3DestinationConfiguration Type: String

kfedcTypeName :: Lens' KinesisFirehoseElasticsearchDestinationConfiguration (Val Text)

The Elasticsearch type name that Amazon ES adds to documents when indexing data.