Class DeliveryStream
(deprecated) Create a Kinesis Data Firehose delivery stream.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.KinesisFirehose.Alpha
Assembly: Amazon.CDK.AWS.KinesisFirehose.Alpha.dll
Syntax (csharp)
public class DeliveryStream : Resource, IDeliveryStream, IResource, IGrantable, IConnectable
Syntax (vb)
Public Class DeliveryStream
Inherits Resource
Implements IDeliveryStream, IResource, IGrantable, IConnectable
Remarks
Stability: Deprecated
Resource: AWS::KinesisFirehose::DeliveryStream
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_LATEST,
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 {
Destination = s3Destination
});
Synopsis
Constructors
DeliveryStream(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
DeliveryStream(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
DeliveryStream(Construct, String, IDeliveryStreamProps) |
Properties
Connections | (deprecated) Network connections between Kinesis Data Firehose and other resources, i.e. Redshift cluster. |
DeliveryStreamArn | (deprecated) The ARN of the delivery stream. |
DeliveryStreamName | (deprecated) The name of the delivery stream. |
GrantPrincipal | (deprecated) The principal to grant permissions to. |
Methods
FromDeliveryStreamArn(Construct, String, String) | (deprecated) Import an existing delivery stream from its ARN. |
FromDeliveryStreamAttributes(Construct, String, IDeliveryStreamAttributes) | (deprecated) Import an existing delivery stream from its attributes. |
FromDeliveryStreamName(Construct, String, String) | (deprecated) Import an existing delivery stream from its name. |
Grant(IGrantable, String[]) | (deprecated) Grant the |
GrantPutRecords(IGrantable) | (deprecated) Grant the |
Metric(String, IMetricOptions) | (deprecated) Return the given named metric for this delivery stream. |
MetricBackupToS3Bytes(IMetricOptions) | (deprecated) Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period. |
MetricBackupToS3DataFreshness(IMetricOptions) | (deprecated) Metric for the age (from getting into Kinesis Data Firehose to now) of the oldest record in Kinesis Data Firehose. |
MetricBackupToS3Records(IMetricOptions) | (deprecated) Metric for the number of records delivered to Amazon S3 for backup over the specified time period. |
MetricIncomingBytes(IMetricOptions) | (deprecated) Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling. |
MetricIncomingRecords(IMetricOptions) | (deprecated) Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling. |
Constructors
DeliveryStream(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected DeliveryStream(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
DeliveryStream(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected DeliveryStream(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
DeliveryStream(Construct, String, IDeliveryStreamProps)
public DeliveryStream(Construct scope, string id, IDeliveryStreamProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IDeliveryStreamProps
Remarks
Stability: Deprecated
Properties
Connections
(deprecated) Network connections between Kinesis Data Firehose and other resources, i.e. Redshift cluster.
public virtual Connections_ Connections { get; }
Property Value
Remarks
Stability: Deprecated
DeliveryStreamArn
(deprecated) The ARN of the delivery stream.
public virtual string DeliveryStreamArn { get; }
Property Value
System.String
Remarks
Stability: Deprecated
DeliveryStreamName
(deprecated) The name of the delivery stream.
public virtual string DeliveryStreamName { get; }
Property Value
System.String
Remarks
Stability: Deprecated
GrantPrincipal
(deprecated) The principal to grant permissions to.
public virtual IPrincipal GrantPrincipal { get; }
Property Value
Remarks
Stability: Deprecated
Methods
FromDeliveryStreamArn(Construct, String, String)
(deprecated) Import an existing delivery stream from its ARN.
public static IDeliveryStream FromDeliveryStreamArn(Construct scope, string id, string deliveryStreamArn)
Parameters
- scope Constructs.Construct
- id System.String
- deliveryStreamArn System.String
Returns
Remarks
Stability: Deprecated
FromDeliveryStreamAttributes(Construct, String, IDeliveryStreamAttributes)
(deprecated) Import an existing delivery stream from its attributes.
public static IDeliveryStream FromDeliveryStreamAttributes(Construct scope, string id, IDeliveryStreamAttributes attrs)
Parameters
- scope Constructs.Construct
- id System.String
- attrs IDeliveryStreamAttributes
Returns
Remarks
Stability: Deprecated
FromDeliveryStreamName(Construct, String, String)
(deprecated) Import an existing delivery stream from its name.
public static IDeliveryStream FromDeliveryStreamName(Construct scope, string id, string deliveryStreamName)
Parameters
- scope Constructs.Construct
- id System.String
- deliveryStreamName System.String
Returns
Remarks
Stability: Deprecated
Grant(IGrantable, String[])
(deprecated) Grant the grantee
identity permissions to perform actions
.
public virtual Grant Grant(IGrantable grantee, params string[] actions)
Parameters
- grantee IGrantable
- actions System.String[]
Returns
Remarks
Stability: Deprecated
GrantPutRecords(IGrantable)
(deprecated) Grant the grantee
identity permissions to perform firehose:PutRecord
and firehose:PutRecordBatch
actions on this delivery stream.
public virtual Grant GrantPutRecords(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
Remarks
Stability: Deprecated
Metric(String, IMetricOptions)
(deprecated) Return the given named metric for this delivery stream.
public virtual Metric Metric(string metricName, IMetricOptions props = null)
Parameters
- metricName System.String
- props IMetricOptions
Returns
Remarks
Stability: Deprecated
MetricBackupToS3Bytes(IMetricOptions)
(deprecated) Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.
public virtual Metric MetricBackupToS3Bytes(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
By default, this metric will be calculated as an average over a period of 5 minutes.
Stability: Deprecated
MetricBackupToS3DataFreshness(IMetricOptions)
(deprecated) Metric for the age (from getting into Kinesis Data Firehose to now) of the oldest record in Kinesis Data Firehose.
public virtual Metric MetricBackupToS3DataFreshness(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
Any record older than this age has been delivered to the Amazon S3 bucket for backup.
By default, this metric will be calculated as an average over a period of 5 minutes.
Stability: Deprecated
MetricBackupToS3Records(IMetricOptions)
(deprecated) Metric for the number of records delivered to Amazon S3 for backup over the specified time period.
public virtual Metric MetricBackupToS3Records(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
By default, this metric will be calculated as an average over a period of 5 minutes.
Stability: Deprecated
MetricIncomingBytes(IMetricOptions)
(deprecated) Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.
public virtual Metric MetricIncomingBytes(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
By default, this metric will be calculated as an average over a period of 5 minutes.
Stability: Deprecated
MetricIncomingRecords(IMetricOptions)
(deprecated) Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling.
public virtual Metric MetricIncomingRecords(IMetricOptions props = null)
Parameters
- props IMetricOptions
Returns
Remarks
By default, this metric will be calculated as an average over a period of 5 minutes.
Stability: Deprecated