Interface IDeliveryStream
(experimental) Represents a Kinesis Data Firehose delivery stream.
Inherited Members
Namespace: Amazon.CDK.AWS.KinesisFirehose.Alpha
Assembly: Amazon.CDK.AWS.KinesisFirehose.Alpha.dll
Syntax (csharp)
public interface IDeliveryStream : IResource, IGrantable, IConnectable
Syntax (vb)
Public Interface IDeliveryStream
Inherits IResource, IConstruct, IDependable, IGrantable, IConnectable
Remarks
Stability: Experimental
Synopsis
Properties
DeliveryStreamArn | (experimental) The ARN of the delivery stream. |
DeliveryStreamName | (experimental) The name of the delivery stream. |
Methods
Grant(IGrantable, String[]) | (experimental) Grant the |
GrantPutRecords(IGrantable) | (experimental) Grant the |
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. |
Properties
DeliveryStreamArn
(experimental) The ARN of the delivery stream.
string DeliveryStreamArn { get; }
Property Value
System.String
Remarks
Stability: Experimental
Attribute: true
DeliveryStreamName
(experimental) The name of the delivery stream.
string DeliveryStreamName { get; }
Property Value
System.String
Remarks
Stability: Experimental
Attribute: true
Methods
Grant(IGrantable, String[])
(experimental) Grant the grantee
identity permissions to perform actions
.
Grant Grant(IGrantable grantee, params string[] actions)
Parameters
- grantee IGrantable
- actions System.String[]
Returns
Remarks
Stability: Experimental
GrantPutRecords(IGrantable)
(experimental) 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
Remarks
Stability: Experimental
Metric(String, IMetricOptions)
(experimental) Return the given named metric for this delivery stream.
Metric Metric(string metricName, IMetricOptions props = null)
Parameters
- metricName System.String
- props IMetricOptions
Returns
Remarks
Stability: Experimental
MetricBackupToS3Bytes(IMetricOptions)
(experimental) 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
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.
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: Experimental
MetricBackupToS3Records(IMetricOptions)
(experimental) 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
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.
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: Experimental
MetricIncomingRecords(IMetricOptions)
(experimental) 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
Remarks
By default, this metric will be calculated as an average over a period of 5 minutes.
Stability: Experimental