You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::IoT::Types::CloudwatchMetricAction

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

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

{
  role_arn: "AwsArn", # required
  metric_namespace: "MetricNamespace", # required
  metric_name: "MetricName", # required
  metric_value: "MetricValue", # required
  metric_unit: "MetricUnit", # required
  metric_timestamp: "MetricTimestamp",
}

Describes an action that captures a CloudWatch metric.

Instance Attribute Summary collapse

Instance Attribute Details

#metric_nameString

The CloudWatch metric name.

Returns:

  • (String)


539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 539

class CloudwatchMetricAction < Struct.new(
  :role_arn,
  :metric_namespace,
  :metric_name,
  :metric_value,
  :metric_unit,
  :metric_timestamp)
  include Aws::Structure
end

#metric_namespaceString

The CloudWatch metric namespace name.

Returns:

  • (String)


539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 539

class CloudwatchMetricAction < Struct.new(
  :role_arn,
  :metric_namespace,
  :metric_name,
  :metric_value,
  :metric_unit,
  :metric_timestamp)
  include Aws::Structure
end

#metric_timestampString

An optional Unix timestamp.

Returns:

  • (String)


539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 539

class CloudwatchMetricAction < Struct.new(
  :role_arn,
  :metric_namespace,
  :metric_name,
  :metric_value,
  :metric_unit,
  :metric_timestamp)
  include Aws::Structure
end

#metric_unitString

The metric unit supported by CloudWatch.

Returns:

  • (String)


539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 539

class CloudwatchMetricAction < Struct.new(
  :role_arn,
  :metric_namespace,
  :metric_name,
  :metric_value,
  :metric_unit,
  :metric_timestamp)
  include Aws::Structure
end

#metric_valueString

The CloudWatch metric value.

Returns:

  • (String)


539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 539

class CloudwatchMetricAction < Struct.new(
  :role_arn,
  :metric_namespace,
  :metric_name,
  :metric_value,
  :metric_unit,
  :metric_timestamp)
  include Aws::Structure
end

#role_arnString

The IAM role that allows access to the CloudWatch metric.

Returns:

  • (String)


539
540
541
542
543
544
545
546
547
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 539

class CloudwatchMetricAction < Struct.new(
  :role_arn,
  :metric_namespace,
  :metric_name,
  :metric_value,
  :metric_unit,
  :metric_timestamp)
  include Aws::Structure
end