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
• Struct
• Aws::IoT::Types::CloudwatchMetricAction

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: "String", # required
  metric_name: "String", # required
  metric_value: "String", # required
  metric_unit: "String", # required
  metric_timestamp: "String",
}

Describes an action that captures a CloudWatch metric.

Instance Attribute Summary

• #metric_name ⇒ String

  The CloudWatch metric name.

• #metric_namespace ⇒ String

  The CloudWatch metric namespace name.

• #metric_timestamp ⇒ String

  An optional [Unix timestamp][1].

• #metric_unit ⇒ String

  The [metric unit][1] supported by CloudWatch.

• #metric_value ⇒ String

  The CloudWatch metric value.

• #role_arn ⇒ String

  The IAM role that allows access to the CloudWatch metric.

Instance Attribute Details

#metric_name ⇒ String

The CloudWatch metric name.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1752

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

#metric_namespace ⇒ String

The CloudWatch metric namespace name.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1752

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

#metric_timestamp ⇒ String

An optional Unix timestamp.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1752

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

#metric_unit ⇒ String

The metric unit supported by CloudWatch.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1752

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

#metric_value ⇒ String

The CloudWatch metric value.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1752

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

#role_arn ⇒ String

The IAM role that allows access to the CloudWatch metric.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 1752

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