Module: AWSCDK::Kinesis::IStream

Includes:
IResource, Interfaces::AWSKinesis::IStreamRef
Included in:
Stream
Defined in:
kinesis/i_stream.rb

Overview

A Kinesis Stream.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'kinesis/i_stream.rb', line 442

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :stream_ref => { kind: :property, name: "streamRef", is_optional: false },
    :stream_arn => { kind: :property, name: "streamArn", is_optional: false },
    :stream_name => { kind: :property, name: "streamName", is_optional: false },
    :encryption_key => { kind: :property, name: "encryptionKey", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :add_to_resource_policy => { kind: :method, name: "addToResourcePolicy", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :grant_read_write => { kind: :method, name: "grantReadWrite", is_optional: false },
    :grant_write => { kind: :method, name: "grantWrite", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_get_records => { kind: :method, name: "metricGetRecords", is_optional: false },
    :metric_get_records_bytes => { kind: :method, name: "metricGetRecordsBytes", is_optional: false },
    :metric_get_records_iterator_age_milliseconds => { kind: :method, name: "metricGetRecordsIteratorAgeMilliseconds", is_optional: false },
    :metric_get_records_latency => { kind: :method, name: "metricGetRecordsLatency", is_optional: false },
    :metric_get_records_success => { kind: :method, name: "metricGetRecordsSuccess", is_optional: false },
    :metric_incoming_bytes => { kind: :method, name: "metricIncomingBytes", is_optional: false },
    :metric_incoming_records => { kind: :method, name: "metricIncomingRecords", is_optional: false },
    :metric_put_record_bytes => { kind: :method, name: "metricPutRecordBytes", is_optional: false },
    :metric_put_record_latency => { kind: :method, name: "metricPutRecordLatency", is_optional: false },
    :metric_put_records_bytes => { kind: :method, name: "metricPutRecordsBytes", is_optional: false },
    :metric_put_records_failed_records => { kind: :method, name: "metricPutRecordsFailedRecords", is_optional: false },
    :metric_put_records_latency => { kind: :method, name: "metricPutRecordsLatency", is_optional: false },
    :metric_put_records_success => { kind: :method, name: "metricPutRecordsSuccess", is_optional: false },
    :metric_put_records_successful_records => { kind: :method, name: "metricPutRecordsSuccessfulRecords", is_optional: false },
    :metric_put_records_throttled_records => { kind: :method, name: "metricPutRecordsThrottledRecords", is_optional: false },
    :metric_put_records_total_records => { kind: :method, name: "metricPutRecordsTotalRecords", is_optional: false },
    :metric_put_record_success => { kind: :method, name: "metricPutRecordSuccess", is_optional: false },
    :metric_read_provisioned_throughput_exceeded => { kind: :method, name: "metricReadProvisionedThroughputExceeded", is_optional: false },
    :metric_write_provisioned_throughput_exceeded => { kind: :method, name: "metricWriteProvisionedThroughputExceeded", is_optional: false },
  }
end

Instance Method Details

#add_to_resource_policy(statement) ⇒ AWSCDK::IAM::AddToResourcePolicyResult

Adds a statement to the IAM resource policy associated with this stream.

If this stream was created in this stack (new Stream), a resource policy will be automatically created upon the first call to add_to_resource_policy. If the stream is imported (Stream.import), then this is a no-op.

Parameters:

Returns:



105
106
107
108
 
# File 'kinesis/i_stream.rb', line 105

def add_to_resource_policy(statement)
  Jsii::Type.check_type(statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement")
  jsii_call_method("addToResourcePolicy", [statement])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

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).

Parameters:



92
93
94
95
 
# File 'kinesis/i_stream.rb', line 92

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#encryption_key ⇒ AWSCDK::KMS::IKey?

Optional KMS encryption key associated with this stream.

Returns:



62
63
64
 
# File 'kinesis/i_stream.rb', line 62

def encryption_key()
  jsii_get_property("encryptionKey")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



27
28
29
 
# File 'kinesis/i_stream.rb', line 27

def env()
  jsii_get_property("env")
end

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

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

Parameters:

Returns:



115
116
117
118
119
120
121
 
# File 'kinesis/i_stream.rb', line 115

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

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.

Parameters:

Returns:



130
131
132
133
 
# File 'kinesis/i_stream.rb', line 130

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#grant_read_write(grantee) ⇒ AWSCDK::IAM::Grant

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.

Parameters:

Returns:



142
143
144
145
 
# File 'kinesis/i_stream.rb', line 142

def grant_read_write(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantReadWrite", [grantee])
end

#grant_write(grantee) ⇒ AWSCDK::IAM::Grant

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.

Parameters:

Returns:



154
155
156
157
 
# File 'kinesis/i_stream.rb', line 154

def grant_write(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantWrite", [grantee])
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return stream metric based from its metric name.

Parameters:

Returns:



164
165
166
167
168
169
 
# File 'kinesis/i_stream.rb', line 164

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_get_records(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



181
182
183
184
185
 
# File 'kinesis/i_stream.rb', line 181

def metric_get_records(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricGetRecords", [props])
end

#metric_get_records_bytes(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



197
198
199
200
201
 
# File 'kinesis/i_stream.rb', line 197

def metric_get_records_bytes(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricGetRecordsBytes", [props])
end

#metric_get_records_iterator_age_milliseconds(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



213
214
215
216
217
 
# File 'kinesis/i_stream.rb', line 213

def metric_get_records_iterator_age_milliseconds(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricGetRecordsIteratorAgeMilliseconds", [props])
end

#metric_get_records_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



225
226
227
228
229
 
# File 'kinesis/i_stream.rb', line 225

def metric_get_records_latency(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricGetRecordsLatency", [props])
end

#metric_get_records_success(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



237
238
239
240
241
 
# File 'kinesis/i_stream.rb', line 237

def metric_get_records_success(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricGetRecordsSuccess", [props])
end

#metric_incoming_bytes(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



253
254
255
256
257
 
# File 'kinesis/i_stream.rb', line 253

def metric_incoming_bytes(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricIncomingBytes", [props])
end

#metric_incoming_records(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



269
270
271
272
273
 
# File 'kinesis/i_stream.rb', line 269

def metric_incoming_records(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricIncomingRecords", [props])
end

#metric_put_record_bytes(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



281
282
283
284
285
 
# File 'kinesis/i_stream.rb', line 281

def metric_put_record_bytes(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricPutRecordBytes", [props])
end

#metric_put_record_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



293
294
295
296
297
 
# File 'kinesis/i_stream.rb', line 293

def metric_put_record_latency(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricPutRecordLatency", [props])
end

#metric_put_record_success(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



394
395
396
397
398
 
# File 'kinesis/i_stream.rb', line 394

def metric_put_record_success(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricPutRecordSuccess", [props])
end

#metric_put_records_bytes(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



305
306
307
308
309
 
# File 'kinesis/i_stream.rb', line 305

def metric_put_records_bytes(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricPutRecordsBytes", [props])
end

#metric_put_records_failed_records(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



319
320
321
322
323
 
# File 'kinesis/i_stream.rb', line 319

def metric_put_records_failed_records(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricPutRecordsFailedRecords", [props])
end

#metric_put_records_latency(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



331
332
333
334
335
 
# File 'kinesis/i_stream.rb', line 331

def metric_put_records_latency(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricPutRecordsLatency", [props])
end

#metric_put_records_success(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



343
344
345
346
347
 
# File 'kinesis/i_stream.rb', line 343

def metric_put_records_success(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricPutRecordsSuccess", [props])
end

#metric_put_records_successful_records(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



355
356
357
358
359
 
# File 'kinesis/i_stream.rb', line 355

def metric_put_records_successful_records(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricPutRecordsSuccessfulRecords", [props])
end

#metric_put_records_throttled_records(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



367
368
369
370
371
 
# File 'kinesis/i_stream.rb', line 367

def metric_put_records_throttled_records(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricPutRecordsThrottledRecords", [props])
end

#metric_put_records_total_records(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



379
380
381
382
383
 
# File 'kinesis/i_stream.rb', line 379

def metric_put_records_total_records(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricPutRecordsTotalRecords", [props])
end

#metric_read_provisioned_throughput_exceeded(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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

Parameters:

Returns:



415
416
417
418
419
 
# File 'kinesis/i_stream.rb', line 415

def metric_read_provisioned_throughput_exceeded(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricReadProvisionedThroughputExceeded", [props])
end

#metric_write_provisioned_throughput_exceeded(props = nil) ⇒ AWSCDK::CloudWatch::Metric

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.

Parameters:

Returns:



436
437
438
439
440
 
# File 'kinesis/i_stream.rb', line 436

def metric_write_provisioned_throughput_exceeded(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricWriteProvisionedThroughputExceeded", [props])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'kinesis/i_stream.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'kinesis/i_stream.rb', line 34

def stack()
  jsii_get_property("stack")
end

#stream_arn ⇒ String

The ARN of the stream.

Returns:

  • (String) 


48
49
50
 
# File 'kinesis/i_stream.rb', line 48

def stream_arn()
  jsii_get_property("streamArn")
end

#stream_name ⇒ String

The name of the stream.

Returns:

  • (String) 


55
56
57
 
# File 'kinesis/i_stream.rb', line 55

def stream_name()
  jsii_get_property("streamName")
end

#stream_ref ⇒ AWSCDK::Interfaces::AWSKinesis::StreamReference

A reference to a Stream resource.

Returns:



41
42
43
 
# File 'kinesis/i_stream.rb', line 41

def stream_ref()
  jsii_get_property("streamRef")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



73
74
75
76
77
78
 
# File 'kinesis/i_stream.rb', line 73

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end