Class DeliveryStreamProps
(experimental) Properties for a new delivery stream.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.AWS.KinesisFirehose.dll
Syntax (csharp)
public class DeliveryStreamProps : Object, IDeliveryStreamProps
Syntax (vb)
Public Class DeliveryStreamProps
Inherits Object
Implements IDeliveryStreamProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
Bucket bucket;
// Provide a Lambda function that will transform records before delivery, with custom
// buffering and retry configuration
var lambdaFunction = new Function(this, "Processor", new FunctionProps {
Runtime = Runtime.NODEJS_14_X,
Handler = "index.handler",
Code = Code.FromAsset(Join(__dirname, "process-records"))
});
var lambdaProcessor = new LambdaFunctionProcessor(lambdaFunction, new DataProcessorProps {
BufferInterval = Duration.Minutes(5),
BufferSize = Size.Mebibytes(5),
Retries = 5
});
var s3Destination = new S3Bucket(bucket, new S3BucketProps {
Processor = lambdaProcessor
});
new DeliveryStream(this, "Delivery Stream", new DeliveryStreamProps {
Destinations = new [] { s3Destination }
});
Synopsis
Constructors
DeliveryStreamProps() |
Properties
DeliveryStreamName | (experimental) A name for the delivery stream. |
Destinations | (experimental) The destinations that this delivery stream will deliver data to. |
Encryption | (experimental) Indicates the type of customer master key (CMK) to use for server-side encryption, if any. |
EncryptionKey | (experimental) Customer managed key to server-side encrypt data in the stream. |
Role | (experimental) The IAM role associated with this delivery stream. |
SourceStream | (experimental) The Kinesis data stream to use as a source for this delivery stream. |
Constructors
DeliveryStreamProps()
public DeliveryStreamProps()
Properties
DeliveryStreamName
(experimental) A name for the delivery stream.
public string DeliveryStreamName { get; set; }
Property Value
System.String
Remarks
Default: - a name is generated by CloudFormation.
Stability: Experimental
Destinations
(experimental) The destinations that this delivery stream will deliver data to.
public IDestination[] Destinations { get; set; }
Property Value
Remarks
Only a singleton array is supported at this time.
Stability: Experimental
Encryption
(experimental) Indicates the type of customer master key (CMK) to use for server-side encryption, if any.
public Nullable<StreamEncryption> Encryption { get; set; }
Property Value
System.Nullable<StreamEncryption>
Remarks
Default: StreamEncryption.UNENCRYPTED - unless encryptionKey
is provided, in which case this will be implicitly set to StreamEncryption.CUSTOMER_MANAGED
Stability: Experimental
EncryptionKey
(experimental) Customer managed key to server-side encrypt data in the stream.
public IKey EncryptionKey { get; set; }
Property Value
Remarks
Default: - no KMS key will be used; if encryption
is set to CUSTOMER_MANAGED
, a KMS key will be created for you
Stability: Experimental
Role
(experimental) The IAM role associated with this delivery stream.
public IRole Role { get; set; }
Property Value
Remarks
Assumed by Kinesis Data Firehose to read from sources and encrypt data server-side.
Default: - a role will be created with default permissions.
Stability: Experimental
SourceStream
(experimental) The Kinesis data stream to use as a source for this delivery stream.
public IStream SourceStream { get; set; }
Property Value
Remarks
Default: - data must be written to the delivery stream via a direct put.
Stability: Experimental