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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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 collapse

Instance Attribute Details

#metric_name ⇒ String

The CloudWatch metric name.

Returns:

  • (String) 


1507
1508
1509
1510
1511
1512
1513
1514
1515
 
# File 'lib/aws-sdk-iot/types.rb', line 1507

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) 


1507
1508
1509
1510
1511
1512
1513
1514
1515
 
# File 'lib/aws-sdk-iot/types.rb', line 1507

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

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp

Returns:

  • (String) 


1507
1508
1509
1510
1511
1512
1513
1514
1515
 
# File 'lib/aws-sdk-iot/types.rb', line 1507

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.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit

Returns:

  • (String) 


1507
1508
1509
1510
1511
1512
1513
1514
1515
 
# File 'lib/aws-sdk-iot/types.rb', line 1507

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) 


1507
1508
1509
1510
1511
1512
1513
1514
1515
 
# File 'lib/aws-sdk-iot/types.rb', line 1507

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) 


1507
1508
1509
1510
1511
1512
1513
1514
1515
 
# File 'lib/aws-sdk-iot/types.rb', line 1507

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