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

Description

Synopsis

Documentation

data HttpEndpointDestinationDescription Source #

Describes the HTTP endpoint destination.

See: newHttpEndpointDestinationDescription smart constructor.

Constructors

HttpEndpointDestinationDescription'

Fields

bufferingHints :: Maybe HttpEndpointBufferingHints
Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data Firehose teats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.
cloudWatchLoggingOptions :: Maybe CloudWatchLoggingOptions
endpointConfiguration :: Maybe HttpEndpointDescription
The configuration of the specified HTTP endpoint destination.
processingConfiguration :: Maybe ProcessingConfiguration
requestConfiguration :: Maybe HttpEndpointRequestConfiguration
The configuration of request 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 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).
s3DestinationDescription :: Maybe S3DestinationDescription

Instances

Instances details

FromJSON HttpEndpointDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription Methods parseJSON :: Value -> Parser HttpEndpointDestinationDescription # parseJSONList :: Value -> Parser [HttpEndpointDestinationDescription] #
Generic HttpEndpointDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription Associated Types type Rep HttpEndpointDestinationDescription :: Type -> Type # Methods from :: HttpEndpointDestinationDescription -> Rep HttpEndpointDestinationDescription x # to :: Rep HttpEndpointDestinationDescription x -> HttpEndpointDestinationDescription #
Show HttpEndpointDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription Methods showsPrec :: Int -> HttpEndpointDestinationDescription -> ShowS # show :: HttpEndpointDestinationDescription -> String # showList :: [HttpEndpointDestinationDescription] -> ShowS #
NFData HttpEndpointDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription Methods rnf :: HttpEndpointDestinationDescription -> () #
Eq HttpEndpointDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription Methods (==) :: HttpEndpointDestinationDescription -> HttpEndpointDestinationDescription -> Bool # (/=) :: HttpEndpointDestinationDescription -> HttpEndpointDestinationDescription -> Bool #
Hashable HttpEndpointDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription Methods hashWithSalt :: Int -> HttpEndpointDestinationDescription -> Int # hash :: HttpEndpointDestinationDescription -> Int #
type Rep HttpEndpointDestinationDescription Source #
Instance details Defined in Amazonka.Firehose.Types.HttpEndpointDestinationDescription type Rep HttpEndpointDestinationDescription = D1 ('MetaData "HttpEndpointDestinationDescription" "Amazonka.Firehose.Types.HttpEndpointDestinationDescription" "amazonka-kinesis-firehose-2.0-6l1hHmh2UnHBvolxuQFkWB" 'False) (C1 ('MetaCons "HttpEndpointDestinationDescription'" '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 "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HttpEndpointDescription)) :: 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 "s3DestinationDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3DestinationDescription)))))))

newHttpEndpointDestinationDescription :: HttpEndpointDestinationDescription Source #

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

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

HttpEndpointDestinationDescription, httpEndpointDestinationDescription_cloudWatchLoggingOptions - Undocumented member.

$sel:endpointConfiguration:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_endpointConfiguration - The configuration of the specified HTTP endpoint destination.

$sel:processingConfiguration:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_processingConfiguration - Undocumented member.

$sel:requestConfiguration:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_requestConfiguration - The configuration of request sent to the HTTP endpoint specified as the destination.

$sel:retryOptions:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_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.

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

$sel:s3BackupMode:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_s3BackupMode - Describes the S3 bucket backup options for the data that Kinesis 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:s3DestinationDescription:HttpEndpointDestinationDescription', httpEndpointDestinationDescription_s3DestinationDescription - Undocumented member.

httpEndpointDestinationDescription_bufferingHints :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointBufferingHints) Source #

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

httpEndpointDestinationDescription_cloudWatchLoggingOptions :: Lens' HttpEndpointDestinationDescription (Maybe CloudWatchLoggingOptions) Source #

Undocumented member.

httpEndpointDestinationDescription_endpointConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointDescription) Source #

The configuration of the specified HTTP endpoint destination.

httpEndpointDestinationDescription_processingConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe ProcessingConfiguration) Source #

Undocumented member.

httpEndpointDestinationDescription_requestConfiguration :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRequestConfiguration) Source #

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

httpEndpointDestinationDescription_retryOptions :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointRetryOptions) Source #

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.

httpEndpointDestinationDescription_roleARN :: Lens' HttpEndpointDestinationDescription (Maybe Text) Source #

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

httpEndpointDestinationDescription_s3BackupMode :: Lens' HttpEndpointDestinationDescription (Maybe HttpEndpointS3BackupMode) Source #

Describes the S3 bucket backup options for the data that Kinesis 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).

httpEndpointDestinationDescription_s3DestinationDescription :: Lens' HttpEndpointDestinationDescription (Maybe S3DestinationDescription) Source #

Undocumented member.