Package software.amazon.awscdk.cfnpropertymixins.services.kinesisfirehose

Interface CfnDeliveryStreamMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStreamMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-08-13T16:20:23.980Z")
@Stability(Stable)
public interface CfnDeliveryStreamMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnDeliveryStreamPropsMixin.

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeliveryStreamMixinProps.Builder	A builder for CfnDeliveryStreamMixinProps
static final class	CfnDeliveryStreamMixinProps.Jsii$Proxy	An implementation for CfnDeliveryStreamMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStreamMixinProps.Builder	builder()
default Object	getAmazonOpenSearchServerlessDestinationConfiguration()	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
default Object	getAmazonopensearchserviceDestinationConfiguration()	The destination in Amazon OpenSearch Service.
default Object	getDatabaseSourceConfiguration()	The top level object for configuring streams with database as a source.
default Object	getDeliveryStreamEncryptionConfigurationInput()	Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
default Object	getDeliveryStreamName()	The name of the Firehose stream.
default String	getDeliveryStreamType()	The Firehose stream type.
default Object	getDirectPutSourceConfiguration()	The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.
default Object	getElasticsearchDestinationConfiguration()	An Amazon ES destination for the delivery stream.
default Object	getExtendedS3DestinationConfiguration()	An Amazon S3 destination for the delivery stream.
default Object	getHttpEndpointDestinationConfiguration()	Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
default Object	getIcebergDestinationConfiguration()	Specifies the destination configure settings for Apache Iceberg Table.
default Object	getKinesisStreamSourceConfiguration()	When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.
default Object	getMskSourceConfiguration()	The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
default Object	getRedshiftDestinationConfiguration()	An Amazon Redshift destination for the delivery stream.
default Object	getS3DestinationConfiguration()	The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
default Object	getSnowflakeDestinationConfiguration()	Configure Snowflake destination.
default Object	getSplunkDestinationConfiguration()	The configuration of a destination in Splunk for the delivery stream.
default List<CfnTag>	getTags()	A set of tags to assign to the Firehose stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAmazonOpenSearchServerlessDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getAmazonOpenSearchServerlessDestinationConfiguration()

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration

getAmazonopensearchserviceDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getAmazonopensearchserviceDestinationConfiguration()

The destination in Amazon OpenSearch Service.

You can specify only one destination.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.AmazonopensearchserviceDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration

getDatabaseSourceConfiguration

@Stability(Stable)
@Nullable
default Object getDatabaseSourceConfiguration()

The top level object for configuring streams with database as a source.

Amazon Data Firehose is in preview release and is subject to change.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.DatabaseSourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration

getDeliveryStreamEncryptionConfigurationInput

@Stability(Stable)
@Nullable
default Object getDeliveryStreamEncryptionConfigurationInput()

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.DeliveryStreamEncryptionConfigurationInputProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput

getDeliveryStreamName

@Stability(Stable)
@Nullable
default Object getDeliveryStreamName()

The name of the Firehose stream.

Returns union: either String or IStreamRef

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamname

getDeliveryStreamType

@Stability(Stable)
@Nullable
default String getDeliveryStreamType()

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

• DirectPut : Provider applications access the Firehose stream directly.
• KinesisStreamAsSource : The Firehose stream uses a Kinesis data stream as a source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamtype

getDirectPutSourceConfiguration

@Stability(Stable)
@Nullable
default Object getDirectPutSourceConfiguration()

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.DirectPutSourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-directputsourceconfiguration

getElasticsearchDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getElasticsearchDestinationConfiguration()

An Amazon ES destination for the delivery stream.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon ES destination to an Amazon S3 or Amazon Redshift destination, update requires some interruptions .

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.ElasticsearchDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration

getExtendedS3DestinationConfiguration

@Stability(Stable)
@Nullable
default Object getExtendedS3DestinationConfiguration()

An Amazon S3 destination for the delivery stream.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon Extended S3 destination to an Amazon ES destination, update requires some interruptions .

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.ExtendedS3DestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration

getHttpEndpointDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getHttpEndpointDestinationConfiguration()

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

You can specify only one destination.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.HttpEndpointDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration

getIcebergDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getIcebergDestinationConfiguration()

Specifies the destination configure settings for Apache Iceberg Table.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.IcebergDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration

getKinesisStreamSourceConfiguration

@Stability(Stable)
@Nullable
default Object getKinesisStreamSourceConfiguration()

When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.KinesisStreamSourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration

getMskSourceConfiguration

@Stability(Stable)
@Nullable
default Object getMskSourceConfiguration()

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.MSKSourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration

getRedshiftDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getRedshiftDestinationConfiguration()

An Amazon Redshift destination for the delivery stream.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon Redshift destination to an Amazon ES destination, update requires some interruptions .

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.RedshiftDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration

getS3DestinationConfiguration

@Stability(Stable)
@Nullable
default Object getS3DestinationConfiguration()

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

Conditional. You must specify only one destination configuration.

If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires some interruptions .

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.S3DestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration

getSnowflakeDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getSnowflakeDestinationConfiguration()

Configure Snowflake destination.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.SnowflakeDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration

getSplunkDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getSplunkDestinationConfiguration()

The configuration of a destination in Splunk for the delivery stream.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.SplunkDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A set of tags to assign to the Firehose stream.

A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a Firehose stream.

If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.

AccessDeniedException

User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.

For an example IAM policy, see Tag example.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-tags

builder

@Stability(Stable)
static CfnDeliveryStreamMixinProps.Builder builder()

Returns:

a CfnDeliveryStreamMixinProps.Builder of CfnDeliveryStreamMixinProps