software.amazon.awscdk.services.kinesisfirehose

Class DeliveryStream

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.kinesisfirehose.DeliveryStream

All Implemented Interfaces:

IConstruct, IDependable, IResource, IConnectable, IGrantable, IDeliveryStream

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:16.086Z")
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 interface software.amazon.awscdk.services.kinesisfirehose.IDeliveryStream

IDeliveryStream.Jsii$Default, IDeliveryStream.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static IDeliveryStream	fromDeliveryStreamArn(software.constructs.Construct scope, java.lang.String id, java.lang.String deliveryStreamArn) (experimental) Import an existing delivery stream from its ARN.
static IDeliveryStream	fromDeliveryStreamAttributes(software.constructs.Construct scope, java.lang.String id, DeliveryStreamAttributes attrs) (experimental) Import an existing delivery stream from its attributes.
static IDeliveryStream	fromDeliveryStreamName(software.constructs.Construct scope, java.lang.String id, java.lang.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.
java.lang.String	getDeliveryStreamArn() (experimental) The ARN of the delivery stream.
java.lang.String	getDeliveryStreamName() (experimental) The name of the delivery stream.
IPrincipal	getGrantPrincipal() (experimental) The principal to grant permissions to.
Grant	grant(IGrantable grantee, java.lang.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(java.lang.String metricName) (experimental) Return the given named metric for this delivery stream.
Metric	metric(java.lang.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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

Constructor Detail

DeliveryStream

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

DeliveryStream

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

DeliveryStream

public DeliveryStream(software.constructs.Construct scope,
                      java.lang.String id,
                      DeliveryStreamProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromDeliveryStreamArn

public static IDeliveryStream fromDeliveryStreamArn(software.constructs.Construct scope,
                                                    java.lang.String id,
                                                    java.lang.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

public static IDeliveryStream fromDeliveryStreamAttributes(software.constructs.Construct scope,
                                                           java.lang.String id,
                                                           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

public static IDeliveryStream fromDeliveryStreamName(software.constructs.Construct scope,
                                                     java.lang.String id,
                                                     java.lang.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

public Grant grant(IGrantable grantee,
                   java.lang.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

public Grant grantPutRecords(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

public Metric metric(java.lang.String metricName,
                     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

public Metric metric(java.lang.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

public Metric metricBackupToS3Bytes(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

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

public 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.

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

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

public Metric metricBackupToS3Records(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

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

public Metric metricIncomingBytes(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

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

public Metric metricIncomingRecords(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

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

public Connections getConnections()

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

Specified by:

getConnections in interface IConnectable

getDeliveryStreamArn

public java.lang.String getDeliveryStreamArn()

(experimental) The ARN of the delivery stream.

Specified by:

getDeliveryStreamArn in interface IDeliveryStream

getDeliveryStreamName

public java.lang.String getDeliveryStreamName()

(experimental) The name of the delivery stream.

Specified by:

getDeliveryStreamName in interface IDeliveryStream

getGrantPrincipal

public IPrincipal getGrantPrincipal()

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable