software.amazon.awscdk.services.kinesis

Interface IStream.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IStream, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IStream.Jsii$Proxy

Enclosing interface:

IStream

@Internal
public static interface IStream.Jsii$Default
extends IStream, IResource.Jsii$Default

Internal default implementation for IStream.

Nested Class Summary

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

IStream.Jsii$Default, IStream.Jsii$Proxy

Method Summary

Modifier and Type	Method and Description
default void	applyRemovalPolicy(RemovalPolicy policy) Apply the given removal policy to this resource.
default IKey	getEncryptionKey() Optional KMS encryption key associated with this stream.
default ResourceEnvironment	getEnv() The environment this resource belongs to.
default software.constructs.Node	getNode() The tree node.
default Stack	getStack() The stack in which this resource is defined.
default String	getStreamArn() The ARN of the stream.
default String	getStreamName() The name of the stream.
default Grant	grant(IGrantable grantee, String... actions) Grant the indicated permissions on this stream to the provided IAM principal.
default Grant	grantRead(IGrantable grantee) Grant read permissions for this stream and its contents to an IAM principal (Role/Group/User).
default Grant	grantReadWrite(IGrantable grantee) Grants read/write permissions for this stream and its contents to an IAM principal (Role/Group/User).
default Grant	grantWrite(IGrantable grantee) Grant write permissions for this stream and its contents to an IAM principal (Role/Group/User).
default Metric	metric(String metricName, MetricOptions props) Return stream metric based from its metric name.
default Metric	metricGetRecords(MetricOptions props) The number of records retrieved from the shard, measured over the specified time period.
default Metric	metricGetRecordsBytes(MetricOptions props) The number of bytes retrieved from the Kinesis stream, measured over the specified time period.
default 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.
default Metric	metricGetRecordsLatency(MetricOptions props) The time taken per GetRecords operation, measured over the specified time period.
default Metric	metricGetRecordsSuccess(MetricOptions props) The number of successful GetRecords operations per stream, measured over the specified time period.
default Metric	metricIncomingBytes(MetricOptions props) The number of bytes successfully put to the Kinesis stream over the specified time period.
default Metric	metricIncomingRecords(MetricOptions props) The number of records successfully put to the Kinesis stream over the specified time period.
default Metric	metricPutRecordBytes(MetricOptions props) The number of bytes put to the Kinesis stream using the PutRecord operation over the specified time period.
default Metric	metricPutRecordLatency(MetricOptions props) The time taken per PutRecord operation, measured over the specified time period.
default Metric	metricPutRecordsBytes(MetricOptions props) The number of bytes put to the Kinesis stream using the PutRecords operation over the specified time period.
default 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.
default Metric	metricPutRecordsLatency(MetricOptions props) The time taken per PutRecords operation, measured over the specified time period.
default Metric	metricPutRecordsSuccess(MetricOptions props) The number of PutRecords operations where at least one record succeeded, per Kinesis stream, measured over the specified time period.
default Metric	metricPutRecordsSuccessfulRecords(MetricOptions props) The number of successful records in a PutRecords operation per Kinesis data stream, measured over the specified time period.
default 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.
default Metric	metricPutRecordsTotalRecords(MetricOptions props) The total number of records sent in a PutRecords operation per Kinesis data stream, measured over the specified time period.
default Metric	metricPutRecordSuccess(MetricOptions props) The number of successful PutRecord operations per Kinesis stream, measured over the specified time period.
default Metric	metricReadProvisionedThroughputExceeded(MetricOptions props) The number of GetRecords calls throttled for the stream over the specified time period.
default 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.services.kinesis.IStream

metric, metricGetRecords, metricGetRecordsBytes, metricGetRecordsIteratorAgeMilliseconds, metricGetRecordsLatency, metricGetRecordsSuccess, metricIncomingBytes, metricIncomingRecords, metricPutRecordBytes, metricPutRecordLatency, metricPutRecordsBytes, metricPutRecordsFailedRecords, metricPutRecordsLatency, metricPutRecordsSuccess, metricPutRecordsSuccessfulRecords, metricPutRecordsThrottledRecords, metricPutRecordsTotalRecords, metricPutRecordSuccess, metricReadProvisionedThroughputExceeded, metricWriteProvisionedThroughputExceeded

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getNode

@Stability(value=Stable)
 @NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(value=Stable)
 @NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(value=Stable)
 @NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getStreamArn

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

The ARN of the stream.

Specified by:

getStreamArn in interface IStream

getStreamName

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

The name of the stream.

Specified by:

getStreamName in interface IStream

getEncryptionKey

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

Optional KMS encryption key associated with this stream.

Specified by:

getEncryptionKey in interface IStream

applyRemovalPolicy

@Stability(value=Stable)
default void applyRemovalPolicy(@NotNull
                                                         RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

grant

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

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

Specified by:

grant in interface IStream

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantRead

@Stability(value=Stable)
 @NotNull
default 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
default 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
default 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
default 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.

metricGetRecords

@Stability(value=Stable)
 @NotNull
default 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.

Specified by:

metricGetRecords in interface IStream

Parameters:

props - properties of the metric.

metricGetRecordsBytes

@Stability(value=Stable)
 @NotNull
default 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.

metricGetRecordsIteratorAgeMilliseconds

@Stability(value=Stable)
 @NotNull
default 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.

metricGetRecordsLatency

@Stability(value=Stable)
 @NotNull
default 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.

Specified by:

metricGetRecordsLatency in interface IStream

Parameters:

props - properties of the metric.

metricGetRecordsSuccess

@Stability(value=Stable)
 @NotNull
default 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.

metricIncomingBytes

@Stability(value=Stable)
 @NotNull
default 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.

metricIncomingRecords

@Stability(value=Stable)
 @NotNull
default 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.

metricPutRecordBytes

@Stability(value=Stable)
 @NotNull
default 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.

metricPutRecordLatency

@Stability(value=Stable)
 @NotNull
default 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.

metricPutRecordsBytes

@Stability(value=Stable)
 @NotNull
default 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.

metricPutRecordsFailedRecords

@Stability(value=Stable)
 @NotNull
default 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.

metricPutRecordsLatency

@Stability(value=Stable)
 @NotNull
default 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.

metricPutRecordsSuccess

@Stability(value=Stable)
 @NotNull
default 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.

metricPutRecordsSuccessfulRecords

@Stability(value=Stable)
 @NotNull
default 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.

metricPutRecordsThrottledRecords

@Stability(value=Stable)
 @NotNull
default 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.

metricPutRecordsTotalRecords

@Stability(value=Stable)
 @NotNull
default 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.

metricPutRecordSuccess

@Stability(value=Stable)
 @NotNull
default 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.

metricReadProvisionedThroughputExceeded

@Stability(value=Stable)
 @NotNull
default 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.

metricWriteProvisionedThroughputExceeded

@Stability(value=Stable)
 @NotNull
default 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.