software.amazon.awscdk.services.kinesis

Interface IStream

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IStream.Jsii$Default

All Known Implementing Classes:

IStream.Jsii$Proxy, Stream

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.189Z")
 @Stability(value=Stable)
public interface IStream
extends software.amazon.jsii.JsiiSerializable, IResource

A Kinesis Stream.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IStream.Jsii$Default Internal default implementation for IStream.
static class	IStream.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
default IKey	getEncryptionKey() Optional KMS encryption key associated with this stream.
String	getStreamArn() The ARN of the stream.
String	getStreamName() The name of the stream.
Grant	grant(IGrantable grantee, String... actions) Grant the indicated permissions on this stream to the provided IAM principal.
Grant	grantRead(IGrantable grantee) Grant read permissions for this stream and its contents to an IAM principal (Role/Group/User).
Grant	grantReadWrite(IGrantable grantee) Grants read/write permissions for this stream and its contents to an IAM principal (Role/Group/User).
Grant	grantWrite(IGrantable grantee) Grant write permissions for this stream and its contents to an IAM principal (Role/Group/User).
Metric	metric(String metricName) Return stream metric based from its metric name.
Metric	metric(String metricName, MetricOptions props) Return stream metric based from its metric name.
Metric	metricGetRecords() The number of records retrieved from the shard, measured over the specified time period.
Metric	metricGetRecords(MetricOptions props) The number of records retrieved from the shard, measured over the specified time period.
Metric	metricGetRecordsBytes() The number of bytes retrieved from the Kinesis stream, measured over the specified time period.
Metric	metricGetRecordsBytes(MetricOptions props) The number of bytes retrieved from the Kinesis stream, measured over the specified time period.
Metric	metricGetRecordsIteratorAgeMilliseconds() The age of the last record in all GetRecords calls made against a Kinesis stream, measured over the specified time period.
Metric	metricGetRecordsIteratorAgeMilliseconds(MetricOptions props) The age of the last record in all GetRecords calls made against a Kinesis stream, measured over the specified time period.
Metric	metricGetRecordsLatency() The time taken per GetRecords operation, measured over the specified time period.
Metric	metricGetRecordsLatency(MetricOptions props) The time taken per GetRecords operation, measured over the specified time period.
Metric	metricGetRecordsSuccess() The number of successful GetRecords operations per stream, measured over the specified time period.
Metric	metricGetRecordsSuccess(MetricOptions props) The number of successful GetRecords operations per stream, measured over the specified time period.
Metric	metricIncomingBytes() The number of bytes successfully put to the Kinesis stream over the specified time period.
Metric	metricIncomingBytes(MetricOptions props) The number of bytes successfully put to the Kinesis stream over the specified time period.
Metric	metricIncomingRecords() The number of records successfully put to the Kinesis stream over the specified time period.
Metric	metricIncomingRecords(MetricOptions props) The number of records successfully put to the Kinesis stream over the specified time period.
Metric	metricPutRecordBytes() The number of bytes put to the Kinesis stream using the PutRecord operation over the specified time period.
Metric	metricPutRecordBytes(MetricOptions props) The number of bytes put to the Kinesis stream using the PutRecord operation over the specified time period.
Metric	metricPutRecordLatency() The time taken per PutRecord operation, measured over the specified time period.
Metric	metricPutRecordLatency(MetricOptions props) The time taken per PutRecord operation, measured over the specified time period.
Metric	metricPutRecordsBytes() The number of bytes put to the Kinesis stream using the PutRecords operation over the specified time period.
Metric	metricPutRecordsBytes(MetricOptions props) The number of bytes put to the Kinesis stream using the PutRecords operation over the specified time period.
Metric	metricPutRecordsFailedRecords() The number of records rejected due to internal failures in a PutRecords operation per Kinesis data stream, measured over the specified time period.
Metric	metricPutRecordsFailedRecords(MetricOptions props) The number of records rejected due to internal failures in a PutRecords operation per Kinesis data stream, measured over the specified time period.
Metric	metricPutRecordsLatency() The time taken per PutRecords operation, measured over the specified time period.
Metric	metricPutRecordsLatency(MetricOptions props) The time taken per PutRecords operation, measured over the specified time period.
Metric	metricPutRecordsSuccess() The number of PutRecords operations where at least one record succeeded, per Kinesis stream, measured over the specified time period.
Metric	metricPutRecordsSuccess(MetricOptions props) The number of PutRecords operations where at least one record succeeded, per Kinesis stream, measured over the specified time period.
Metric	metricPutRecordsSuccessfulRecords() The number of successful records in a PutRecords operation per Kinesis data stream, measured over the specified time period.
Metric	metricPutRecordsSuccessfulRecords(MetricOptions props) The number of successful records in a PutRecords operation per Kinesis data stream, measured over the specified time period.
Metric	metricPutRecordsThrottledRecords() The number of records rejected due to throttling in a PutRecords operation per Kinesis data stream, measured over the specified time period.
Metric	metricPutRecordsThrottledRecords(MetricOptions props) The number of records rejected due to throttling in a PutRecords operation per Kinesis data stream, measured over the specified time period.
Metric	metricPutRecordsTotalRecords() The total number of records sent in a PutRecords operation per Kinesis data stream, measured over the specified time period.
Metric	metricPutRecordsTotalRecords(MetricOptions props) The total number of records sent in a PutRecords operation per Kinesis data stream, measured over the specified time period.
Metric	metricPutRecordSuccess() The number of successful PutRecord operations per Kinesis stream, measured over the specified time period.
Metric	metricPutRecordSuccess(MetricOptions props) The number of successful PutRecord operations per Kinesis stream, measured over the specified time period.
Metric	metricReadProvisionedThroughputExceeded() The number of GetRecords calls throttled for the stream over the specified time period.
Metric	metricReadProvisionedThroughputExceeded(MetricOptions props) The number of GetRecords calls throttled for the stream over the specified time period.
Metric	metricWriteProvisionedThroughputExceeded() The number of records rejected due to throttling for the stream over the specified time period.
Metric	metricWriteProvisionedThroughputExceeded(MetricOptions props) The number of records rejected due to throttling for the stream over the specified time period.

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getStreamArn

@Stability(value=Stable)
 @NotNull
String getStreamArn()

The ARN of the stream.

getStreamName

@Stability(value=Stable)
 @NotNull
String getStreamName()

The name of the stream.

getEncryptionKey

@Stability(value=Stable)
 @Nullable
default IKey getEncryptionKey()

Optional KMS encryption key associated with this stream.

grant

@Stability(value=Stable)
 @NotNull
Grant grant(@NotNull
                                               IGrantable grantee,
                                               @NotNull
                                               String... actions)

Grant the indicated permissions on this stream to the provided IAM principal.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(value=Stable)
 @NotNull
Grant grantRead(@NotNull
                                                   IGrantable grantee)

Grant read permissions for this stream and its contents to an IAM principal (Role/Group/User).

If an encryption key is used, permission to ues the key to decrypt the contents of the stream will also be granted.

Parameters:

grantee - This parameter is required.

grantReadWrite

@Stability(value=Stable)
 @NotNull
Grant grantReadWrite(@NotNull
                                                        IGrantable grantee)

Grants read/write permissions for this stream and its contents to an IAM principal (Role/Group/User).

If an encryption key is used, permission to use the key for encrypt/decrypt will also be granted.

Parameters:

grantee - This parameter is required.

grantWrite

@Stability(value=Stable)
 @NotNull
Grant grantWrite(@NotNull
                                                    IGrantable grantee)

Grant write permissions for this stream and its contents to an IAM principal (Role/Group/User).

If an encryption key is used, permission to ues the key to encrypt the contents of the stream will also be granted.

Parameters:

grantee - This parameter is required.

metric

@Stability(value=Stable)
 @NotNull
Metric metric(@NotNull
                                                 String metricName,
                                                 @Nullable
                                                 MetricOptions props)

Return stream metric based from its metric name.

Parameters:

metricName - name of the stream metric. This parameter is required.

props - properties of the metric.

metric

@Stability(value=Stable)
 @NotNull
Metric metric(@NotNull
                                                 String metricName)

Return stream metric based from its metric name.

Parameters:

metricName - name of the stream metric. This parameter is required.

metricGetRecords

@Stability(value=Stable)
 @NotNull
Metric metricGetRecords(@Nullable
                                                           MetricOptions props)

The number of records retrieved from the shard, measured over the specified time period.

Minimum, Maximum, and Average statistics represent the records in a single GetRecords operation for the stream in the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricGetRecords

@Stability(value=Stable)
 @NotNull
Metric metricGetRecords()

The number of records retrieved from the shard, measured over the specified time period.

Minimum, Maximum, and Average statistics represent the records in a single GetRecords operation for the stream in the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricGetRecordsBytes

@Stability(value=Stable)
 @NotNull
Metric metricGetRecordsBytes(@Nullable
                                                                MetricOptions props)

The number of bytes retrieved from the Kinesis stream, measured over the specified time period.

Minimum, Maximum, and Average statistics represent the bytes in a single GetRecords operation for the stream in the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricGetRecordsBytes

@Stability(value=Stable)
 @NotNull
Metric metricGetRecordsBytes()

The number of bytes retrieved from the Kinesis stream, measured over the specified time period.

Minimum, Maximum, and Average statistics represent the bytes in a single GetRecords operation for the stream in the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricGetRecordsIteratorAgeMilliseconds

@Stability(value=Stable)
 @NotNull
Metric metricGetRecordsIteratorAgeMilliseconds(@Nullable
                                                                                  MetricOptions props)

The age of the last record in all GetRecords calls made against a Kinesis stream, measured over the specified time period.

Age is the difference between the current time and when the last record of the GetRecords call was written to the stream. The Minimum and Maximum statistics can be used to track the progress of Kinesis consumer applications. A value of zero indicates that the records being read are completely caught up with the stream.

The metric defaults to maximum over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricGetRecordsIteratorAgeMilliseconds

@Stability(value=Stable)
 @NotNull
Metric metricGetRecordsIteratorAgeMilliseconds()

The age of the last record in all GetRecords calls made against a Kinesis stream, measured over the specified time period.

Age is the difference between the current time and when the last record of the GetRecords call was written to the stream. The Minimum and Maximum statistics can be used to track the progress of Kinesis consumer applications. A value of zero indicates that the records being read are completely caught up with the stream.

The metric defaults to maximum over 5 minutes, it can be changed by passing statistic and period properties.

metricGetRecordsLatency

@Stability(value=Stable)
 @NotNull
Metric metricGetRecordsLatency(@Nullable
                                                                  MetricOptions props)

The time taken per GetRecords operation, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricGetRecordsLatency

@Stability(value=Stable)
 @NotNull
Metric metricGetRecordsLatency()

The time taken per GetRecords operation, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricGetRecordsSuccess

@Stability(value=Stable)
 @NotNull
Metric metricGetRecordsSuccess(@Nullable
                                                                  MetricOptions props)

The number of successful GetRecords operations per stream, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricGetRecordsSuccess

@Stability(value=Stable)
 @NotNull
Metric metricGetRecordsSuccess()

The number of successful GetRecords operations per stream, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricIncomingBytes

@Stability(value=Stable)
 @NotNull
Metric metricIncomingBytes(@Nullable
                                                              MetricOptions props)

The number of bytes successfully put to the Kinesis stream over the specified time period.

This metric includes bytes from PutRecord and PutRecords operations. Minimum, Maximum, and Average statistics represent the bytes in a single put operation for the stream in the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricIncomingBytes

@Stability(value=Stable)
 @NotNull
Metric metricIncomingBytes()

The number of bytes successfully put to the Kinesis stream over the specified time period.

This metric includes bytes from PutRecord and PutRecords operations. Minimum, Maximum, and Average statistics represent the bytes in a single put operation for the stream in the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricIncomingRecords

@Stability(value=Stable)
 @NotNull
Metric metricIncomingRecords(@Nullable
                                                                MetricOptions props)

The number of records successfully put to the Kinesis stream over the specified time period.

This metric includes record counts from PutRecord and PutRecords operations. Minimum, Maximum, and Average statistics represent the records in a single put operation for the stream in the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricIncomingRecords

@Stability(value=Stable)
 @NotNull
Metric metricIncomingRecords()

The number of records successfully put to the Kinesis stream over the specified time period.

This metric includes record counts from PutRecord and PutRecords operations. Minimum, Maximum, and Average statistics represent the records in a single put operation for the stream in the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricPutRecordBytes

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordBytes(@Nullable
                                                               MetricOptions props)

The number of bytes put to the Kinesis stream using the PutRecord operation over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricPutRecordBytes

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordBytes()

The number of bytes put to the Kinesis stream using the PutRecord operation over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricPutRecordLatency

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordLatency(@Nullable
                                                                 MetricOptions props)

The time taken per PutRecord operation, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricPutRecordLatency

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordLatency()

The time taken per PutRecord operation, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricPutRecordsBytes

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsBytes(@Nullable
                                                                MetricOptions props)

The number of bytes put to the Kinesis stream using the PutRecords operation over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricPutRecordsBytes

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsBytes()

The number of bytes put to the Kinesis stream using the PutRecords operation over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricPutRecordsFailedRecords

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsFailedRecords(@Nullable
                                                                        MetricOptions props)

The number of records rejected due to internal failures in a PutRecords operation per Kinesis data stream, measured over the specified time period.

Occasional internal failures are to be expected and should be retried.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricPutRecordsFailedRecords

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsFailedRecords()

The number of records rejected due to internal failures in a PutRecords operation per Kinesis data stream, measured over the specified time period.

Occasional internal failures are to be expected and should be retried.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricPutRecordsLatency

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsLatency(@Nullable
                                                                  MetricOptions props)

The time taken per PutRecords operation, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricPutRecordsLatency

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsLatency()

The time taken per PutRecords operation, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricPutRecordsSuccess

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsSuccess(@Nullable
                                                                  MetricOptions props)

The number of PutRecords operations where at least one record succeeded, per Kinesis stream, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricPutRecordsSuccess

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsSuccess()

The number of PutRecords operations where at least one record succeeded, per Kinesis stream, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricPutRecordsSuccessfulRecords

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsSuccessfulRecords(@Nullable
                                                                            MetricOptions props)

The number of successful records in a PutRecords operation per Kinesis data stream, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricPutRecordsSuccessfulRecords

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsSuccessfulRecords()

The number of successful records in a PutRecords operation per Kinesis data stream, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricPutRecordsThrottledRecords

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsThrottledRecords(@Nullable
                                                                           MetricOptions props)

The number of records rejected due to throttling in a PutRecords operation per Kinesis data stream, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricPutRecordsThrottledRecords

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsThrottledRecords()

The number of records rejected due to throttling in a PutRecords operation per Kinesis data stream, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricPutRecordsTotalRecords

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsTotalRecords(@Nullable
                                                                       MetricOptions props)

The total number of records sent in a PutRecords operation per Kinesis data stream, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricPutRecordsTotalRecords

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordsTotalRecords()

The total number of records sent in a PutRecords operation per Kinesis data stream, measured over the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricPutRecordSuccess

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordSuccess(@Nullable
                                                                 MetricOptions props)

The number of successful PutRecord operations per Kinesis stream, measured over the specified time period.

Average reflects the percentage of successful writes to a stream.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricPutRecordSuccess

@Stability(value=Stable)
 @NotNull
Metric metricPutRecordSuccess()

The number of successful PutRecord operations per Kinesis stream, measured over the specified time period.

Average reflects the percentage of successful writes to a stream.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

metricReadProvisionedThroughputExceeded

@Stability(value=Stable)
 @NotNull
Metric metricReadProvisionedThroughputExceeded(@Nullable
                                                                                  MetricOptions props)

The number of GetRecords calls throttled for the stream over the specified time period.

The most commonly used statistic for this metric is Average.

When the Minimum statistic has a value of 1, all records were throttled for the stream during the specified time period.

When the Maximum statistic has a value of 0 (zero), no records were throttled for the stream during the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties

Parameters:

props - properties of the metric.

metricReadProvisionedThroughputExceeded

@Stability(value=Stable)
 @NotNull
Metric metricReadProvisionedThroughputExceeded()

The number of GetRecords calls throttled for the stream over the specified time period.

The most commonly used statistic for this metric is Average.

When the Minimum statistic has a value of 1, all records were throttled for the stream during the specified time period.

When the Maximum statistic has a value of 0 (zero), no records were throttled for the stream during the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties

metricWriteProvisionedThroughputExceeded

@Stability(value=Stable)
 @NotNull
Metric metricWriteProvisionedThroughputExceeded(@Nullable
                                                                                   MetricOptions props)

The number of records rejected due to throttling for the stream over the specified time period.

This metric includes throttling from PutRecord and PutRecords operations.

When the Minimum statistic has a non-zero value, records were being throttled for the stream during the specified time period.

When the Maximum statistic has a value of 0 (zero), no records were being throttled for the stream during the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.

Parameters:

props - properties of the metric.

metricWriteProvisionedThroughputExceeded

@Stability(value=Stable)
 @NotNull
Metric metricWriteProvisionedThroughputExceeded()

The number of records rejected due to throttling for the stream over the specified time period.

This metric includes throttling from PutRecord and PutRecords operations.

When the Minimum statistic has a non-zero value, records were being throttled for the stream during the specified time period.

When the Maximum statistic has a value of 0 (zero), no records were being throttled for the stream during the specified time period.

The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.