Class: Aws::CloudWatch::Types::PutMetricDataQueryDefinitionInput

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

Overview

Constant Summary collapse

SENSITIVE =
[:expression]

Instance Attribute Summary collapse

Instance Attribute Details

#expression ⇒ String

The query expression, in the language that Type specifies. CloudWatch doesn't validate or run the expression when you save it.

Returns:

  • (String)


5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 5964

class PutMetricDataQueryDefinitionInput < Struct.new(
  :id,
  :path,
  :expression,
  :type,
  :tags)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#id ⇒ String

The ID of the metric data query definition to update. Omit this parameter to create a definition. CloudWatch then generates the ID and returns it in the response.

Returns:

  • (String)


5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 5964

class PutMetricDataQueryDefinitionInput < Struct.new(
  :id,
  :path,
  :expression,
  :type,
  :tags)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#path ⇒ String

The name of the metric data query definition. Use slashes (/) to organize definitions into folders, for example team/web/latency. The path must meet the following requirements:

  • It must be unique in your account and Region.

  • It can't start or end with a slash.

  • It can't contain an empty folder name (//).

  • It can be at most 1,015 bytes when encoded as UTF-8.

Returns:

  • (String)


5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 5964

class PutMetricDataQueryDefinitionInput < Struct.new(
  :id,
  :path,
  :expression,
  :type,
  :tags)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of key-value pairs to associate with the metric data query definition. You can use tags to categorize definitions and to control access to them. Tags are applied only when the request creates a definition, that is, when you omit Id. To change the tags of an existing definition, use TagResource and UntagResource.

Returns:



5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 5964

class PutMetricDataQueryDefinitionInput < Struct.new(
  :id,
  :path,
  :expression,
  :type,
  :tags)
  SENSITIVE = [:expression]
  include Aws::Structure
end

#type ⇒ String

The language of the expression. Valid values are the following:

  • PROMQL – A PromQL query.

  • SQL – A CloudWatch Metrics Insights query.

  • METRIC_MATH – A metric math expression.

Returns:

  • (String)


5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cloudwatch/lib/aws-sdk-cloudwatch/types.rb', line 5964

class PutMetricDataQueryDefinitionInput < Struct.new(
  :id,
  :path,
  :expression,
  :type,
  :tags)
  SENSITIVE = [:expression]
  include Aws::Structure
end