Stream (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.Resource
    - - software.amazon.awscdk.services.kinesis.Stream

All Implemented Interfaces:: IResource, IStream, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.193Z")
 @Stability(value=Stable)
public class Stream
extends Resource
implements IStream

A Kinesis stream.

Can be encrypted with a KMS key.

Example:

 Key key = new Key(this, "MyKey");
 Stream.Builder.create(this, "MyEncryptedStream")
         .encryption(StreamEncryption.KMS)
         .encryptionKey(key)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Stream.Builder
A fluent builder for Stream.
- 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.kinesis.IStream
  IStream.Jsii$Default, IStream.Jsii$Proxy

Nested Classes
Modifier and Type	Class and Description
`static class`	`Stream.Builder` A fluent builder for `Stream`.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Stream(software.constructs.Construct scope, String id)`
	`Stream(software.constructs.Construct scope, String id, StreamProps props)`
`protected`	`Stream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`Stream(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static IStream`	`fromStreamArn(software.constructs.Construct scope, String id, String streamArn)` Import an existing Kinesis Stream provided an ARN.
`static IStream`	`fromStreamAttributes(software.constructs.Construct scope, String id, StreamAttributes attrs)` Creates a Stream construct that represents an external stream.
`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 given IAM principal (Role/Group/User).
`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 number of successful GetRecords operations per stream, measured over the specified time period.
`Metric`	`metricGetRecordsLatency(MetricOptions props)` The number of successful GetRecords operations per stream, 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 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.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct
getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Constructor Detail
  - Stream
```
protected Stream(software.amazon.jsii.JsiiObjectRef objRef)
```
  - Stream
```
protected Stream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - Stream
```
@Stability(value=Stable)
public Stream(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id,
                                       @Nullable
                                       StreamProps props)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props -
  - Stream
```
@Stability(value=Stable)
public Stream(@NotNull
                                       software.constructs.Construct scope,
                                       @NotNull
                                       String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
- Method Detail
  - fromStreamArn
```
@Stability(value=Stable)
 @NotNull
public static IStream fromStreamArn(@NotNull
                                                                       software.constructs.Construct scope,
                                                                       @NotNull
                                                                       String id,
                                                                       @NotNull
                                                                       String streamArn)
```
    Import an existing Kinesis Stream provided an ARN.
    
    Parameters:
    
    scope - The parent creating construct (usually `this`). This parameter is required.
    
    id - The construct's name. This parameter is required.
    
    streamArn - Stream ARN (i.e. arn:aws:kinesis:::stream/Foo). This parameter is required.
  - fromStreamAttributes
```
@Stability(value=Stable)
 @NotNull
public static IStream fromStreamAttributes(@NotNull
                                                                              software.constructs.Construct scope,
                                                                              @NotNull
                                                                              String id,
                                                                              @NotNull
                                                                              StreamAttributes attrs)
```
    Creates a Stream construct that represents an external stream.
    
    Parameters:
    
    scope - The parent creating construct (usually `this`). This parameter is required.
    
    id - The construct's name. This parameter is required.
    
    attrs - Stream import properties. This parameter is required.
  - grant
```
@Stability(value=Stable)
 @NotNull
public Grant grant(@NotNull
                                                      IGrantable grantee,
                                                      @NotNull
                                                      String... actions)
```
    Grant the indicated permissions on this stream to the given IAM principal (Role/Group/User).
    
    Specified by:
    
    grant in interface IStream
    
    Parameters:
    
    grantee - This parameter is required.
    
    actions - This parameter is required.
  - grantRead
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    grantRead in interface IStream
    
    Parameters:
    
    grantee - This parameter is required.
  - grantReadWrite
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    grantReadWrite in interface IStream
    
    Parameters:
    
    grantee - This parameter is required.
  - grantWrite
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    grantWrite in interface IStream
    
    Parameters:
    
    grantee - This parameter is required.
  - metric
```
@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName,
                                                        @Nullable
                                                        MetricOptions props)
```
    Return stream metric based from its metric name.
    
    Specified by:
    
    metric in interface IStream
    
    Parameters:
    
    metricName - name of the stream metric. This parameter is required.
    
    props - properties of the metric.
  - metric
```
@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName)
```
    Return stream metric based from its metric name.
    
    Specified by:
    
    metric in interface IStream
    
    Parameters:
    
    metricName - name of the stream metric. This parameter is required.
  - metricGetRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    average The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.
    
    Specified by:
    
    metricGetRecords in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricGetRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    average The metric defaults to average over 5 minutes, it can be changed by passing statistic and period properties.
    
    Specified by:
    
    metricGetRecords in interface IStream
  - metricGetRecordsBytes
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricGetRecordsBytes in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricGetRecordsBytes
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricGetRecordsBytes in interface IStream
  - metricGetRecordsIteratorAgeMilliseconds
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricGetRecordsIteratorAgeMilliseconds in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricGetRecordsIteratorAgeMilliseconds
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricGetRecordsIteratorAgeMilliseconds in interface IStream
  - metricGetRecordsLatency
```
@Stability(value=Stable)
 @NotNull
public Metric metricGetRecordsLatency(@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.
    
    Specified by:
    
    metricGetRecordsLatency in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricGetRecordsLatency
```
@Stability(value=Stable)
 @NotNull
public Metric metricGetRecordsLatency()
```
    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.
    
    Specified by:
    
    metricGetRecordsLatency in interface IStream
  - metricGetRecordsSuccess
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricGetRecordsSuccess in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricGetRecordsSuccess
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricGetRecordsSuccess in interface IStream
  - metricIncomingBytes
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricIncomingBytes in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricIncomingBytes
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricIncomingBytes in interface IStream
  - metricIncomingRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricIncomingRecords in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricIncomingRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricIncomingRecords in interface IStream
  - metricPutRecordBytes
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordBytes in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricPutRecordBytes
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordBytes in interface IStream
  - metricPutRecordLatency
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordLatency in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricPutRecordLatency
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordLatency in interface IStream
  - metricPutRecordsBytes
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsBytes in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricPutRecordsBytes
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsBytes in interface IStream
  - metricPutRecordsFailedRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsFailedRecords in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricPutRecordsFailedRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsFailedRecords in interface IStream
  - metricPutRecordsLatency
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsLatency in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricPutRecordsLatency
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsLatency in interface IStream
  - metricPutRecordsSuccess
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsSuccess in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricPutRecordsSuccess
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsSuccess in interface IStream
  - metricPutRecordsSuccessfulRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsSuccessfulRecords in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricPutRecordsSuccessfulRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsSuccessfulRecords in interface IStream
  - metricPutRecordsThrottledRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsThrottledRecords in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricPutRecordsThrottledRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsThrottledRecords in interface IStream
  - metricPutRecordsTotalRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsTotalRecords in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricPutRecordsTotalRecords
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordsTotalRecords in interface IStream
  - metricPutRecordSuccess
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordSuccess in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricPutRecordSuccess
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricPutRecordSuccess in interface IStream
  - metricReadProvisionedThroughputExceeded
```
@Stability(value=Stable)
 @NotNull
public 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
    
    Specified by:
    
    metricReadProvisionedThroughputExceeded in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricReadProvisionedThroughputExceeded
```
@Stability(value=Stable)
 @NotNull
public 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
    
    Specified by:
    
    metricReadProvisionedThroughputExceeded in interface IStream
  - metricWriteProvisionedThroughputExceeded
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricWriteProvisionedThroughputExceeded in interface IStream
    
    Parameters:
    
    props - properties of the metric.
  - metricWriteProvisionedThroughputExceeded
```
@Stability(value=Stable)
 @NotNull
public 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.
    
    Specified by:
    
    metricWriteProvisionedThroughputExceeded in interface IStream
  - getStreamArn
```
@Stability(value=Stable)
 @NotNull
public String getStreamArn()
```
    The ARN of the stream.
    
    Specified by:
    
    getStreamArn in interface IStream
  - getStreamName
```
@Stability(value=Stable)
 @NotNull
public String getStreamName()
```
    The name of the stream.
    
    Specified by:
    
    getStreamName in interface IStream
  - getEncryptionKey
```
@Stability(value=Stable)
 @Nullable
public IKey getEncryptionKey()
```
    Optional KMS encryption key associated with this stream.
    
    Specified by:
    
    getEncryptionKey in interface IStream

Class Stream

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kinesis.IStream

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.Resource

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.IResource

Methods inherited from interface software.constructs.IConstruct

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Constructor Detail

Stream

Stream

Stream

Stream

Method Detail

fromStreamArn

fromStreamAttributes

grant

grantRead

grantReadWrite

grantWrite

metric

metric

metricGetRecords

metricGetRecords

metricGetRecordsBytes

metricGetRecordsBytes

metricGetRecordsIteratorAgeMilliseconds

metricGetRecordsIteratorAgeMilliseconds

metricGetRecordsLatency

metricGetRecordsLatency

metricGetRecordsSuccess

metricGetRecordsSuccess

metricIncomingBytes

metricIncomingBytes

metricIncomingRecords

metricIncomingRecords

metricPutRecordBytes

metricPutRecordBytes

metricPutRecordLatency

metricPutRecordLatency

metricPutRecordsBytes

metricPutRecordsBytes

metricPutRecordsFailedRecords

metricPutRecordsFailedRecords

metricPutRecordsLatency

metricPutRecordsLatency

metricPutRecordsSuccess

metricPutRecordsSuccess

metricPutRecordsSuccessfulRecords

metricPutRecordsSuccessfulRecords

metricPutRecordsThrottledRecords

metricPutRecordsThrottledRecords

metricPutRecordsTotalRecords

metricPutRecordsTotalRecords

metricPutRecordSuccess

metricPutRecordSuccess

metricReadProvisionedThroughputExceeded

metricReadProvisionedThroughputExceeded

metricWriteProvisionedThroughputExceeded

metricWriteProvisionedThroughputExceeded

getStreamArn

getStreamName

getEncryptionKey