public static final class IStream.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IStream.Jsii$Default
IStream.Jsii$Default, IStream.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
void |
applyRemovalPolicy(RemovalPolicy policy)
Apply the given removal policy to this resource.
|
IKey |
getEncryptionKey()
Optional KMS encryption key associated with this stream.
|
ResourceEnvironment |
getEnv()
The environment this resource belongs to.
|
ConstructNode |
getNode()
The construct tree node for this construct.
|
Stack |
getStack()
The stack in which this resource is defined.
|
java.lang.String |
getStreamArn()
The ARN of the stream.
|
java.lang.String |
getStreamName()
The name of the stream.
|
Grant |
grant(IGrantable grantee,
java.lang.String... actions)
Grant the indicated permissions on this stream to the provided IAM principal.
|
Grant |
grantRead(IGrantable grantee)
Grant read permissions for this stream and its contents to an IAM principal (Role/Group/User).
|
Grant |
grantReadWrite(IGrantable grantee)
Grants read/write permissions for this stream and its contents to an IAM principal (Role/Group/User).
|
Grant |
grantWrite(IGrantable grantee)
Grant write permissions for this stream and its contents to an IAM principal (Role/Group/User).
|
Metric |
metric(java.lang.String metricName)
Return stream metric based from its metric name.
|
Metric |
metric(java.lang.String metricName,
MetricOptions props)
Return stream metric based from its metric name.
|
Metric |
metricGetRecords()
The number of records retrieved from the shard, measured over the specified time period.
|
Metric |
metricGetRecords(MetricOptions props)
The number of records retrieved from the shard, measured over the specified time period.
|
Metric |
metricGetRecordsBytes()
The number of bytes retrieved from the Kinesis stream, measured over the specified time period.
|
Metric |
metricGetRecordsBytes(MetricOptions props)
The number of bytes retrieved from the Kinesis stream, measured over the specified time period.
|
Metric |
metricGetRecordsIteratorAgeMilliseconds()
The age of the last record in all GetRecords calls made against a Kinesis stream, measured over the specified time period.
|
Metric |
metricGetRecordsIteratorAgeMilliseconds(MetricOptions props)
The age of the last record in all GetRecords calls made against a Kinesis stream, measured over the specified time period.
|
Metric |
metricGetRecordsLatency()
The time taken per GetRecords operation, measured over the specified time period.
|
Metric |
metricGetRecordsLatency(MetricOptions props)
The time taken per GetRecords operation, measured over the specified time period.
|
Metric |
metricGetRecordsSuccess()
The number of successful GetRecords operations per stream, measured over the specified time period.
|
Metric |
metricGetRecordsSuccess(MetricOptions props)
The number of successful GetRecords operations per stream, measured over the specified time period.
|
Metric |
metricIncomingBytes()
The number of bytes successfully put to the Kinesis stream over the specified time period.
|
Metric |
metricIncomingBytes(MetricOptions props)
The number of bytes successfully put to the Kinesis stream over the specified time period.
|
Metric |
metricIncomingRecords()
The number of records successfully put to the Kinesis stream over the specified time period.
|
Metric |
metricIncomingRecords(MetricOptions props)
The number of records successfully put to the Kinesis stream over the specified time period.
|
Metric |
metricPutRecordBytes()
The number of bytes put to the Kinesis stream using the PutRecord operation over the specified time period.
|
Metric |
metricPutRecordBytes(MetricOptions props)
The number of bytes put to the Kinesis stream using the PutRecord operation over the specified time period.
|
Metric |
metricPutRecordLatency()
The time taken per PutRecord operation, measured over the specified time period.
|
Metric |
metricPutRecordLatency(MetricOptions props)
The time taken per PutRecord operation, measured over the specified time period.
|
Metric |
metricPutRecordsBytes()
The number of bytes put to the Kinesis stream using the PutRecords operation over the specified time period.
|
Metric |
metricPutRecordsBytes(MetricOptions props)
The number of bytes put to the Kinesis stream using the PutRecords operation over the specified time period.
|
Metric |
metricPutRecordsFailedRecords()
The number of records rejected due to internal failures in a PutRecords operation per Kinesis data stream, measured over the specified time period.
|
Metric |
metricPutRecordsFailedRecords(MetricOptions props)
The number of records rejected due to internal failures in a PutRecords operation per Kinesis data stream, measured over the specified time period.
|
Metric |
metricPutRecordsLatency()
The time taken per PutRecords operation, measured over the specified time period.
|
Metric |
metricPutRecordsLatency(MetricOptions props)
The time taken per PutRecords operation, measured over the specified time period.
|
Metric |
metricPutRecordsSuccess()
The number of PutRecords operations where at least one record succeeded, per Kinesis stream, measured over the specified time period.
|
Metric |
metricPutRecordsSuccess(MetricOptions props)
The number of PutRecords operations where at least one record succeeded, per Kinesis stream, measured over the specified time period.
|
Metric |
metricPutRecordsSuccessfulRecords()
The number of successful records in a PutRecords operation per Kinesis data stream, measured over the specified time period.
|
Metric |
metricPutRecordsSuccessfulRecords(MetricOptions props)
The number of successful records in a PutRecords operation per Kinesis data stream, measured over the specified time period.
|
Metric |
metricPutRecordsThrottledRecords()
The number of records rejected due to throttling in a PutRecords operation per Kinesis data stream, measured over the specified time period.
|
Metric |
metricPutRecordsThrottledRecords(MetricOptions props)
The number of records rejected due to throttling in a PutRecords operation per Kinesis data stream, measured over the specified time period.
|
Metric |
metricPutRecordsTotalRecords()
The total number of records sent in a PutRecords operation per Kinesis data stream, measured over the specified time period.
|
Metric |
metricPutRecordsTotalRecords(MetricOptions props)
The total number of records sent in a PutRecords operation per Kinesis data stream, measured over the specified time period.
|
Metric |
metricPutRecordSuccess()
The number of successful PutRecord operations per Kinesis stream, measured over the specified time period.
|
Metric |
metricPutRecordSuccess(MetricOptions props)
The number of successful PutRecord operations per Kinesis stream, measured over the specified time period.
|
Metric |
metricReadProvisionedThroughputExceeded()
The number of GetRecords calls throttled for the stream over the specified time period.
|
Metric |
metricReadProvisionedThroughputExceeded(MetricOptions props)
The number of GetRecords calls throttled for the stream over the specified time period.
|
Metric |
metricWriteProvisionedThroughputExceeded()
The number of records rejected due to throttling for the stream over the specified time period.
|
Metric |
metricWriteProvisionedThroughputExceeded(MetricOptions props)
The number of records rejected due to throttling for the stream over the specified time period.
|
public final ConstructNode getNode()
getNode
in interface IConstruct
getNode
in interface IConstruct.Jsii$Default
getNode
in interface IResource.Jsii$Default
getNode
in interface IStream.Jsii$Default
public final ResourceEnvironment getEnv()
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.
getEnv
in interface IResource
getEnv
in interface IResource.Jsii$Default
getEnv
in interface IStream.Jsii$Default
public final Stack getStack()
getStack
in interface IResource
getStack
in interface IResource.Jsii$Default
getStack
in interface IStream.Jsii$Default
public final java.lang.String getStreamArn()
getStreamArn
in interface IStream
getStreamArn
in interface IStream.Jsii$Default
public final java.lang.String getStreamName()
getStreamName
in interface IStream
getStreamName
in interface IStream.Jsii$Default
public final IKey getEncryptionKey()
getEncryptionKey
in interface IStream
getEncryptionKey
in interface IStream.Jsii$Default
public final void applyRemovalPolicy(RemovalPolicy policy)
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
).
applyRemovalPolicy
in interface IResource
applyRemovalPolicy
in interface IResource.Jsii$Default
applyRemovalPolicy
in interface IStream.Jsii$Default
policy
- This parameter is required.public final Grant grant(IGrantable grantee, java.lang.String... actions)
grant
in interface IStream
grant
in interface IStream.Jsii$Default
grantee
- This parameter is required.actions
- This parameter is required.public final Grant grantRead(IGrantable grantee)
If an encryption key is used, permission to ues the key to decrypt the contents of the stream will also be granted.
grantRead
in interface IStream
grantRead
in interface IStream.Jsii$Default
grantee
- This parameter is required.public final Grant grantReadWrite(IGrantable grantee)
If an encryption key is used, permission to use the key for encrypt/decrypt will also be granted.
grantReadWrite
in interface IStream
grantReadWrite
in interface IStream.Jsii$Default
grantee
- This parameter is required.public final Grant grantWrite(IGrantable grantee)
If an encryption key is used, permission to ues the key to encrypt the contents of the stream will also be granted.
grantWrite
in interface IStream
grantWrite
in interface IStream.Jsii$Default
grantee
- This parameter is required.public final Metric metric(java.lang.String metricName, MetricOptions props)
metric
in interface IStream
metric
in interface IStream.Jsii$Default
metricName
- name of the stream metric. This parameter is required.props
- properties of the metric.public final Metric metric(java.lang.String metricName)
public final Metric metricGetRecords(MetricOptions props)
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.
metricGetRecords
in interface IStream
metricGetRecords
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricGetRecords()
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.
metricGetRecords
in interface IStream
public final Metric metricGetRecordsBytes(MetricOptions props)
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.
metricGetRecordsBytes
in interface IStream
metricGetRecordsBytes
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricGetRecordsBytes()
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.
metricGetRecordsBytes
in interface IStream
public final Metric metricGetRecordsIteratorAgeMilliseconds(MetricOptions props)
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.
metricGetRecordsIteratorAgeMilliseconds
in interface IStream
metricGetRecordsIteratorAgeMilliseconds
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricGetRecordsIteratorAgeMilliseconds()
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.
metricGetRecordsIteratorAgeMilliseconds
in interface IStream
public final Metric metricGetRecordsLatency(MetricOptions props)
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricGetRecordsLatency
in interface IStream
metricGetRecordsLatency
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricGetRecordsLatency()
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricGetRecordsLatency
in interface IStream
public final Metric metricGetRecordsSuccess(MetricOptions props)
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricGetRecordsSuccess
in interface IStream
metricGetRecordsSuccess
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricGetRecordsSuccess()
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricGetRecordsSuccess
in interface IStream
public final Metric metricIncomingBytes(MetricOptions props)
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.
metricIncomingBytes
in interface IStream
metricIncomingBytes
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricIncomingBytes()
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.
metricIncomingBytes
in interface IStream
public final Metric metricIncomingRecords(MetricOptions props)
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.
metricIncomingRecords
in interface IStream
metricIncomingRecords
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricIncomingRecords()
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.
metricIncomingRecords
in interface IStream
public final Metric metricPutRecordBytes(MetricOptions props)
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordBytes
in interface IStream
metricPutRecordBytes
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricPutRecordBytes()
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordBytes
in interface IStream
public final Metric metricPutRecordLatency(MetricOptions props)
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordLatency
in interface IStream
metricPutRecordLatency
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricPutRecordLatency()
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordLatency
in interface IStream
public final Metric metricPutRecordsBytes(MetricOptions props)
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsBytes
in interface IStream
metricPutRecordsBytes
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricPutRecordsBytes()
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsBytes
in interface IStream
public final Metric metricPutRecordsFailedRecords(MetricOptions props)
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.
metricPutRecordsFailedRecords
in interface IStream
metricPutRecordsFailedRecords
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricPutRecordsFailedRecords()
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.
metricPutRecordsFailedRecords
in interface IStream
public final Metric metricPutRecordsLatency(MetricOptions props)
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsLatency
in interface IStream
metricPutRecordsLatency
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricPutRecordsLatency()
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsLatency
in interface IStream
public final Metric metricPutRecordsSuccess(MetricOptions props)
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsSuccess
in interface IStream
metricPutRecordsSuccess
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricPutRecordsSuccess()
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsSuccess
in interface IStream
public final Metric metricPutRecordsSuccessfulRecords(MetricOptions props)
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsSuccessfulRecords
in interface IStream
metricPutRecordsSuccessfulRecords
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricPutRecordsSuccessfulRecords()
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsSuccessfulRecords
in interface IStream
public final Metric metricPutRecordsThrottledRecords(MetricOptions props)
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsThrottledRecords
in interface IStream
metricPutRecordsThrottledRecords
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricPutRecordsThrottledRecords()
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsThrottledRecords
in interface IStream
public final Metric metricPutRecordsTotalRecords(MetricOptions props)
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsTotalRecords
in interface IStream
metricPutRecordsTotalRecords
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricPutRecordsTotalRecords()
The metric defaults to average over 5 minutes, it can be changed by passing statistic
and period
properties.
metricPutRecordsTotalRecords
in interface IStream
public final Metric metricPutRecordSuccess(MetricOptions props)
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.
metricPutRecordSuccess
in interface IStream
metricPutRecordSuccess
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricPutRecordSuccess()
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.
metricPutRecordSuccess
in interface IStream
public final Metric metricReadProvisionedThroughputExceeded(MetricOptions props)
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
metricReadProvisionedThroughputExceeded
in interface IStream
metricReadProvisionedThroughputExceeded
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricReadProvisionedThroughputExceeded()
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
metricReadProvisionedThroughputExceeded
in interface IStream
public final Metric metricWriteProvisionedThroughputExceeded(MetricOptions props)
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.
metricWriteProvisionedThroughputExceeded
in interface IStream
metricWriteProvisionedThroughputExceeded
in interface IStream.Jsii$Default
props
- properties of the metric.public final Metric metricWriteProvisionedThroughputExceeded()
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.
metricWriteProvisionedThroughputExceeded
in interface IStream