Class: Aws::Kinesis::Types::EnableEnhancedMonitoringInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kinesis/types.rb

Overview

Note:

When making an API call, you may pass EnableEnhancedMonitoringInput data as a hash:

{
  stream_name: "StreamName", # required
  shard_level_metrics: ["IncomingBytes"], # required, accepts IncomingBytes, IncomingRecords, OutgoingBytes, OutgoingRecords, WriteProvisionedThroughputExceeded, ReadProvisionedThroughputExceeded, IteratorAgeMilliseconds, ALL
}

Represents the input for EnableEnhancedMonitoring.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#shard_level_metricsArray<String>

List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value “`ALL`” enables every metric.

  • `IncomingBytes`

  • `IncomingRecords`

  • `OutgoingBytes`

  • `OutgoingRecords`

  • `WriteProvisionedThroughputExceeded`

  • `ReadProvisionedThroughputExceeded`

  • `IteratorAgeMilliseconds`

  • `ALL`

For more information, see [Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch] in the *Amazon Kinesis Data Streams Developer Guide*.

[1]: docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html

Returns:

  • (Array<String>)

531
532
533
534
535
536
# File 'lib/aws-sdk-kinesis/types.rb', line 531

class EnableEnhancedMonitoringInput < Struct.new(
  :stream_name,
  :shard_level_metrics)
  SENSITIVE = []
  include Aws::Structure
end

#stream_nameString

The name of the stream for which to enable enhanced monitoring.

Returns:

  • (String)

531
532
533
534
535
536
# File 'lib/aws-sdk-kinesis/types.rb', line 531

class EnableEnhancedMonitoringInput < Struct.new(
  :stream_name,
  :shard_level_metrics)
  SENSITIVE = []
  include Aws::Structure
end