Interface DeliveryStreamProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
DeliveryStreamProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-09-11T18:01:25.727Z")
@Stability(Experimental)
public interface DeliveryStreamProps
extends software.amazon.jsii.JsiiSerializable
(experimental) Properties for a new delivery stream.
Example:
import software.amazon.awscdk.services.kinesisfirehose.alpha.*; import software.amazon.awscdk.services.kinesisfirehose.destinations.alpha.*; Bucket bucket = new Bucket(this, "MyBucket"); DeliveryStream stream = DeliveryStream.Builder.create(this, "MyStream") .destinations(List.of(new S3Bucket(bucket))) .build(); TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule") .sql(IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'")) .actions(List.of( FirehosePutRecordAction.Builder.create(stream) .batchMode(true) .recordSeparator(FirehoseRecordSeparator.NEWLINE) .build())) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forDeliveryStreamProps
static final class
An implementation forDeliveryStreamProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic DeliveryStreamProps.Builder
builder()
default String
(experimental) A name for the delivery stream.(experimental) The destinations that this delivery stream will deliver data to.default StreamEncryption
(experimental) Indicates the type of customer master key (CMK) to use for server-side encryption, if any.default IKey
(experimental) Customer managed key to server-side encrypt data in the stream.default IRole
getRole()
(experimental) The IAM role associated with this delivery stream.default IStream
(experimental) 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
-
getDestinations
(experimental) The destinations that this delivery stream will deliver data to.Only a singleton array is supported at this time.
-
getDeliveryStreamName
(experimental) A name for the delivery stream.Default: - a name is generated by CloudFormation.
-
getEncryption
(experimental) Indicates the type of customer master key (CMK) to use for server-side encryption, if any.Default: StreamEncryption.UNENCRYPTED - unless `encryptionKey` is provided, in which case this will be implicitly set to `StreamEncryption.CUSTOMER_MANAGED`
-
getEncryptionKey
(experimental) Customer managed key to server-side encrypt data in the stream.Default: - no KMS key will be used; if `encryption` is set to `CUSTOMER_MANAGED`, a KMS key will be created for you
-
getRole
(experimental) The IAM role associated with this delivery stream.Assumed by Kinesis Data Firehose to read from sources and encrypt data server-side.
Default: - a role will be created with default permissions.
-
getSourceStream
(experimental) 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
- Returns:
- a
DeliveryStreamProps.Builder
ofDeliveryStreamProps
-