Package software.amazon.awscdk.services.kinesis

Class IStream.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.kinesis.IStream.Jsii$Proxy
All Implemented Interfaces:
IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IStream, IStream.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default
Enclosing interface:
IStream
@Internal public static final class IStream.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IStream.Jsii$Default
A proxy class which represents a concrete javascript instance of this type.

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

  • Method Details

    • getNode

      @Stability(Stable) @NotNull public final ConstructNode getNode()
      The construct tree node for this construct.
      Specified by:
      getNode in interface IConstruct
      Specified by:
      getNode in interface IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default
      Specified by:
      getNode in interface IStream.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull public final 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
      Specified by:
      getEnv in interface IStream.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull public final Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default
      Specified by:
      getStack in interface IStream.Jsii$Default

    • getStreamArn

      @Stability(Stable) @NotNull public final String getStreamArn()
      The ARN of the stream.
      Specified by:
      getStreamArn in interface IStream
      Specified by:
      getStreamArn in interface IStream.Jsii$Default

    • getStreamName

      @Stability(Stable) @NotNull public final String getStreamName()
      The name of the stream.
      Specified by:
      getStreamName in interface IStream
      Specified by:
      getStreamName in interface IStream.Jsii$Default

    • getEncryptionKey

      @Stability(Stable) @Nullable public final IKey getEncryptionKey()
      Optional KMS encryption key associated with this stream.
      Specified by:
      getEncryptionKey in interface IStream
      Specified by:
      getEncryptionKey in interface IStream.Jsii$Default

    • applyRemovalPolicy

      @Stability(Stable) public final 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
      Specified by:
      applyRemovalPolicy in interface IStream.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 interface IStream
      Specified by:
      grant in interface IStream.Jsii$Default
      Parameters:
      grantee - This parameter is required.
      actions - This parameter is required.

    • grantRead

      @Stability(Stable) @NotNull public final 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
      Specified by:
      grantRead in interface IStream.Jsii$Default
      Parameters:
      grantee - This parameter is required.

    • grantReadWrite

      @Stability(Stable) @NotNull public final 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
      Specified by:
      grantReadWrite in interface IStream.Jsii$Default
      Parameters:
      grantee - This parameter is required.

    • grantWrite

      @Stability(Stable) @NotNull public final 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
      Specified by:
      grantWrite in interface IStream.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 interface IStream
      Specified by:
      metric in interface IStream.Jsii$Default
      Parameters:
      metricName - name of the stream metric. This parameter is required.
      props - properties of the metric.

    • metric

      @Stability(Stable) @NotNull public final 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(Stable) @NotNull public final 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
      Specified by:
      metricGetRecords in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricGetRecords

      @Stability(Stable) @NotNull public final Metric metricGetRecords()
      The number of records retrieved from the shard, measured over the specified time period.

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

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

      Specified by:
      metricGetRecords in interface IStream

    • 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 and period properties.

      Specified by:
      metricGetRecordsBytes in interface IStream
      Specified by:
      metricGetRecordsBytes in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricGetRecordsBytes

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricGetRecordsIteratorAgeMilliseconds in interface IStream
      Specified by:
      metricGetRecordsIteratorAgeMilliseconds in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricGetRecordsIteratorAgeMilliseconds

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricGetRecordsLatency in interface IStream
      Specified by:
      metricGetRecordsLatency in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricGetRecordsLatency

      @Stability(Stable) @NotNull public final Metric metricGetRecordsLatency()
      The time taken per GetRecords operation, measured over the specified time period.

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

      Specified by:
      metricGetRecordsLatency in interface IStream

    • 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 and period properties.

      Specified by:
      metricGetRecordsSuccess in interface IStream
      Specified by:
      metricGetRecordsSuccess in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricGetRecordsSuccess

      @Stability(Stable) @NotNull public final 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(Stable) @NotNull public final 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
      Specified by:
      metricIncomingBytes in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricIncomingBytes

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricIncomingRecords in interface IStream
      Specified by:
      metricIncomingRecords in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricIncomingRecords

      @Stability(Stable) @NotNull public final 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(Stable) @NotNull public final 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
      Specified by:
      metricPutRecordBytes in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricPutRecordBytes

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricPutRecordLatency in interface IStream
      Specified by:
      metricPutRecordLatency in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricPutRecordLatency

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricPutRecordsBytes in interface IStream
      Specified by:
      metricPutRecordsBytes in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricPutRecordsBytes

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricPutRecordsFailedRecords in interface IStream
      Specified by:
      metricPutRecordsFailedRecords in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricPutRecordsFailedRecords

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricPutRecordsLatency in interface IStream
      Specified by:
      metricPutRecordsLatency in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricPutRecordsLatency

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricPutRecordsSuccess in interface IStream
      Specified by:
      metricPutRecordsSuccess in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricPutRecordsSuccess

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricPutRecordsSuccessfulRecords in interface IStream
      Specified by:
      metricPutRecordsSuccessfulRecords in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricPutRecordsSuccessfulRecords

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricPutRecordsThrottledRecords in interface IStream
      Specified by:
      metricPutRecordsThrottledRecords in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricPutRecordsThrottledRecords

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricPutRecordsTotalRecords in interface IStream
      Specified by:
      metricPutRecordsTotalRecords in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricPutRecordsTotalRecords

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricPutRecordSuccess in interface IStream
      Specified by:
      metricPutRecordSuccess in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricPutRecordSuccess

      @Stability(Stable) @NotNull public final 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(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 and period properties

      Specified by:
      metricReadProvisionedThroughputExceeded in interface IStream
      Specified by:
      metricReadProvisionedThroughputExceeded in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricReadProvisionedThroughputExceeded

      @Stability(Stable) @NotNull public final 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(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 and period properties.

      Specified by:
      metricWriteProvisionedThroughputExceeded in interface IStream
      Specified by:
      metricWriteProvisionedThroughputExceeded in interface IStream.Jsii$Default
      Parameters:
      props - properties of the metric.

    • metricWriteProvisionedThroughputExceeded

      @Stability(Stable) @NotNull public final 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