Package software.amazon.awscdk.services.kinesisfirehose

Class CfnDeliveryStream

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IDeliveryStreamRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:44.034Z") @Stability(Stable) public class CfnDeliveryStream extends CfnResource implements IInspectable, IDeliveryStreamRef, ITaggable
The AWS::KinesisFirehose::DeliveryStream resource specifies an Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3), Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES) destination.

For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream in the Amazon Kinesis Data Firehose Developer Guide .

Example: 

 Bucket destinationBucket = new Bucket(this, "Bucket");
 Role deliveryStreamRole = Role.Builder.create(this, "Role")
         .assumedBy(new ServicePrincipal("firehose.amazonaws.com"))
         .build();
 CfnDeliveryStream stream = CfnDeliveryStream.Builder.create(this, "MyStream")
         .deliveryStreamName("amazon-apigateway-delivery-stream")
         .s3DestinationConfiguration(S3DestinationConfigurationProperty.builder()
                 .bucketArn(destinationBucket.getBucketArn())
                 .roleArn(deliveryStreamRole.getRoleArn())
                 .build())
         .build();
 RestApi api = RestApi.Builder.create(this, "books")
         .deployOptions(StageOptions.builder()
                 .accessLogDestination(new FirehoseLogDestination(stream))
                 .accessLogFormat(AccessLogFormat.jsonWithStandardFields())
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDeliveryStream

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

    • CfnDeliveryStream

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

    • CfnDeliveryStream

      @Stability(Stable) public CfnDeliveryStream(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDeliveryStreamProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnDeliveryStream

      @Stability(Stable) public CfnDeliveryStream(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • fromDeliveryStreamArn

      @Stability(Stable) @NotNull public static IDeliveryStreamRef fromDeliveryStreamArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IDeliveryStreamRef from an ARN.

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

    • fromDeliveryStreamName

      @Stability(Stable) @NotNull public static IDeliveryStreamRef fromDeliveryStreamName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String deliveryStreamName)
      Creates a new IDeliveryStreamRef from a deliveryStreamName.

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

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the delivery stream, such as arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDeliveryStreamRef

      @Stability(Stable) @NotNull public DeliveryStreamReference getDeliveryStreamRef()
      A reference to a DeliveryStream resource.
      Specified by:
      getDeliveryStreamRef in interface IDeliveryStreamRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAmazonOpenSearchServerlessDestinationConfiguration

      @Stability(Stable) @Nullable public Object getAmazonOpenSearchServerlessDestinationConfiguration()
      Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

      Returns union: either IResolvable or CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty

    • setAmazonOpenSearchServerlessDestinationConfiguration

      @Stability(Stable) public void setAmazonOpenSearchServerlessDestinationConfiguration(@Nullable IResolvable value)
      Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

    • setAmazonOpenSearchServerlessDestinationConfiguration

      @Stability(Stable) public void setAmazonOpenSearchServerlessDestinationConfiguration(@Nullable CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty value)
      Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

    • getAmazonopensearchserviceDestinationConfiguration

      @Stability(Stable) @Nullable public Object getAmazonopensearchserviceDestinationConfiguration()
      The destination in Amazon OpenSearch Service.

      Returns union: either IResolvable or CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

    • setAmazonopensearchserviceDestinationConfiguration

      @Stability(Stable) public void setAmazonopensearchserviceDestinationConfiguration(@Nullable IResolvable value)
      The destination in Amazon OpenSearch Service.

    • setAmazonopensearchserviceDestinationConfiguration

      @Stability(Stable) public void setAmazonopensearchserviceDestinationConfiguration(@Nullable CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty value)
      The destination in Amazon OpenSearch Service.

    • getDatabaseSourceConfiguration

      @Stability(Stable) @Nullable public Object getDatabaseSourceConfiguration()
      The top level object for configuring streams with database as a source.

      Returns union: either IResolvable or CfnDeliveryStream.DatabaseSourceConfigurationProperty

    • setDatabaseSourceConfiguration

      @Stability(Stable) public void setDatabaseSourceConfiguration(@Nullable IResolvable value)
      The top level object for configuring streams with database as a source.

    • setDatabaseSourceConfiguration

      @Stability(Stable) public void setDatabaseSourceConfiguration(@Nullable CfnDeliveryStream.DatabaseSourceConfigurationProperty value)
      The top level object for configuring streams with database as a source.

    • getDeliveryStreamEncryptionConfigurationInput

      @Stability(Stable) @Nullable public Object getDeliveryStreamEncryptionConfigurationInput()
      Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

      Returns union: either IResolvable or CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty

    • setDeliveryStreamEncryptionConfigurationInput

      @Stability(Stable) public void setDeliveryStreamEncryptionConfigurationInput(@Nullable IResolvable value)
      Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

    • setDeliveryStreamEncryptionConfigurationInput

      @Stability(Stable) public void setDeliveryStreamEncryptionConfigurationInput(@Nullable CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty value)
      Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

    • getDeliveryStreamName

      @Stability(Stable) @Nullable public String getDeliveryStreamName()
      The name of the Firehose stream.

    • setDeliveryStreamName

      @Stability(Stable) public void setDeliveryStreamName(@Nullable String value)
      The name of the Firehose stream.

    • getDeliveryStreamType

      @Stability(Stable) @Nullable public String getDeliveryStreamType()
      The Firehose stream type.

      This can be one of the following values:.

    • setDeliveryStreamType

      @Stability(Stable) public void setDeliveryStreamType(@Nullable String value)
      The Firehose stream type.

      This can be one of the following values:.

    • getDirectPutSourceConfiguration

      @Stability(Stable) @Nullable public Object getDirectPutSourceConfiguration()
      The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

      Returns union: either IResolvable or CfnDeliveryStream.DirectPutSourceConfigurationProperty

    • setDirectPutSourceConfiguration

      @Stability(Stable) public void setDirectPutSourceConfiguration(@Nullable IResolvable value)
      The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

    • setDirectPutSourceConfiguration

      @Stability(Stable) public void setDirectPutSourceConfiguration(@Nullable CfnDeliveryStream.DirectPutSourceConfigurationProperty value)
      The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

    • getElasticsearchDestinationConfiguration

      @Stability(Stable) @Nullable public Object getElasticsearchDestinationConfiguration()
      An Amazon ES destination for the delivery stream.

      Returns union: either IResolvable or CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

    • setElasticsearchDestinationConfiguration

      @Stability(Stable) public void setElasticsearchDestinationConfiguration(@Nullable IResolvable value)
      An Amazon ES destination for the delivery stream.

    • setElasticsearchDestinationConfiguration

      @Stability(Stable) public void setElasticsearchDestinationConfiguration(@Nullable CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty value)
      An Amazon ES destination for the delivery stream.

    • getExtendedS3DestinationConfiguration

      @Stability(Stable) @Nullable public Object getExtendedS3DestinationConfiguration()
      An Amazon S3 destination for the delivery stream.

      Returns union: either IResolvable or CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty

    • setExtendedS3DestinationConfiguration

      @Stability(Stable) public void setExtendedS3DestinationConfiguration(@Nullable IResolvable value)
      An Amazon S3 destination for the delivery stream.

    • setExtendedS3DestinationConfiguration

      @Stability(Stable) public void setExtendedS3DestinationConfiguration(@Nullable CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty value)
      An Amazon S3 destination for the delivery stream.

    • getHttpEndpointDestinationConfiguration

      @Stability(Stable) @Nullable public Object getHttpEndpointDestinationConfiguration()
      Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

      Returns union: either IResolvable or CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty

    • setHttpEndpointDestinationConfiguration

      @Stability(Stable) public void setHttpEndpointDestinationConfiguration(@Nullable IResolvable value)
      Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

    • setHttpEndpointDestinationConfiguration

      @Stability(Stable) public void setHttpEndpointDestinationConfiguration(@Nullable CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty value)
      Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

    • getIcebergDestinationConfiguration

      @Stability(Stable) @Nullable public Object getIcebergDestinationConfiguration()
      Specifies the destination configure settings for Apache Iceberg Table.

      Returns union: either IResolvable or CfnDeliveryStream.IcebergDestinationConfigurationProperty

    • setIcebergDestinationConfiguration

      @Stability(Stable) public void setIcebergDestinationConfiguration(@Nullable IResolvable value)
      Specifies the destination configure settings for Apache Iceberg Table.

    • setIcebergDestinationConfiguration

      @Stability(Stable) public void setIcebergDestinationConfiguration(@Nullable CfnDeliveryStream.IcebergDestinationConfigurationProperty value)
      Specifies the destination configure settings for Apache Iceberg Table.

    • getKinesisStreamSourceConfiguration

      @Stability(Stable) @Nullable public Object getKinesisStreamSourceConfiguration()
      When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

      Returns union: either IResolvable or CfnDeliveryStream.KinesisStreamSourceConfigurationProperty

    • setKinesisStreamSourceConfiguration

      @Stability(Stable) public void setKinesisStreamSourceConfiguration(@Nullable IResolvable value)
      When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

    • setKinesisStreamSourceConfiguration

      @Stability(Stable) public void setKinesisStreamSourceConfiguration(@Nullable CfnDeliveryStream.KinesisStreamSourceConfigurationProperty value)
      When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.

    • getMskSourceConfiguration

      @Stability(Stable) @Nullable public Object getMskSourceConfiguration()
      The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

      Returns union: either IResolvable or CfnDeliveryStream.MSKSourceConfigurationProperty

    • setMskSourceConfiguration

      @Stability(Stable) public void setMskSourceConfiguration(@Nullable IResolvable value)
      The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

    • setMskSourceConfiguration

      @Stability(Stable) public void setMskSourceConfiguration(@Nullable CfnDeliveryStream.MSKSourceConfigurationProperty value)
      The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

    • getRedshiftDestinationConfiguration

      @Stability(Stable) @Nullable public Object getRedshiftDestinationConfiguration()
      An Amazon Redshift destination for the delivery stream.

      Returns union: either IResolvable or CfnDeliveryStream.RedshiftDestinationConfigurationProperty

    • setRedshiftDestinationConfiguration

      @Stability(Stable) public void setRedshiftDestinationConfiguration(@Nullable IResolvable value)
      An Amazon Redshift destination for the delivery stream.

    • setRedshiftDestinationConfiguration

      @Stability(Stable) public void setRedshiftDestinationConfiguration(@Nullable CfnDeliveryStream.RedshiftDestinationConfigurationProperty value)
      An Amazon Redshift destination for the delivery stream.

    • getS3DestinationConfiguration

      @Stability(Stable) @Nullable public Object getS3DestinationConfiguration()
      The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

      Returns union: either IResolvable or CfnDeliveryStream.S3DestinationConfigurationProperty

    • setS3DestinationConfiguration

      @Stability(Stable) public void setS3DestinationConfiguration(@Nullable IResolvable value)
      The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

    • setS3DestinationConfiguration

      @Stability(Stable) public void setS3DestinationConfiguration(@Nullable CfnDeliveryStream.S3DestinationConfigurationProperty value)
      The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

    • getSnowflakeDestinationConfiguration

      @Stability(Stable) @Nullable public Object getSnowflakeDestinationConfiguration()
      Configure Snowflake destination.

      Returns union: either IResolvable or CfnDeliveryStream.SnowflakeDestinationConfigurationProperty

    • setSnowflakeDestinationConfiguration

      @Stability(Stable) public void setSnowflakeDestinationConfiguration(@Nullable IResolvable value)
      Configure Snowflake destination.

    • setSnowflakeDestinationConfiguration

      @Stability(Stable) public void setSnowflakeDestinationConfiguration(@Nullable CfnDeliveryStream.SnowflakeDestinationConfigurationProperty value)
      Configure Snowflake destination.

    • getSplunkDestinationConfiguration

      @Stability(Stable) @Nullable public Object getSplunkDestinationConfiguration()
      The configuration of a destination in Splunk for the delivery stream.

      Returns union: either IResolvable or CfnDeliveryStream.SplunkDestinationConfigurationProperty

    • setSplunkDestinationConfiguration

      @Stability(Stable) public void setSplunkDestinationConfiguration(@Nullable IResolvable value)
      The configuration of a destination in Splunk for the delivery stream.

    • setSplunkDestinationConfiguration

      @Stability(Stable) public void setSplunkDestinationConfiguration(@Nullable CfnDeliveryStream.SplunkDestinationConfigurationProperty value)
      The configuration of a destination in Splunk for the delivery stream.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A set of tags to assign to the Firehose stream.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A set of tags to assign to the Firehose stream.