Package software.amazon.awscdk.services.kinesisfirehose

Interface IDeliveryStream

All Superinterfaces:
IConnectable, software.constructs.IConstruct, IDeliveryStreamRef, software.constructs.IDependable, IEnvironmentAware, 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.121.0 (build d7af9b9)", date="2025-12-18T18:20:12.481Z") @Stability(Stable) public interface IDeliveryStream extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable, IConnectable, IDeliveryStreamRef
Represents an Amazon Data Firehose delivery stream.

  • Method Details

    • getDeliveryStreamArn

      @Stability(Stable) @NotNull String getDeliveryStreamArn()
      The ARN of the delivery stream.

    • getDeliveryStreamName

      @Stability(Stable) @NotNull String getDeliveryStreamName()
      The name of the delivery stream.

    • grant

      @Stability(Stable) @NotNull Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      Grant the grantee identity permissions to perform actions.

      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantPutRecords

      @Stability(Stable) @NotNull Grant grantPutRecords(@NotNull IGrantable grantee)
      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(Stable) @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this delivery stream.

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Stable) @NotNull Metric metric(@NotNull String metricName)
      Return the given named metric for this delivery stream.

      Parameters:
      metricName - This parameter is required.

    • metricBackupToS3Bytes

      @Stability(Stable) @NotNull Metric metricBackupToS3Bytes(@Nullable MetricOptions props)
      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(Stable) @NotNull Metric metricBackupToS3Bytes()
      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(Stable) @NotNull Metric metricBackupToS3DataFreshness(@Nullable MetricOptions props)
      Metric for the age (from getting into Amazon Data Firehose to now) of the oldest record in Amazon 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(Stable) @NotNull Metric metricBackupToS3DataFreshness()
      Metric for the age (from getting into Amazon Data Firehose to now) of the oldest record in Amazon 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(Stable) @NotNull Metric metricBackupToS3Records(@Nullable MetricOptions props)
      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(Stable) @NotNull Metric metricBackupToS3Records()
      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(Stable) @NotNull Metric metricIncomingBytes(@Nullable MetricOptions props)
      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(Stable) @NotNull Metric metricIncomingBytes()
      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(Stable) @NotNull Metric metricIncomingRecords(@Nullable MetricOptions props)
      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(Stable) @NotNull Metric metricIncomingRecords()
      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.

    • getNode

      @Stability(Stable) @NotNull software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct

    • getEnv

      @Stability(Stable) @NotNull ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

      For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IEnvironmentAware