interface DeliveryStreamProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.KinesisFirehose.Alpha.DeliveryStreamProps |
![]() | github.com/aws/aws-cdk-go/awscdkkinesisfirehosealpha/v2#DeliveryStreamProps |
![]() | software.amazon.awscdk.services.kinesisfirehose.alpha.DeliveryStreamProps |
![]() | aws_cdk.aws_kinesisfirehose_alpha.DeliveryStreamProps |
![]() | @aws-cdk/aws-kinesisfirehose-alpha ยป DeliveryStreamProps |
Properties for a new delivery stream.
Example
// Create service roles for the delivery stream and destination.
// These can be used for other purposes and granted access to different resources.
// They must include the Kinesis Data Firehose service principal in their trust policies.
// Two separate roles are shown below, but the same role can be used for both purposes.
const deliveryStreamRole = new iam.Role(this, 'Delivery Stream Role', {
assumedBy: new iam.ServicePrincipal('firehose.amazonaws.com'),
});
const destinationRole = new iam.Role(this, 'Destination Role', {
assumedBy: new iam.ServicePrincipal('firehose.amazonaws.com'),
});
// Specify the roles created above when defining the destination and delivery stream.
declare const bucket: s3.Bucket;
const destination = new destinations.S3Bucket(bucket, { role: destinationRole });
new firehose.DeliveryStream(this, 'Delivery Stream', {
destinations: [destination],
role: deliveryStreamRole,
});
Properties
Name | Type | Description |
---|---|---|
destinations | IDestination [] | The destinations that this delivery stream will deliver data to. |
delivery | string | A name for the delivery stream. |
encryption? | Stream | Indicates the type of customer master key (CMK) to use for server-side encryption, if any. |
encryption | IKey | Customer managed key to server-side encrypt data in the stream. |
role? | IRole | The IAM role associated with this delivery stream. |
source | IStream | The Kinesis data stream to use as a source for this delivery stream. |
destinations
Type:
IDestination
[]
The destinations that this delivery stream will deliver data to.
Only a singleton array is supported at this time.
deliveryStreamName?
Type:
string
(optional, default: a name is generated by CloudFormation.)
A name for the delivery stream.
encryption?
Type:
Stream
(optional, default: StreamEncryption.UNENCRYPTED - unless encryptionKey
is provided, in which case this will be implicitly set to StreamEncryption.CUSTOMER_MANAGED
)
Indicates the type of customer master key (CMK) to use for server-side encryption, if any.
encryptionKey?
Type:
IKey
(optional, default: no KMS key will be used; if encryption
is set to CUSTOMER_MANAGED
, a KMS key will be created for you)
Customer managed key to server-side encrypt data in the stream.
role?
Type:
IRole
(optional, default: a role will be created with default permissions.)
The IAM role associated with this delivery stream.
Assumed by Kinesis Data Firehose to read from sources and encrypt data server-side.
sourceStream?
Type:
IStream
(optional, default: data must be written to the delivery stream via a direct put.)
The Kinesis data stream to use as a source for this delivery stream.