Class: Aws::CloudWatch::Types::Entity

Inherits:

Struct

Object
Struct
Aws::CloudWatch::Types::Entity

show all

Defined in:: gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb

Overview

An entity associated with metrics, to allow for finding related telemetry. An entity is typically a resource or service within your system. For example, metrics from an Amazon EC2 instance could be associated with that instance as the entity. Similarly, metrics from a service that you own could be associated with that service as the entity.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#attributes ⇒ Hash<String,String>
Additional attributes of the entity that are not used to specify the identity of the entity.
#key_attributes ⇒ Hash<String,String>
The attributes of the entity which identify the specific entity, as a list of key-value pairs.

Instance Attribute Details

#attributes ⇒ `Hash<String,String>`

Additional attributes of the entity that are not used to specify the identity of the entity. A list of key-value pairs.

For details about how to use the attributes, see How to add related information to telemetry in the CloudWatch User Guide.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 1115

class Entity < Struct.new(
  :key_attributes,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#key_attributes ⇒ `Hash<String,String>`

The attributes of the entity which identify the specific entity, as a list of key-value pairs. Entities with the same KeyAttributes are considered to be the same entity. For an entity to be valid, the KeyAttributes must exist and be formatted correctly.

There are five allowed attributes (key names): Type, ResourceType, Identifier, Name, and Environment.

For details about how to use the key attributes to specify an entity, see How to add related information to telemetry in the CloudWatch User Guide.