Class IStream.Jsii$Proxy
- All Implemented Interfaces:
IResource
,IResource.Jsii$Default
,IStream
,IStream.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
IStream
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kinesis.IStream
IStream.Jsii$Default, IStream.Jsii$Proxy
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.final IKey
Optional KMS encryption key associated with this stream.final ResourceEnvironment
getEnv()
The environment this resource belongs to.final software.constructs.Node
getNode()
The tree node.final Stack
getStack()
The stack in which this resource is defined.final String
The ARN of the stream.final String
The name of the stream.final Grant
grant
(IGrantable grantee, @NotNull String... actions) Grant the indicated permissions on this stream to the provided IAM principal.final Grant
grantRead
(IGrantable grantee) Grant read permissions for this stream and its contents to an IAM principal (Role/Group/User).final Grant
grantReadWrite
(IGrantable grantee) Grants read/write permissions for this stream and its contents to an IAM principal (Role/Group/User).final Grant
grantWrite
(IGrantable grantee) Grant write permissions for this stream and its contents to an IAM principal (Role/Group/User).final Metric
Return stream metric based from its metric name.final Metric
metric
(String metricName, MetricOptions props) Return stream metric based from its metric name.final Metric
The number of records retrieved from the shard, measured over the specified time period.final Metric
metricGetRecords
(MetricOptions props) The number of records retrieved from the shard, measured over the specified time period.final Metric
The number of bytes retrieved from the Kinesis stream, measured over the specified time period.final Metric
The number of bytes retrieved from the Kinesis stream, measured over the specified time period.final Metric
The age of the last record in all GetRecords calls made against a Kinesis stream, measured over the specified time period.final Metric
The age of the last record in all GetRecords calls made against a Kinesis stream, measured over the specified time period.final Metric
The time taken per GetRecords operation, measured over the specified time period.final Metric
The time taken per GetRecords operation, measured over the specified time period.final Metric
The number of successful GetRecords operations per stream, measured over the specified time period.final Metric
The number of successful GetRecords operations per stream, measured over the specified time period.final Metric
The number of bytes successfully put to the Kinesis stream over the specified time period.final Metric
metricIncomingBytes
(MetricOptions props) The number of bytes successfully put to the Kinesis stream over the specified time period.final Metric
The number of records successfully put to the Kinesis stream over the specified time period.final Metric
The number of records successfully put to the Kinesis stream over the specified time period.final Metric
The number of bytes put to the Kinesis stream using the PutRecord operation over the specified time period.final Metric
The number of bytes put to the Kinesis stream using the PutRecord operation over the specified time period.final Metric
The time taken per PutRecord operation, measured over the specified time period.final Metric
The time taken per PutRecord operation, measured over the specified time period.final Metric
The number of bytes put to the Kinesis stream using the PutRecords operation over the specified time period.final Metric
The number of bytes put to the Kinesis stream using the PutRecords operation over the specified time period.final Metric
The number of records rejected due to internal failures in a PutRecords operation per Kinesis data stream, measured over the specified time period.final Metric
The number of records rejected due to internal failures in a PutRecords operation per Kinesis data stream, measured over the specified time period.final Metric
The time taken per PutRecords operation, measured over the specified time period.final Metric
The time taken per PutRecords operation, measured over the specified time period.final Metric
The number of PutRecords operations where at least one record succeeded, per Kinesis stream, measured over the specified time period.final Metric
The number of PutRecords operations where at least one record succeeded, per Kinesis stream, measured over the specified time period.final Metric
The number of successful records in a PutRecords operation per Kinesis data stream, measured over the specified time period.final Metric
The number of successful records in a PutRecords operation per Kinesis data stream, measured over the specified time period.final Metric
The number of records rejected due to throttling in a PutRecords operation per Kinesis data stream, measured over the specified time period.final Metric
The number of records rejected due to throttling in a PutRecords operation per Kinesis data stream, measured over the specified time period.final Metric
The total number of records sent in a PutRecords operation per Kinesis data stream, measured over the specified time period.final Metric
The total number of records sent in a PutRecords operation per Kinesis data stream, measured over the specified time period.final Metric
The number of successful PutRecord operations per Kinesis stream, measured over the specified time period.final Metric
The number of successful PutRecord operations per Kinesis stream, measured over the specified time period.final Metric
The number of GetRecords calls throttled for the stream over the specified time period.final Metric
The number of GetRecords calls throttled for the stream over the specified time period.final Metric
The number of records rejected due to throttling for the stream over the specified time period.final Metric
The number of records rejected due to throttling for the stream over the specified time period.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, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
@Stability(Stable) @NotNull public final software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
- Specified by:
getNode
in interfaceIStream.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
- Specified by:
getEnv
in interfaceIStream.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
- Specified by:
getStack
in interfaceIStream.Jsii$Default
-
getStreamArn
The ARN of the stream.- Specified by:
getStreamArn
in interfaceIStream
- Specified by:
getStreamArn
in interfaceIStream.Jsii$Default
-
getStreamName
The name of the stream.- Specified by:
getStreamName
in interfaceIStream
- Specified by:
getStreamName
in interfaceIStream.Jsii$Default
-
getEncryptionKey
Optional KMS encryption key associated with this stream.- Specified by:
getEncryptionKey
in interfaceIStream
- Specified by:
getEncryptionKey
in interfaceIStream.Jsii$Default
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIStream.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
grant
@Stability(Stable) @NotNull public final Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) Grant the indicated permissions on this stream to the provided IAM principal.- Specified by:
grant
in interfaceIStream
- Specified by:
grant
in interfaceIStream.Jsii$Default
- Parameters:
grantee
- This parameter is required.actions
- This parameter is required.
-
grantRead
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 interfaceIStream
- Specified by:
grantRead
in interfaceIStream.Jsii$Default
- Parameters:
grantee
- This parameter is required.
-
grantReadWrite
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 interfaceIStream
- Specified by:
grantReadWrite
in interfaceIStream.Jsii$Default
- Parameters:
grantee
- This parameter is required.
-
grantWrite
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 interfaceIStream
- Specified by:
grantWrite
in interfaceIStream.Jsii$Default
- Parameters:
grantee
- This parameter is required.
-
metric
@Stability(Stable) @NotNull public final Metric metric(@NotNull String metricName, @Nullable MetricOptions props) Return stream metric based from its metric name.- Specified by:
metric
in interfaceIStream
- Specified by:
metric
in interfaceIStream.Jsii$Default
- Parameters:
metricName
- name of the stream metric. This parameter is required.props
- properties of the metric.
-
metric
Return stream metric based from its metric name. -
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
andperiod
properties.- Specified by:
metricGetRecords
in interfaceIStream
- Specified by:
metricGetRecords
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricGetRecords
in interfaceIStream
-
metricGetRecordsBytes
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricGetRecordsBytes
in interfaceIStream
- Specified by:
metricGetRecordsBytes
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricGetRecordsBytes
in interfaceIStream
-
metricGetRecordsIteratorAgeMilliseconds
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricGetRecordsIteratorAgeMilliseconds
in interfaceIStream
- Specified by:
metricGetRecordsIteratorAgeMilliseconds
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricGetRecordsIteratorAgeMilliseconds
in interfaceIStream
-
metricGetRecordsLatency
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricGetRecordsLatency
in interfaceIStream
- Specified by:
metricGetRecordsLatency
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricGetRecordsLatency
in interfaceIStream
-
metricGetRecordsSuccess
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricGetRecordsSuccess
in interfaceIStream
- Specified by:
metricGetRecordsSuccess
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricGetRecordsSuccess
in interfaceIStream
-
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
andperiod
properties.- Specified by:
metricIncomingBytes
in interfaceIStream
- Specified by:
metricIncomingBytes
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricIncomingBytes
in interfaceIStream
-
metricIncomingRecords
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricIncomingRecords
in interfaceIStream
- Specified by:
metricIncomingRecords
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricIncomingRecords
in interfaceIStream
-
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
andperiod
properties.- Specified by:
metricPutRecordBytes
in interfaceIStream
- Specified by:
metricPutRecordBytes
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricPutRecordBytes
in interfaceIStream
-
metricPutRecordLatency
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricPutRecordLatency
in interfaceIStream
- Specified by:
metricPutRecordLatency
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricPutRecordLatency
in interfaceIStream
-
metricPutRecordsBytes
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricPutRecordsBytes
in interfaceIStream
- Specified by:
metricPutRecordsBytes
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricPutRecordsBytes
in interfaceIStream
-
metricPutRecordsFailedRecords
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricPutRecordsFailedRecords
in interfaceIStream
- Specified by:
metricPutRecordsFailedRecords
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricPutRecordsFailedRecords
in interfaceIStream
-
metricPutRecordsLatency
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricPutRecordsLatency
in interfaceIStream
- Specified by:
metricPutRecordsLatency
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricPutRecordsLatency
in interfaceIStream
-
metricPutRecordsSuccess
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricPutRecordsSuccess
in interfaceIStream
- Specified by:
metricPutRecordsSuccess
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricPutRecordsSuccess
in interfaceIStream
-
metricPutRecordsSuccessfulRecords
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricPutRecordsSuccessfulRecords
in interfaceIStream
- Specified by:
metricPutRecordsSuccessfulRecords
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricPutRecordsSuccessfulRecords
in interfaceIStream
-
metricPutRecordsThrottledRecords
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricPutRecordsThrottledRecords
in interfaceIStream
- Specified by:
metricPutRecordsThrottledRecords
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricPutRecordsThrottledRecords
in interfaceIStream
-
metricPutRecordsTotalRecords
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricPutRecordsTotalRecords
in interfaceIStream
- Specified by:
metricPutRecordsTotalRecords
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricPutRecordsTotalRecords
in interfaceIStream
-
metricPutRecordSuccess
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricPutRecordSuccess
in interfaceIStream
- Specified by:
metricPutRecordSuccess
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricPutRecordSuccess
in interfaceIStream
-
metricReadProvisionedThroughputExceeded
@Stability(Stable) @NotNull public final 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
andperiod
properties- Specified by:
metricReadProvisionedThroughputExceeded
in interfaceIStream
- Specified by:
metricReadProvisionedThroughputExceeded
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties- Specified by:
metricReadProvisionedThroughputExceeded
in interfaceIStream
-
metricWriteProvisionedThroughputExceeded
@Stability(Stable) @NotNull public final 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
andperiod
properties.- Specified by:
metricWriteProvisionedThroughputExceeded
in interfaceIStream
- Specified by:
metricWriteProvisionedThroughputExceeded
in interfaceIStream.Jsii$Default
- Parameters:
props
- properties of the 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
andperiod
properties.- Specified by:
metricWriteProvisionedThroughputExceeded
in interfaceIStream
-