Interface IDeliveryStream

Represents an Amazon Data Firehose delivery stream.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Env

IResource.Stack

IGrantable.GrantPrincipal

IConnectable.Connections

Namespace: Amazon.CDK.AWS.KinesisFirehose

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IDeliveryStream : IResource, IConstruct, IDependable, IGrantable, IConnectable

Syntax (vb)

Public Interface IDeliveryStream Inherits IResource, IConstruct, IDependable, IGrantable, IConnectable

Synopsis

Properties

DeliveryStreamArn	The ARN of the delivery stream.
DeliveryStreamName	The name of the delivery stream.

Methods

Grant(IGrantable, params string[])	Grant the grantee identity permissions to perform actions.
GrantPutRecords(IGrantable)	Grant the grantee identity permissions to perform firehose:PutRecord and firehose:PutRecordBatch actions on this delivery stream.
Metric(string, IMetricOptions?)	Return the given named metric for this delivery stream.
MetricBackupToS3Bytes(IMetricOptions?)	Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.
MetricBackupToS3DataFreshness(IMetricOptions?)	Metric for the age (from getting into Amazon Data Firehose to now) of the oldest record in Amazon Data Firehose.
MetricBackupToS3Records(IMetricOptions?)	Metric for the number of records delivered to Amazon S3 for backup over the specified time period.
MetricIncomingBytes(IMetricOptions?)	Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.
MetricIncomingRecords(IMetricOptions?)	Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling.

Properties

DeliveryStreamArn

The ARN of the delivery stream.

string DeliveryStreamArn { get; }

Property Value

string

Remarks

Attribute: true

DeliveryStreamName

The name of the delivery stream.

string DeliveryStreamName { get; }

Property Value

string

Remarks

Attribute: true

Methods

Grant(IGrantable, params string[])

Grant the grantee identity permissions to perform actions.

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

Parameters

grantee IGrantable

actions string[]

Returns

Grant

GrantPutRecords(IGrantable)

Grant the grantee identity permissions to perform firehose:PutRecord and firehose:PutRecordBatch actions on this delivery stream.

Grant GrantPutRecords(IGrantable grantee)

Parameters

grantee IGrantable

Returns

Grant

Metric(string, IMetricOptions?)

Return the given named metric for this delivery stream.

Metric Metric(string metricName, IMetricOptions? props = null)

Parameters

metricName string

props IMetricOptions

Returns

Metric

MetricBackupToS3Bytes(IMetricOptions?)

Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.

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.

MetricBackupToS3DataFreshness(IMetricOptions?)

Metric for the age (from getting into Amazon Data Firehose to now) of the oldest record in Amazon Data Firehose.

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.

MetricBackupToS3Records(IMetricOptions?)

Metric for the number of records delivered to Amazon S3 for backup over the specified time period.

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.

MetricIncomingBytes(IMetricOptions?)

Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.

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.

MetricIncomingRecords(IMetricOptions?)

Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling.

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.