Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Documentation

data HttpEndpointDestinationConfiguration

Describes the configuration of the HTTP endpoint destination.

See: newHttpEndpointDestinationConfiguration smart constructor.

Constructors

HttpEndpointDestinationConfiguration'

Fields

• bufferingHints :: Maybe HttpEndpointBufferingHints

  The buffering options that can be used before data is delivered to the specified destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.

• cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
• processingConfiguration :: Maybe ProcessingConfiguration
• requestConfiguration :: Maybe HttpEndpointRequestConfiguration

  The configuration of the requeste sent to the HTTP endpoint specified as the destination.

• retryOptions :: Maybe HttpEndpointRetryOptions

  Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

• roleARN :: Maybe Text

  Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

• s3BackupMode :: Maybe HttpEndpointS3BackupMode

  Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

• endpointConfiguration :: HttpEndpointConfiguration

  The configuration of the HTTP endpoint selected as the destination.

• s3Configuration :: S3DestinationConfiguration

Instances

ToJSON HttpEndpointDestinationConfiguration

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Methods

toJSON :: HttpEndpointDestinationConfiguration -> Value

toEncoding :: HttpEndpointDestinationConfiguration -> Encoding

toJSONList :: [HttpEndpointDestinationConfiguration] -> Value

toEncodingList :: [HttpEndpointDestinationConfiguration] -> Encoding

Generic HttpEndpointDestinationConfiguration

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Associated Types

type Rep HttpEndpointDestinationConfiguration :: Type -> Type

Methods

from :: HttpEndpointDestinationConfiguration -> Rep HttpEndpointDestinationConfiguration x

to :: Rep HttpEndpointDestinationConfiguration x -> HttpEndpointDestinationConfiguration

Show HttpEndpointDestinationConfiguration

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Methods

showsPrec :: Int -> HttpEndpointDestinationConfiguration -> ShowS

show :: HttpEndpointDestinationConfiguration -> String

showList :: [HttpEndpointDestinationConfiguration] -> ShowS

NFData HttpEndpointDestinationConfiguration

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Methods

rnf :: HttpEndpointDestinationConfiguration -> ()

Eq HttpEndpointDestinationConfiguration

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Methods

(==) :: HttpEndpointDestinationConfiguration -> HttpEndpointDestinationConfiguration -> Bool

(/=) :: HttpEndpointDestinationConfiguration -> HttpEndpointDestinationConfiguration -> Bool

Hashable HttpEndpointDestinationConfiguration

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

Methods

hashWithSalt :: Int -> HttpEndpointDestinationConfiguration -> Int

hash :: HttpEndpointDestinationConfiguration -> Int

type Rep HttpEndpointDestinationConfiguration

Defined in Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration

type Rep HttpEndpointDestinationConfiguration = D1 ('MetaData "HttpEndpointDestinationConfiguration" "Amazonka.Firehose.Types.HttpEndpointDestinationConfiguration" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "HttpEndpointDestinationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "bufferingHints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointBufferingHints)) :*: S1 ('MetaSel ('Just "cloudWatchLoggingOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CloudWatchLoggingOptions))) :*: (S1 ('MetaSel ('Just "processingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProcessingConfiguration)) :*: S1 ('MetaSel ('Just "requestConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointRequestConfiguration)))) :*: ((S1 ('MetaSel ('Just "retryOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointRetryOptions)) :*: S1 ('MetaSel ('Just "roleARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "s3BackupMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointS3BackupMode)) :*: (S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HttpEndpointConfiguration) :*: S1 ('MetaSel ('Just "s3Configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 S3DestinationConfiguration))))))

newHttpEndpointDestinationConfiguration

Arguments

:: HttpEndpointConfiguration

$sel:endpointConfiguration:HttpEndpointDestinationConfiguration'

-> S3DestinationConfiguration

$sel:s3Configuration:HttpEndpointDestinationConfiguration'

-> HttpEndpointDestinationConfiguration

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

HttpEndpointDestinationConfiguration, httpEndpointDestinationConfiguration_bufferingHints - The buffering options that can be used before data is delivered to the specified destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.

HttpEndpointDestinationConfiguration, httpEndpointDestinationConfiguration_cloudWatchLoggingOptions - Undocumented member.

$sel:processingConfiguration:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_processingConfiguration - Undocumented member.

$sel:requestConfiguration:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_requestConfiguration - The configuration of the requeste sent to the HTTP endpoint specified as the destination.

$sel:retryOptions:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_retryOptions - Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

HttpEndpointDestinationConfiguration, httpEndpointDestinationConfiguration_roleARN - Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

$sel:s3BackupMode:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_s3BackupMode - Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

$sel:endpointConfiguration:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_endpointConfiguration - The configuration of the HTTP endpoint selected as the destination.

$sel:s3Configuration:HttpEndpointDestinationConfiguration', httpEndpointDestinationConfiguration_s3Configuration - Undocumented member.

httpEndpointDestinationConfiguration_bufferingHints :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointBufferingHints)

The buffering options that can be used before data is delivered to the specified destination. Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.

httpEndpointDestinationConfiguration_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe CloudWatchLoggingOptions)

Undocumented member.

httpEndpointDestinationConfiguration_processingConfiguration :: Lens' HttpEndpointDestinationConfiguration (Maybe ProcessingConfiguration)

Undocumented member.

httpEndpointDestinationConfiguration_requestConfiguration :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRequestConfiguration)

The configuration of the requeste sent to the HTTP endpoint specified as the destination.

httpEndpointDestinationConfiguration_retryOptions :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointRetryOptions)

Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.

httpEndpointDestinationConfiguration_roleARN :: Lens' HttpEndpointDestinationConfiguration (Maybe Text)

Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

httpEndpointDestinationConfiguration_s3BackupMode :: Lens' HttpEndpointDestinationConfiguration (Maybe HttpEndpointS3BackupMode)

Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

httpEndpointDestinationConfiguration_endpointConfiguration :: Lens' HttpEndpointDestinationConfiguration HttpEndpointConfiguration

The configuration of the HTTP endpoint selected as the destination.

httpEndpointDestinationConfiguration_s3Configuration :: Lens' HttpEndpointDestinationConfiguration S3DestinationConfiguration

Undocumented member.