software.amazon.awscdk.services.kinesisfirehose

Class DeliveryStream

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.kinesisfirehose.DeliveryStream

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-07T23:47:09.698Z")
 @Stability(value=Experimental)
public class DeliveryStream
extends Resource
implements IDeliveryStream

(experimental) Create a Kinesis Data Firehose delivery stream.

Example:

 Bucket bucket;
 // Provide a Lambda function that will transform records before delivery, with custom
 // buffering and retry configuration
 Function lambdaFunction = Function.Builder.create(this, "Processor")
         .runtime(Runtime.NODEJS_12_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "process-records")))
         .build();
 LambdaFunctionProcessor lambdaProcessor = LambdaFunctionProcessor.Builder.create(lambdaFunction)
         .bufferInterval(Duration.minutes(5))
         .bufferSize(Size.mebibytes(5))
         .retries(5)
         .build();
 S3Bucket s3Destination = S3Bucket.Builder.create(bucket)
         .processor(lambdaProcessor)
         .build();
 DeliveryStream.Builder.create(this, "Delivery Stream")
         .destinations(List.of(s3Destination))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DeliveryStream.Builder (experimental) A fluent builder for DeliveryStream.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kinesisfirehose.IDeliveryStream

IDeliveryStream.Jsii$Default, IDeliveryStream.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	DeliveryStream(software.constructs.Construct scope, String id, DeliveryStreamProps props)
protected	DeliveryStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DeliveryStream(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static IDeliveryStream	fromDeliveryStreamArn(software.constructs.Construct scope, String id, String deliveryStreamArn) (experimental) Import an existing delivery stream from its ARN.
static IDeliveryStream	fromDeliveryStreamAttributes(software.constructs.Construct scope, String id, DeliveryStreamAttributes attrs) (experimental) Import an existing delivery stream from its attributes.
static IDeliveryStream	fromDeliveryStreamName(software.constructs.Construct scope, String id, String deliveryStreamName) (experimental) Import an existing delivery stream from its name.
Connections	getConnections() (experimental) Network connections between Kinesis Data Firehose and other resources, i.e.
String	getDeliveryStreamArn() (experimental) The ARN of the delivery stream.
String	getDeliveryStreamName() (experimental) The name of the delivery stream.
IPrincipal	getGrantPrincipal() (experimental) The principal to grant permissions to.
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 class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

DeliveryStream

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

DeliveryStream

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

DeliveryStream

@Stability(value=Experimental)
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 Detail

fromDeliveryStreamArn

@Stability(value=Experimental)
 @NotNull
public static IDeliveryStream fromDeliveryStreamArn(@NotNull
                                                                                             software.constructs.Construct scope,
                                                                                             @NotNull
                                                                                             String id,
                                                                                             @NotNull
                                                                                             String deliveryStreamArn)

(experimental) 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(value=Experimental)
 @NotNull
public static IDeliveryStream fromDeliveryStreamAttributes(@NotNull
                                                                                                    software.constructs.Construct scope,
                                                                                                    @NotNull
                                                                                                    String id,
                                                                                                    @NotNull
                                                                                                    DeliveryStreamAttributes attrs)

(experimental) 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(value=Experimental)
 @NotNull
public static IDeliveryStream fromDeliveryStreamName(@NotNull
                                                                                              software.constructs.Construct scope,
                                                                                              @NotNull
                                                                                              String id,
                                                                                              @NotNull
                                                                                              String deliveryStreamName)

(experimental) 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(value=Experimental)
 @NotNull
public Grant grant(@NotNull
                                                            IGrantable grantee,
                                                            @NotNull
                                                            String... actions)

(experimental) 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(value=Experimental)
 @NotNull
public Grant grantPutRecords(@NotNull
                                                                      IGrantable grantee)

(experimental) 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(value=Experimental)
 @NotNull
public Metric metric(@NotNull
                                                              String metricName,
                                                              @Nullable
                                                              MetricOptions props)

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

Specified by:

metric in interface IDeliveryStream

Parameters:

metricName - This parameter is required.

props -

metric

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

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

Specified by:

metric in interface IDeliveryStream

Parameters:

metricName - This parameter is required.

metricBackupToS3Bytes

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

metricBackupToS3Bytes in interface IDeliveryStream

Parameters:

props -

metricBackupToS3Bytes

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

metricBackupToS3Bytes in interface IDeliveryStream

metricBackupToS3DataFreshness

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

metricBackupToS3DataFreshness in interface IDeliveryStream

Parameters:

props -

metricBackupToS3DataFreshness

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

metricBackupToS3DataFreshness in interface IDeliveryStream

metricBackupToS3Records

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

metricBackupToS3Records in interface IDeliveryStream

Parameters:

props -

metricBackupToS3Records

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

metricBackupToS3Records in interface IDeliveryStream

metricIncomingBytes

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

metricIncomingBytes in interface IDeliveryStream

Parameters:

props -

metricIncomingBytes

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

metricIncomingBytes in interface IDeliveryStream

metricIncomingRecords

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

metricIncomingRecords in interface IDeliveryStream

Parameters:

props -

metricIncomingRecords

@Stability(value=Experimental)
 @NotNull
public 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.

Specified by:

metricIncomingRecords in interface IDeliveryStream

getConnections

@Stability(value=Experimental)
 @NotNull
public Connections getConnections()

(experimental) Network connections between Kinesis Data Firehose and other resources, i.e. Redshift cluster.

Specified by:

getConnections in interface IConnectable

getDeliveryStreamArn

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

(experimental) The ARN of the delivery stream.

Specified by:

getDeliveryStreamArn in interface IDeliveryStream

getDeliveryStreamName

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

(experimental) The name of the delivery stream.

Specified by:

getDeliveryStreamName in interface IDeliveryStream

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
public IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable