Package software.amazon.awscdk.services.kinesisfirehose

Interface DeliveryStreamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DeliveryStreamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:15.386Z")
@Stability(Stable)
public interface DeliveryStreamProps
extends software.amazon.jsii.JsiiSerializable

Properties for a new delivery stream.

Example:

 Bucket bucket;
 // Provide a Lambda function that will transform records before delivery, with custom
 // buffering and retry configuration
 Function lambdaFunction = Function.Builder.create(this, "Processor")
         .runtime(Runtime.NODEJS_LATEST)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "process-records")))
         .build();
 LambdaFunctionProcessor lambdaProcessor = LambdaFunctionProcessor.Builder.create(lambdaFunction)
         .bufferInterval(Duration.minutes(5))
         .bufferSize(Size.mebibytes(5))
         .retries(5)
         .build();
 S3Bucket s3Destination = S3Bucket.Builder.create(bucket)
         .processor(lambdaProcessor)
         .build();
 DeliveryStream.Builder.create(this, "Delivery Stream")
         .destination(s3Destination)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DeliveryStreamProps.Builder	builder()
default String	getDeliveryStreamName()	A name for the delivery stream.
IDestination	getDestination()	The destination that this delivery stream will deliver data to.
default StreamEncryption	getEncryption()	Indicates the type of customer master key (CMK) to use for server-side encryption, if any.
default IRole	getRole()	The IAM role associated with this delivery stream.
default ISource	getSource()	The Kinesis data stream to use as a source for this delivery stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestination

@Stability(Stable)
@NotNull
IDestination getDestination()

The destination that this delivery stream will deliver data to.

getDeliveryStreamName

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

A name for the delivery stream.

Default: - a name is generated by CloudFormation.

getEncryption

@Stability(Stable)
@Nullable
default StreamEncryption getEncryption()

Indicates the type of customer master key (CMK) to use for server-side encryption, if any.

Default: StreamEncryption.unencrypted()

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

The IAM role associated with this delivery stream.

Assumed by Amazon Data Firehose to read from sources and encrypt data server-side.

Default: - a role will be created with default permissions.

getSource

@Stability(Stable)
@Nullable
default ISource getSource()

The Kinesis data stream to use as a source for this delivery stream.

Default: - data must be written to the delivery stream via a direct put.

builder

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

Returns:

a DeliveryStreamProps.Builder of DeliveryStreamProps