Class DeliveryStream

(experimental) Create a Kinesis Data Firehose delivery stream.

Inheritance

System.Object

Resource

DeliveryStream

Implements

IDeliveryStream

IResource

Constructs.IConstruct

Constructs.IDependable

IGrantable

IConnectable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

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: Experimental

Resource: AWS::KinesisFirehose::DeliveryStream

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.KinesisFirehose.Alpha;
using Amazon.CDK.AWS.KinesisFirehose.Destinations.Alpha;


var bucket = new Bucket(this, "MyBucket");
var stream = new DeliveryStream(this, "MyStream", new DeliveryStreamProps {
    Destinations = new [] { new S3Bucket(bucket) }
});

var topicRule = new TopicRule(this, "TopicRule", new TopicRuleProps {
    Sql = IotSql.FromStringAsVer20160323("SELECT * FROM 'device/+/data'"),
    Actions = new [] {
        new FirehosePutRecordAction(stream, new FirehosePutRecordActionProps {
            BatchMode = true,
            RecordSeparator = FirehoseRecordSeparator.NEWLINE
        }) }
});

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	(experimental) Network connections between Kinesis Data Firehose and other resources, i.e. Redshift cluster.
DeliveryStreamArn	(experimental) The ARN of the delivery stream.
DeliveryStreamName	(experimental) The name of the delivery stream.
GrantPrincipal	(experimental) The principal to grant permissions to.

Methods

FromDeliveryStreamArn(Construct, String, String)	(experimental) Import an existing delivery stream from its ARN.
FromDeliveryStreamAttributes(Construct, String, IDeliveryStreamAttributes)	(experimental) Import an existing delivery stream from its attributes.
FromDeliveryStreamName(Construct, String, String)	(experimental) Import an existing delivery stream from its name.
Grant(IGrantable, String[])	(experimental) Grant the grantee identity permissions to perform actions.
GrantPutRecords(IGrantable)	(experimental) Grant the grantee identity permissions to perform firehose:PutRecord and firehose:PutRecordBatch actions on this delivery stream.
Metric(String, IMetricOptions)	(experimental) Return the given named metric for this delivery stream.
MetricBackupToS3Bytes(IMetricOptions)	(experimental) Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.
MetricBackupToS3DataFreshness(IMetricOptions)	(experimental) Metric for the age (from getting into Kinesis Data Firehose to now) of the oldest record in Kinesis Data Firehose.
MetricBackupToS3Records(IMetricOptions)	(experimental) Metric for the number of records delivered to Amazon S3 for backup over the specified time period.
MetricIncomingBytes(IMetricOptions)	(experimental) Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.
MetricIncomingRecords(IMetricOptions)	(experimental) 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: Experimental

Properties

Connections

(experimental) Network connections between Kinesis Data Firehose and other resources, i.e. Redshift cluster.

public virtual Connections_ Connections { get; }

Property Value

Connections_

Remarks

Stability: Experimental

DeliveryStreamArn

(experimental) The ARN of the delivery stream.

public virtual string DeliveryStreamArn { get; }

Property Value

System.String

Remarks

Stability: Experimental

DeliveryStreamName

(experimental) The name of the delivery stream.

public virtual string DeliveryStreamName { get; }

Property Value

System.String

Remarks

Stability: Experimental

GrantPrincipal

(experimental) The principal to grant permissions to.

public virtual IPrincipal GrantPrincipal { get; }

Property Value

IPrincipal

Remarks

Stability: Experimental

Methods

FromDeliveryStreamArn(Construct, String, String)

(experimental) 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

IDeliveryStream

Remarks

Stability: Experimental

FromDeliveryStreamAttributes(Construct, String, IDeliveryStreamAttributes)

(experimental) 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

IDeliveryStream

Remarks

Stability: Experimental

FromDeliveryStreamName(Construct, String, String)

(experimental) 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

IDeliveryStream

Remarks

Stability: Experimental

Grant(IGrantable, String[])

(experimental) Grant the grantee identity permissions to perform actions.

public virtual Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable

actions System.String[]

Returns

Grant

Remarks

Stability: Experimental

GrantPutRecords(IGrantable)

(experimental) 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

Grant

Remarks

Stability: Experimental

Metric(String, IMetricOptions)

(experimental) 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

Metric

Remarks

Stability: Experimental

MetricBackupToS3Bytes(IMetricOptions)

(experimental) 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

Metric

Remarks

By default, this metric will be calculated as an average over a period of 5 minutes.

Stability: Experimental

MetricBackupToS3DataFreshness(IMetricOptions)

(experimental) 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

Metric

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: Experimental

MetricBackupToS3Records(IMetricOptions)

(experimental) 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

Metric

Remarks

By default, this metric will be calculated as an average over a period of 5 minutes.

Stability: Experimental

MetricIncomingBytes(IMetricOptions)

(experimental) 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

Metric

Remarks

By default, this metric will be calculated as an average over a period of 5 minutes.

Stability: Experimental

MetricIncomingRecords(IMetricOptions)

(experimental) 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

Metric

Remarks

By default, this metric will be calculated as an average over a period of 5 minutes.

Stability: Experimental

Implements

IDeliveryStream

IResource

Constructs.IConstruct

Constructs.IDependable

IGrantable

IConnectable