Interface IDeliveryStream
- All Superinterfaces:
IConnectable
,software.constructs.IConstruct
,software.constructs.IDependable
,IGrantable
,IResource
,software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
IDeliveryStream.Jsii$Default
- All Known Implementing Classes:
DeliveryStream
,IDeliveryStream.Jsii$Proxy
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Internal default implementation forIDeliveryStream
.static final class
A proxy class which represents a concrete javascript instance of this type. -
Method Summary
Modifier and TypeMethodDescription(experimental) The ARN of the delivery stream.(experimental) The name of the delivery stream.grant
(IGrantable grantee, @NotNull String... actions) (experimental) Grant thegrantee
identity permissions to performactions
.grantPutRecords
(IGrantable grantee) (experimental) Grant thegrantee
identity permissions to performfirehose:PutRecord
andfirehose:PutRecordBatch
actions on this delivery stream.(experimental) Return the given named metric for this delivery stream.metric
(String metricName, MetricOptions props) (experimental) Return the given named metric for this delivery stream.(experimental) Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.(experimental) Metric for the number of bytes delivered to Amazon S3 for backup over the specified time period.(experimental) Metric for the age (from getting into Kinesis Data Firehose to now) of the oldest record in Kinesis Data Firehose.(experimental) Metric for the age (from getting into Kinesis Data Firehose to now) of the oldest record in Kinesis Data Firehose.(experimental) Metric for the number of records delivered to Amazon S3 for backup over the specified time period.(experimental) Metric for the number of records delivered to Amazon S3 for backup over the specified time period.(experimental) Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.metricIncomingBytes
(MetricOptions props) (experimental) Metric for the number of bytes ingested successfully into the delivery stream over the specified time period after throttling.(experimental) Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling.(experimental) Metric for the number of records ingested successfully into the delivery stream over the specified time period after throttling.Methods inherited from interface software.amazon.awscdk.services.ec2.IConnectable
getConnections
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable
getGrantPrincipal
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDeliveryStreamArn
(experimental) The ARN of the delivery stream. -
getDeliveryStreamName
(experimental) The name of the delivery stream. -
grant
@Stability(Experimental) @NotNull Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) (experimental) Grant thegrantee
identity permissions to performactions
.- Parameters:
grantee
- This parameter is required.actions
- This parameter is required.
-
grantPutRecords
(experimental) Grant thegrantee
identity permissions to performfirehose:PutRecord
andfirehose:PutRecordBatch
actions on this delivery stream.- Parameters:
grantee
- This parameter is required.
-
metric
@Stability(Experimental) @NotNull Metric metric(@NotNull String metricName, @Nullable MetricOptions props) (experimental) Return the given named metric for this delivery stream.- Parameters:
metricName
- This parameter is required.props
-
-
metric
(experimental) Return the given named metric for this delivery stream.- Parameters:
metricName
- This parameter is required.
-
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.
- Parameters:
props
-
-
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.
-
metricBackupToS3DataFreshness
@Stability(Experimental) @NotNull 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.
- Parameters:
props
-
-
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.
-
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.
- Parameters:
props
-
-
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.
-
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.
- Parameters:
props
-
-
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.
-
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.
- Parameters:
props
-
-
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.
-