Package software.amazon.awscdk.services.kinesisfirehose
Amazon Kinesis Data Firehose Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.kinesisfirehose.*;
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
- Search Construct Hub for KinesisFirehose construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::KinesisFirehose resources directly.
An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed as a separate package so that you can pin its version independently of the rest of the CDK. See the package:
@aws-cdk/aws-kinesisfirehose-alpha
There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.
For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::KinesisFirehose.
(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)
-
ClassDescriptionThe
AWS::KinesisFirehose::DeliveryStreamresource specifies an Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3), Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES) destination.Describes the buffering to perform before delivering data to the Serverless offering for Amazon OpenSearch Service destination.An implementation forCfnDeliveryStream.AmazonOpenSearchServerlessBufferingHintsPropertyDescribes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.An implementation forCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationPropertyConfigures retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.An implementation forCfnDeliveryStream.AmazonOpenSearchServerlessRetryOptionsPropertyDescribes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.An implementation forCfnDeliveryStream.AmazonopensearchserviceBufferingHintsPropertyDescribes the configuration of a destination in Amazon OpenSearch Service.An implementation forCfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationPropertyConfigures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.An implementation forCfnDeliveryStream.AmazonopensearchserviceRetryOptionsPropertyThe authentication configuration of the Amazon MSK cluster.A builder forCfnDeliveryStream.AuthenticationConfigurationPropertyAn implementation forCfnDeliveryStream.AuthenticationConfigurationPropertyTheBufferingHintsproperty type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data before delivering it to the destination.A builder forCfnDeliveryStream.BufferingHintsPropertyAn implementation forCfnDeliveryStream.BufferingHintsPropertyA fluent builder forCfnDeliveryStream.Describes the containers where the destination Apache Iceberg Tables are persisted.A builder forCfnDeliveryStream.CatalogConfigurationPropertyAn implementation forCfnDeliveryStream.CatalogConfigurationPropertyTheCloudWatchLoggingOptionsproperty type specifies Amazon CloudWatch Logs (CloudWatch Logs) logging options that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses for the delivery stream.A builder forCfnDeliveryStream.CloudWatchLoggingOptionsPropertyAn implementation forCfnDeliveryStream.CloudWatchLoggingOptionsPropertyTheCopyCommandproperty type configures the Amazon RedshiftCOPYcommand that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket.A builder forCfnDeliveryStream.CopyCommandPropertyAn implementation forCfnDeliveryStream.CopyCommandPropertyExample:A builder forCfnDeliveryStream.DatabaseColumnsPropertyAn implementation forCfnDeliveryStream.DatabaseColumnsPropertyThe structure to configure the authentication methods for Firehose to connect to source database endpoint.An implementation forCfnDeliveryStream.DatabaseSourceAuthenticationConfigurationPropertyThe top level object for configuring streams with database as a source.A builder forCfnDeliveryStream.DatabaseSourceConfigurationPropertyAn implementation forCfnDeliveryStream.DatabaseSourceConfigurationPropertyThe structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.A builder forCfnDeliveryStream.DatabaseSourceVPCConfigurationPropertyAn implementation forCfnDeliveryStream.DatabaseSourceVPCConfigurationPropertyExample:A builder forCfnDeliveryStream.DatabasesPropertyAn implementation forCfnDeliveryStream.DatabasesPropertyExample:A builder forCfnDeliveryStream.DatabaseTablesPropertyAn implementation forCfnDeliveryStream.DatabaseTablesPropertySpecifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.An implementation forCfnDeliveryStream.DataFormatConversionConfigurationPropertySpecifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).An implementation forCfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputPropertyThe deserializer you want Kinesis Data Firehose to use for converting the input data from JSON.A builder forCfnDeliveryStream.DeserializerPropertyAn implementation forCfnDeliveryStream.DeserializerPropertyDescribes the configuration of a destination in Apache Iceberg Tables.A builder forCfnDeliveryStream.DestinationTableConfigurationPropertyAn implementation forCfnDeliveryStream.DestinationTableConfigurationPropertyIndicates the method for setting up document ID.A builder forCfnDeliveryStream.DocumentIdOptionsPropertyAn implementation forCfnDeliveryStream.DocumentIdOptionsPropertyTheDynamicPartitioningConfigurationproperty type specifies the configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.An implementation forCfnDeliveryStream.DynamicPartitioningConfigurationPropertyTheElasticsearchBufferingHintsproperty type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data while delivering it to the destination.A builder forCfnDeliveryStream.ElasticsearchBufferingHintsPropertyAn implementation forCfnDeliveryStream.ElasticsearchBufferingHintsPropertyTheElasticsearchDestinationConfigurationproperty type specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data to.An implementation forCfnDeliveryStream.ElasticsearchDestinationConfigurationPropertyTheElasticsearchRetryOptionsproperty type configures the retry behavior for when Amazon Kinesis Data Firehose (Kinesis Data Firehose) can't deliver data to Amazon Elasticsearch Service (Amazon ES).A builder forCfnDeliveryStream.ElasticsearchRetryOptionsPropertyAn implementation forCfnDeliveryStream.ElasticsearchRetryOptionsPropertyTheEncryptionConfigurationproperty type specifies the encryption settings that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses when delivering data to Amazon Simple Storage Service (Amazon S3).A builder forCfnDeliveryStream.EncryptionConfigurationPropertyAn implementation forCfnDeliveryStream.EncryptionConfigurationPropertyTheExtendedS3DestinationConfigurationproperty type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream.An implementation forCfnDeliveryStream.ExtendedS3DestinationConfigurationPropertyThe native Hive / HCatalog JsonSerDe.A builder forCfnDeliveryStream.HiveJsonSerDePropertyAn implementation forCfnDeliveryStream.HiveJsonSerDePropertyDescribes the metadata that's delivered to the specified HTTP endpoint destination.A builder forCfnDeliveryStream.HttpEndpointCommonAttributePropertyAn implementation forCfnDeliveryStream.HttpEndpointCommonAttributePropertyDescribes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.A builder forCfnDeliveryStream.HttpEndpointConfigurationPropertyAn implementation forCfnDeliveryStream.HttpEndpointConfigurationPropertyDescribes the configuration of the HTTP endpoint destination.An implementation forCfnDeliveryStream.HttpEndpointDestinationConfigurationPropertyThe configuration of the HTTP endpoint request.An implementation forCfnDeliveryStream.HttpEndpointRequestConfigurationPropertySpecifies the destination configure settings for Apache Iceberg Table.An implementation forCfnDeliveryStream.IcebergDestinationConfigurationPropertySpecifies the deserializer you want to use to convert the format of the input data.A builder forCfnDeliveryStream.InputFormatConfigurationPropertyAn implementation forCfnDeliveryStream.InputFormatConfigurationPropertyTheKinesisStreamSourceConfigurationproperty type specifies the stream and role Amazon Resource Names (ARNs) for a Kinesis stream used as the source for a delivery stream.An implementation forCfnDeliveryStream.KinesisStreamSourceConfigurationPropertyTheKMSEncryptionConfigproperty type specifies the AWS Key Management Service ( AWS KMS) encryption key that Amazon Simple Storage Service (Amazon S3) uses to encrypt data delivered by the Amazon Kinesis Data Firehose (Kinesis Data Firehose) stream.A builder forCfnDeliveryStream.KMSEncryptionConfigPropertyAn implementation forCfnDeliveryStream.KMSEncryptionConfigPropertyThe configuration for the Amazon MSK cluster to be used as the source for a delivery stream.A builder forCfnDeliveryStream.MSKSourceConfigurationPropertyAn implementation forCfnDeliveryStream.MSKSourceConfigurationPropertyThe OpenX SerDe.A builder forCfnDeliveryStream.OpenXJsonSerDePropertyAn implementation forCfnDeliveryStream.OpenXJsonSerDePropertyA serializer to use for converting data to the ORC format before storing it in Amazon S3.A builder forCfnDeliveryStream.OrcSerDePropertyAn implementation forCfnDeliveryStream.OrcSerDePropertySpecifies the serializer that you want Firehose to use to convert the format of your data before it writes it to Amazon S3.A builder forCfnDeliveryStream.OutputFormatConfigurationPropertyAn implementation forCfnDeliveryStream.OutputFormatConfigurationPropertyA serializer to use for converting data to the Parquet format before storing it in Amazon S3.A builder forCfnDeliveryStream.ParquetSerDePropertyAn implementation forCfnDeliveryStream.ParquetSerDePropertyTheProcessingConfigurationproperty configures data processing for an Amazon Kinesis Data Firehose delivery stream.A builder forCfnDeliveryStream.ProcessingConfigurationPropertyAn implementation forCfnDeliveryStream.ProcessingConfigurationPropertyTheProcessorParameterproperty specifies a processor parameter in a data processor for an Amazon Kinesis Data Firehose delivery stream.A builder forCfnDeliveryStream.ProcessorParameterPropertyAn implementation forCfnDeliveryStream.ProcessorParameterPropertyTheProcessorproperty specifies a data processor for an Amazon Kinesis Data Firehose delivery stream.A builder forCfnDeliveryStream.ProcessorPropertyAn implementation forCfnDeliveryStream.ProcessorPropertyTheRedshiftDestinationConfigurationproperty type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.An implementation forCfnDeliveryStream.RedshiftDestinationConfigurationPropertyConfigures retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.A builder forCfnDeliveryStream.RedshiftRetryOptionsPropertyAn implementation forCfnDeliveryStream.RedshiftRetryOptionsPropertyDescribes 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.A builder forCfnDeliveryStream.RetryOptionsPropertyAn implementation forCfnDeliveryStream.RetryOptionsPropertyTheS3DestinationConfigurationproperty type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.A builder forCfnDeliveryStream.S3DestinationConfigurationPropertyAn implementation forCfnDeliveryStream.S3DestinationConfigurationPropertySpecifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3.A builder forCfnDeliveryStream.SchemaConfigurationPropertyAn implementation forCfnDeliveryStream.SchemaConfigurationPropertyThe structure that defines how Firehose accesses the secret.A builder forCfnDeliveryStream.SecretsManagerConfigurationPropertyAn implementation forCfnDeliveryStream.SecretsManagerConfigurationPropertyThe serializer that you want Firehose to use to convert data to the target format before writing it to Amazon S3.A builder forCfnDeliveryStream.SerializerPropertyAn implementation forCfnDeliveryStream.SerializerPropertyDescribes the buffering to perform before delivering data to the Snowflake destination.A builder forCfnDeliveryStream.SnowflakeBufferingHintsPropertyAn implementation forCfnDeliveryStream.SnowflakeBufferingHintsPropertyConfigure Snowflake destination.An implementation forCfnDeliveryStream.SnowflakeDestinationConfigurationPropertySpecify how long Firehose retries sending data to the New Relic HTTP endpoint.A builder forCfnDeliveryStream.SnowflakeRetryOptionsPropertyAn implementation forCfnDeliveryStream.SnowflakeRetryOptionsPropertyOptionally configure a Snowflake role.A builder forCfnDeliveryStream.SnowflakeRoleConfigurationPropertyAn implementation forCfnDeliveryStream.SnowflakeRoleConfigurationPropertyConfigure a Snowflake VPC.A builder forCfnDeliveryStream.SnowflakeVpcConfigurationPropertyAn implementation forCfnDeliveryStream.SnowflakeVpcConfigurationPropertyThe buffering options.A builder forCfnDeliveryStream.SplunkBufferingHintsPropertyAn implementation forCfnDeliveryStream.SplunkBufferingHintsPropertyTheSplunkDestinationConfigurationproperty type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.A builder forCfnDeliveryStream.SplunkDestinationConfigurationPropertyAn implementation forCfnDeliveryStream.SplunkDestinationConfigurationPropertyTheSplunkRetryOptionsproperty type specifies retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk or if it doesn't receive an acknowledgment from Splunk.A builder forCfnDeliveryStream.SplunkRetryOptionsPropertyAn implementation forCfnDeliveryStream.SplunkRetryOptionsPropertyThe details of the VPC of the Amazon ES destination.A builder forCfnDeliveryStream.VpcConfigurationPropertyAn implementation forCfnDeliveryStream.VpcConfigurationPropertyProperties for defining aCfnDeliveryStream.A builder forCfnDeliveryStreamPropsAn implementation forCfnDeliveryStreamProps