software.amazon.awscdk.services.kinesisfirehose

Interface IDeliveryStream

All Superinterfaces:

IConnectable, software.constructs.IConstruct, IDependable, IGrantable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IDeliveryStream.Jsii$Default

All Known Implementing Classes:

DeliveryStream, IDeliveryStream.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:42.303Z")
 @Stability(value=Experimental)
public interface IDeliveryStream
extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable, IConnectable

(experimental) Represents a Kinesis Data Firehose delivery stream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IDeliveryStream.Jsii$Default Internal default implementation for IDeliveryStream.
static class	IDeliveryStream.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
String	getDeliveryStreamArn() (experimental) The ARN of the delivery stream.
String	getDeliveryStreamName() (experimental) The name of the delivery stream.
Grant	grant(IGrantable grantee, String... actions) (experimental) Grant the `grantee` identity permissions to perform `actions`.
Grant	grantPutRecords(IGrantable grantee) (experimental) Grant the `grantee` identity permissions to perform `firehose:PutRecord` and `firehose:PutRecordBatch` actions on this delivery stream.
Metric	metric(String metricName) (experimental) Return the given named metric for this delivery stream.
Metric	metric(String metricName, MetricOptions props) (experimental) Return the given named metric for this delivery stream.
Metric	metricBackupToS3Bytes() (experimental) Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.
Metric	metricBackupToS3Bytes(MetricOptions props) (experimental) Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.
Metric	metricBackupToS3DataFreshness() (experimental) Metric for the age (from getting into Kinesis Data Firehose to now) of the oldest record in Kinesis Data Firehose.
Metric	metricBackupToS3DataFreshness(MetricOptions props) (experimental) Metric for the age (from getting into Kinesis Data Firehose to now) of the oldest record in Kinesis Data Firehose.
Metric	metricBackupToS3Records() (experimental) Metric for the number of records delivered to Amazon S3 for backup over the specified time period.
Metric	metricBackupToS3Records(MetricOptions props) (experimental) Metric for the number of records delivered to Amazon S3 for backup over the specified time period.
Metric	metricIncomingBytes() (experimental) Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.
Metric	metricIncomingBytes(MetricOptions props) (experimental) Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.
Metric	metricIncomingRecords() (experimental) Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling.
Metric	metricIncomingRecords(MetricOptions props) (experimental) Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling.

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable

getGrantPrincipal

Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable

getConnections

Method Detail

getDeliveryStreamArn

@Stability(value=Experimental)
 @NotNull
String getDeliveryStreamArn()

(experimental) The ARN of the delivery stream.

getDeliveryStreamName

@Stability(value=Experimental)
 @NotNull
String getDeliveryStreamName()

(experimental) The name of the delivery stream.

grant

@Stability(value=Experimental)
 @NotNull
Grant grant(@NotNull
                                                     IGrantable grantee,
                                                     @NotNull
                                                     String... actions)

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

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantPutRecords

@Stability(value=Experimental)
 @NotNull
Grant grantPutRecords(@NotNull
                                                               IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

metric

@Stability(value=Experimental)
 @NotNull
Metric metric(@NotNull
                                                       String metricName,
                                                       @Nullable
                                                       MetricOptions props)

(experimental) Return the given named metric for this delivery stream.

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Experimental)
 @NotNull
Metric metric(@NotNull
                                                       String metricName)

(experimental) Return the given named metric for this delivery stream.

Parameters:

metricName - This parameter is required.

metricBackupToS3Bytes

@Stability(value=Experimental)
 @NotNull
Metric metricBackupToS3Bytes(@Nullable
                                                                      MetricOptions props)

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

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

Parameters:

props -

metricBackupToS3Bytes

@Stability(value=Experimental)
 @NotNull
Metric metricBackupToS3Bytes()

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

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

metricBackupToS3DataFreshness

@Stability(value=Experimental)
 @NotNull
Metric metricBackupToS3DataFreshness(@Nullable
                                                                              MetricOptions props)

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

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.

Parameters:

props -

metricBackupToS3DataFreshness

@Stability(value=Experimental)
 @NotNull
Metric metricBackupToS3DataFreshness()

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

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

@Stability(value=Experimental)
 @NotNull
Metric metricBackupToS3Records(@Nullable
                                                                        MetricOptions props)

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

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

Parameters:

props -

metricBackupToS3Records

@Stability(value=Experimental)
 @NotNull
Metric metricBackupToS3Records()

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

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

metricIncomingBytes

@Stability(value=Experimental)
 @NotNull
Metric metricIncomingBytes(@Nullable
                                                                    MetricOptions props)

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

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

Parameters:

props -

metricIncomingBytes

@Stability(value=Experimental)
 @NotNull
Metric metricIncomingBytes()

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

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

metricIncomingRecords

@Stability(value=Experimental)
 @NotNull
Metric metricIncomingRecords(@Nullable
                                                                      MetricOptions props)

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

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

Parameters:

props -

metricIncomingRecords

@Stability(value=Experimental)
 @NotNull
Metric metricIncomingRecords()

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

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