interface HttpEndpointDestinationConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.KinesisFirehose.CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#CfnDeliveryStream_HttpEndpointDestinationConfigurationProperty`
Java	`software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty`
Python	`aws_cdk.aws_kinesisfirehose.CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_kinesisfirehose` » `CfnDeliveryStream` » `HttpEndpointDestinationConfigurationProperty`

Describes the configuration of the HTTP endpoint destination.

Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesisfirehose as kinesisfirehose } from 'aws-cdk-lib';
const httpEndpointDestinationConfigurationProperty: kinesisfirehose.CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty = {
  endpointConfiguration: {
    url: 'url',

    // the properties below are optional
    accessKey: 'accessKey',
    name: 'name',
  },
  s3Configuration: {
    bucketArn: 'bucketArn',
    roleArn: 'roleArn',

    // the properties below are optional
    bufferingHints: {
      intervalInSeconds: 123,
      sizeInMBs: 123,
    },
    cloudWatchLoggingOptions: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
    compressionFormat: 'compressionFormat',
    encryptionConfiguration: {
      kmsEncryptionConfig: {
        awskmsKeyArn: 'awskmsKeyArn',
      },
      noEncryptionConfig: 'noEncryptionConfig',
    },
    errorOutputPrefix: 'errorOutputPrefix',
    prefix: 'prefix',
  },

  // the properties below are optional
  bufferingHints: {
    intervalInSeconds: 123,
    sizeInMBs: 123,
  },
  cloudWatchLoggingOptions: {
    enabled: false,
    logGroupName: 'logGroupName',
    logStreamName: 'logStreamName',
  },
  processingConfiguration: {
    enabled: false,
    processors: [{
      type: 'type',

      // the properties below are optional
      parameters: [{
        parameterName: 'parameterName',
        parameterValue: 'parameterValue',
      }],
    }],
  },
  requestConfiguration: {
    commonAttributes: [{
      attributeName: 'attributeName',
      attributeValue: 'attributeValue',
    }],
    contentEncoding: 'contentEncoding',
  },
  retryOptions: {
    durationInSeconds: 123,
  },
  roleArn: 'roleArn',
  s3BackupMode: 's3BackupMode',
  secretsManagerConfiguration: {
    enabled: false,

    // the properties below are optional
    roleArn: 'roleArn',
    secretArn: 'secretArn',
  },
};

Properties

Name	Type	Description
endpointConfiguration	`IResolvable` `\|` `HttpEndpointConfigurationProperty`	The configuration of the HTTP endpoint selected as the destination.
s3Configuration	`IResolvable` `\|` `S3DestinationConfigurationProperty`	Describes the configuration of a destination in Amazon S3.
bufferingHints?	`IResolvable` `\|` `BufferingHintsProperty`	The buffering options that can be used before data is delivered to the specified destination.
cloudWatchLoggingOptions?	`IResolvable` `\|` `CloudWatchLoggingOptionsProperty`	Describes the Amazon CloudWatch logging options for your delivery stream.
processingConfiguration?	`IResolvable` `\|` `ProcessingConfigurationProperty`	Describes the data processing configuration.
requestConfiguration?	`IResolvable` `\|` `HttpEndpointRequestConfigurationProperty`	The configuration of the request sent to the HTTP endpoint specified as the destination.
retryOptions?	`IResolvable` `\|` `RetryOptionsProperty`	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?	`string`	Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
s3BackupMode?	`string`	Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination.
secretsManagerConfiguration?	`IResolvable` `\|` `SecretsManagerConfigurationProperty`	The configuration that defines how you access secrets for HTTP Endpoint destination.

endpointConfiguration

Type: IResolvable | HttpEndpointConfigurationProperty

The configuration of the HTTP endpoint selected as the destination.

s3Configuration

Type: IResolvable | S3DestinationConfigurationProperty

Describes the configuration of a destination in Amazon S3.

bufferingHints?

Type: IResolvable | BufferingHintsProperty (optional)

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?

Type: IResolvable | CloudWatchLoggingOptionsProperty (optional)

Describes the Amazon CloudWatch logging options for your delivery stream.

processingConfiguration?

Type: IResolvable | ProcessingConfigurationProperty (optional)

Describes the data processing configuration.

requestConfiguration?

Type: IResolvable | HttpEndpointRequestConfigurationProperty (optional)

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

retryOptions?

Type: IResolvable | RetryOptionsProperty (optional)

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?

Type: string (optional)

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

s3BackupMode?

Type: string (optional)

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

secretsManagerConfiguration?

Type: IResolvable | SecretsManagerConfigurationProperty (optional)

The configuration that defines how you access secrets for HTTP Endpoint destination.