Package-level declarations

Types

enum DeliveryStreamAmazonOpenSearchServerlessDestinationConfigurationS3BackupMode : Enum<DeliveryStreamAmazonOpenSearchServerlessDestinationConfigurationS3BackupMode> , ConvertibleToJava<DeliveryStreamAmazonOpenSearchServerlessDestinationConfigurationS3BackupMode>

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

enum DeliveryStreamAmazonopensearchserviceDestinationConfigurationIndexRotationPeriod : Enum<DeliveryStreamAmazonopensearchserviceDestinationConfigurationIndexRotationPeriod> , ConvertibleToJava<DeliveryStreamAmazonopensearchserviceDestinationConfigurationIndexRotationPeriod>

The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

enum DeliveryStreamAmazonopensearchserviceDestinationConfigurationS3BackupMode : Enum<DeliveryStreamAmazonopensearchserviceDestinationConfigurationS3BackupMode> , ConvertibleToJava<DeliveryStreamAmazonopensearchserviceDestinationConfigurationS3BackupMode>

Defines how documents should be delivered to Amazon S3.

enum DeliveryStreamAuthenticationConfigurationConnectivity : Enum<DeliveryStreamAuthenticationConfigurationConnectivity> , ConvertibleToJava<DeliveryStreamAuthenticationConfigurationConnectivity>

The type of connectivity used to access the Amazon MSK cluster.

enum DeliveryStreamDocumentIdOptionsDefaultDocumentIdFormat : Enum<DeliveryStreamDocumentIdOptionsDefaultDocumentIdFormat> , ConvertibleToJava<DeliveryStreamDocumentIdOptionsDefaultDocumentIdFormat>

When the FIREHOSE_DEFAULT option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs. When the NO_DOCUMENT_ID option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.

enum DeliveryStreamElasticsearchDestinationConfigurationIndexRotationPeriod : Enum<DeliveryStreamElasticsearchDestinationConfigurationIndexRotationPeriod> , ConvertibleToJava<DeliveryStreamElasticsearchDestinationConfigurationIndexRotationPeriod>

The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data 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 Data Firehose Developer Guide .

enum DeliveryStreamElasticsearchDestinationConfigurationS3BackupMode : Enum<DeliveryStreamElasticsearchDestinationConfigurationS3BackupMode> , ConvertibleToJava<DeliveryStreamElasticsearchDestinationConfigurationS3BackupMode>

The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3). You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data 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 Data Firehose API Reference .

enum DeliveryStreamEncryptionConfigurationInputKeyType : Enum<DeliveryStreamEncryptionConfigurationInputKeyType> , ConvertibleToJava<DeliveryStreamEncryptionConfigurationInputKeyType>

Indicates the type of customer master key (CMK) to use for encryption. The default setting is AWS_OWNED_CMK . For more information about CMKs, see Customer Master Keys (CMKs) . You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams.

enum DeliveryStreamEncryptionConfigurationNoEncryptionConfig : Enum<DeliveryStreamEncryptionConfigurationNoEncryptionConfig> , ConvertibleToJava<DeliveryStreamEncryptionConfigurationNoEncryptionConfig>

Disables encryption. For valid values, see the NoEncryptionConfig content for the EncryptionConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

enum DeliveryStreamExtendedS3DestinationConfigurationCompressionFormat : Enum<DeliveryStreamExtendedS3DestinationConfigurationCompressionFormat> , ConvertibleToJava<DeliveryStreamExtendedS3DestinationConfigurationCompressionFormat>

The compression format. If no value is specified, the default is UNCOMPRESSED .

enum DeliveryStreamExtendedS3DestinationConfigurationS3BackupMode : Enum<DeliveryStreamExtendedS3DestinationConfigurationS3BackupMode> , ConvertibleToJava<DeliveryStreamExtendedS3DestinationConfigurationS3BackupMode>

The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

enum DeliveryStreamHttpEndpointRequestConfigurationContentEncoding : Enum<DeliveryStreamHttpEndpointRequestConfigurationContentEncoding> , ConvertibleToJava<DeliveryStreamHttpEndpointRequestConfigurationContentEncoding>

Kinesis Data Firehose uses the content encoding to compress the body of a request before sending the request to the destination. For more information, see Content-Encoding in MDN Web Docs, the official Mozilla documentation.

enum DeliveryStreamIcebergDestinationConfigurations3BackupMode : Enum<DeliveryStreamIcebergDestinationConfigurations3BackupMode> , ConvertibleToJava<DeliveryStreamIcebergDestinationConfigurations3BackupMode>

Describes how Firehose will backup records. Currently,S3 backup only supports FailedDataOnly for preview. Amazon Data Firehose is in preview release and is subject to change.

Link copied to clipboard
enum DeliveryStreamProcessorType : Enum<DeliveryStreamProcessorType> , ConvertibleToJava<DeliveryStreamProcessorType>

The type of processor. Valid values: Lambda .

enum DeliveryStreamRedshiftDestinationConfigurationS3BackupMode : Enum<DeliveryStreamRedshiftDestinationConfigurationS3BackupMode> , ConvertibleToJava<DeliveryStreamRedshiftDestinationConfigurationS3BackupMode>

The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.

enum DeliveryStreamS3DestinationConfigurationCompressionFormat : Enum<DeliveryStreamS3DestinationConfigurationCompressionFormat> , ConvertibleToJava<DeliveryStreamS3DestinationConfigurationCompressionFormat>

The type of compression that Kinesis Data Firehose uses to compress the data that it delivers to the Amazon S3 bucket. For valid values, see the CompressionFormat content for the S3DestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

enum DeliveryStreamSnowflakeDestinationConfigurationDataLoadingOption : Enum<DeliveryStreamSnowflakeDestinationConfigurationDataLoadingOption> , ConvertibleToJava<DeliveryStreamSnowflakeDestinationConfigurationDataLoadingOption>

Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.

enum DeliveryStreamSnowflakeDestinationConfigurationS3BackupMode : Enum<DeliveryStreamSnowflakeDestinationConfigurationS3BackupMode> , ConvertibleToJava<DeliveryStreamSnowflakeDestinationConfigurationS3BackupMode>

Choose an S3 backup mode

enum DeliveryStreamSplunkDestinationConfigurationHecEndpointType : Enum<DeliveryStreamSplunkDestinationConfigurationHecEndpointType> , ConvertibleToJava<DeliveryStreamSplunkDestinationConfigurationHecEndpointType>

This type can be either Raw or Event .

Link copied to clipboard
enum DeliveryStreamType : Enum<DeliveryStreamType> , ConvertibleToJava<DeliveryStreamType>

The delivery stream type. This can be one of the following values: