Package software.amazon.awscdk.services.kinesisfirehose

Class DeliveryStream

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.kinesisfirehose.DeliveryStream
All Implemented Interfaces:
IEnvironmentAware, IResource, IConnectable, IGrantable, IDeliveryStream, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:08.244Z") @Stability(Stable) public class DeliveryStream extends Resource implements IDeliveryStream
Create a Amazon Data Firehose delivery stream.

Example: 

 import software.amazon.awscdk.services.kinesisfirehose.*;
 Bucket bucket = new Bucket(this, "MyBucket");
 DeliveryStream stream = DeliveryStream.Builder.create(this, "MyStream")
         .destination(new S3Bucket(bucket))
         .build();
 TopicRule topicRule = TopicRule.Builder.create(this, "TopicRule")
         .sql(IotSql.fromStringAsVer20160323("SELECT * FROM 'device/+/data'"))
         .actions(List.of(
             FirehosePutRecordAction.Builder.create(stream)
                     .batchMode(true)
                     .recordSeparator(FirehoseRecordSeparator.NEWLINE)
                     .build()))
         .build();

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Stable) public static final String PROPERTY_INJECTION_ID
      Uniquely identifies this class.

  • Constructor Details

    • DeliveryStream

      protected DeliveryStream(software.amazon.jsii.JsiiObjectRef objRef)

    • DeliveryStream

      protected DeliveryStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • DeliveryStream

      @Stability(Stable) public DeliveryStream(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DeliveryStreamProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromDeliveryStreamArn

      @Stability(Stable) @NotNull public static IDeliveryStream fromDeliveryStreamArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String deliveryStreamArn)
      Import an existing delivery stream from its ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      deliveryStreamArn - This parameter is required.

    • fromDeliveryStreamAttributes

      @Stability(Stable) @NotNull public static IDeliveryStream fromDeliveryStreamAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DeliveryStreamAttributes attrs)
      Import an existing delivery stream from its attributes.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      attrs - This parameter is required.

    • fromDeliveryStreamName

      @Stability(Stable) @NotNull public static IDeliveryStream fromDeliveryStreamName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String deliveryStreamName)
      Import an existing delivery stream from its name.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      deliveryStreamName - This parameter is required.

    • grant

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

      Specified by:
      grant in interface IDeliveryStream
      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantPutRecords

      @Stability(Stable) @NotNull public Grant grantPutRecords(@NotNull IGrantable grantee)
      Grant the grantee identity permissions to perform firehose:PutRecord and firehose:PutRecordBatch actions on this delivery stream.

      Specified by:
      grantPutRecords in interface IDeliveryStream
      Parameters:
      grantee - This parameter is required.

    • metric

      @Stability(Stable) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this delivery stream.

      Specified by:
      metric in interface IDeliveryStream
      Parameters:
      metricName - This parameter is required.
      props -

    • metric

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

      Specified by:
      metric in interface IDeliveryStream
      Parameters:
      metricName - This parameter is required.

    • metricBackupToS3Bytes

      @Stability(Stable) @NotNull public 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.

      Specified by:
      metricBackupToS3Bytes in interface IDeliveryStream
      Parameters:
      props -

    • metricBackupToS3Bytes

      @Stability(Stable) @NotNull public 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.

      Specified by:
      metricBackupToS3Bytes in interface IDeliveryStream

    • metricBackupToS3DataFreshness

      @Stability(Stable) @NotNull public 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.

      Specified by:
      metricBackupToS3DataFreshness in interface IDeliveryStream
      Parameters:
      props -

    • metricBackupToS3DataFreshness

      @Stability(Stable) @NotNull public 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.

      Specified by:
      metricBackupToS3DataFreshness in interface IDeliveryStream

    • metricBackupToS3Records

      @Stability(Stable) @NotNull public 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.

      Specified by:
      metricBackupToS3Records in interface IDeliveryStream
      Parameters:
      props -

    • metricBackupToS3Records

      @Stability(Stable) @NotNull public 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.

      Specified by:
      metricBackupToS3Records in interface IDeliveryStream

    • metricIncomingBytes

      @Stability(Stable) @NotNull public 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.

      Specified by:
      metricIncomingBytes in interface IDeliveryStream
      Parameters:
      props -

    • metricIncomingBytes

      @Stability(Stable) @NotNull public 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.

      Specified by:
      metricIncomingBytes in interface IDeliveryStream

    • metricIncomingRecords

      @Stability(Stable) @NotNull public 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.

      Specified by:
      metricIncomingRecords in interface IDeliveryStream
      Parameters:
      props -

    • metricIncomingRecords

      @Stability(Stable) @NotNull public 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.

      Specified by:
      metricIncomingRecords in interface IDeliveryStream

    • getConnections

      @Stability(Stable) @NotNull public Connections getConnections()
      Network connections between Amazon Data Firehose and other resources, i.e. Redshift cluster.
      Specified by:
      getConnections in interface IConnectable

    • getDeliveryStreamArn

      @Stability(Stable) @NotNull public String getDeliveryStreamArn()
      The ARN of the delivery stream.
      Specified by:
      getDeliveryStreamArn in interface IDeliveryStream

    • getDeliveryStreamName

      @Stability(Stable) @NotNull public String getDeliveryStreamName()
      The name of the delivery stream.
      Specified by:
      getDeliveryStreamName in interface IDeliveryStream

    • getGrantPrincipal

      @Stability(Stable) @NotNull public IPrincipal getGrantPrincipal()
      The principal to grant permissions to.
      Specified by:
      getGrantPrincipal in interface IGrantable