Class DeliveryStream
- All Implemented Interfaces:
IResource
,IConnectable
,IGrantable
,IDeliveryStream
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
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_LATEST) .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") .destination(s3Destination) .build();
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kinesisfirehose.alpha.IDeliveryStream
IDeliveryStream.Jsii$Default, IDeliveryStream.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DeliveryStream
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated.protected
DeliveryStream
(software.amazon.jsii.JsiiObjectRef objRef) Deprecated.DeliveryStream
(software.constructs.Construct scope, String id, DeliveryStreamProps props) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionstatic IDeliveryStream
fromDeliveryStreamArn
(software.constructs.Construct scope, String id, String deliveryStreamArn) Deprecated.static IDeliveryStream
fromDeliveryStreamAttributes
(software.constructs.Construct scope, String id, DeliveryStreamAttributes attrs) Deprecated.static IDeliveryStream
fromDeliveryStreamName
(software.constructs.Construct scope, String id, String deliveryStreamName) Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.grant
(IGrantable grantee, @NotNull String... actions) Deprecated.grantPutRecords
(IGrantable grantee) Deprecated.Deprecated.metric
(String metricName, MetricOptions props) Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.metricIncomingBytes
(MetricOptions props) Deprecated.Deprecated.Deprecated.Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, 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.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
DeliveryStream
protected DeliveryStream(software.amazon.jsii.JsiiObjectRef objRef) Deprecated. -
DeliveryStream
protected DeliveryStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated. -
DeliveryStream
@Stability(Deprecated) @Deprecated public DeliveryStream(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DeliveryStreamProps props) Deprecated.- Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
fromDeliveryStreamArn
@Stability(Deprecated) @Deprecated @NotNull public static IDeliveryStream fromDeliveryStreamArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String deliveryStreamArn) Deprecated.(deprecated) 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(Deprecated) @Deprecated @NotNull public static IDeliveryStream fromDeliveryStreamAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull DeliveryStreamAttributes attrs) Deprecated.(deprecated) 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(Deprecated) @Deprecated @NotNull public static IDeliveryStream fromDeliveryStreamName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String deliveryStreamName) Deprecated.(deprecated) 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(Deprecated) @Deprecated @NotNull public Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) Deprecated.(deprecated) Grant thegrantee
identity permissions to performactions
.- Specified by:
grant
in interfaceIDeliveryStream
- Parameters:
grantee
- This parameter is required.actions
- This parameter is required.
-
grantPutRecords
@Stability(Deprecated) @Deprecated @NotNull public Grant grantPutRecords(@NotNull IGrantable grantee) Deprecated.(deprecated) Grant thegrantee
identity permissions to performfirehose:PutRecord
andfirehose:PutRecordBatch
actions on this delivery stream.- Specified by:
grantPutRecords
in interfaceIDeliveryStream
- Parameters:
grantee
- This parameter is required.
-
metric
@Stability(Deprecated) @Deprecated @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Deprecated.(deprecated) Return the given named metric for this delivery stream.- Specified by:
metric
in interfaceIDeliveryStream
- Parameters:
metricName
- This parameter is required.props
-
-
metric
Deprecated.(deprecated) Return the given named metric for this delivery stream.- Specified by:
metric
in interfaceIDeliveryStream
- Parameters:
metricName
- This parameter is required.
-
metricBackupToS3Bytes
@Stability(Deprecated) @Deprecated @NotNull public Metric metricBackupToS3Bytes(@Nullable MetricOptions props) Deprecated.(deprecated) 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 interfaceIDeliveryStream
- Parameters:
props
-
-
metricBackupToS3Bytes
Deprecated.(deprecated) 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 interfaceIDeliveryStream
-
metricBackupToS3DataFreshness
@Stability(Deprecated) @Deprecated @NotNull public Metric metricBackupToS3DataFreshness(@Nullable MetricOptions props) Deprecated.(deprecated) 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 interfaceIDeliveryStream
- Parameters:
props
-
-
metricBackupToS3DataFreshness
Deprecated.(deprecated) 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 interfaceIDeliveryStream
-
metricBackupToS3Records
@Stability(Deprecated) @Deprecated @NotNull public Metric metricBackupToS3Records(@Nullable MetricOptions props) Deprecated.(deprecated) 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 interfaceIDeliveryStream
- Parameters:
props
-
-
metricBackupToS3Records
Deprecated.(deprecated) 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 interfaceIDeliveryStream
-
metricIncomingBytes
@Stability(Deprecated) @Deprecated @NotNull public Metric metricIncomingBytes(@Nullable MetricOptions props) Deprecated.(deprecated) 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 interfaceIDeliveryStream
- Parameters:
props
-
-
metricIncomingBytes
Deprecated.(deprecated) 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 interfaceIDeliveryStream
-
metricIncomingRecords
@Stability(Deprecated) @Deprecated @NotNull public Metric metricIncomingRecords(@Nullable MetricOptions props) Deprecated.(deprecated) 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 interfaceIDeliveryStream
- Parameters:
props
-
-
metricIncomingRecords
Deprecated.(deprecated) 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 interfaceIDeliveryStream
-
getConnections
Deprecated.(deprecated) Network connections between Kinesis Data Firehose and other resources, i.e. Redshift cluster.- Specified by:
getConnections
in interfaceIConnectable
-
getDeliveryStreamArn
Deprecated.(deprecated) The ARN of the delivery stream.- Specified by:
getDeliveryStreamArn
in interfaceIDeliveryStream
-
getDeliveryStreamName
Deprecated.(deprecated) The name of the delivery stream.- Specified by:
getDeliveryStreamName
in interfaceIDeliveryStream
-
getGrantPrincipal
Deprecated.(deprecated) The principal to grant permissions to.- Specified by:
getGrantPrincipal
in interfaceIGrantable
-