Class: Aws::IoT::Types::CreateFleetMetricRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CreateFleetMetricRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregation_field ⇒ String

  The field to aggregate.

• #aggregation_type ⇒ Types::AggregationType

  The type of the aggregation query.

• #description ⇒ String

  The fleet metric description.

• #index_name ⇒ String

  The name of the index to search.

• #metric_name ⇒ String

  The name of the fleet metric to create.

• #period ⇒ Integer

  The time in seconds between fleet metric emissions.

• #query_string ⇒ String

  The search query string.

• #query_version ⇒ String

  The query version.

• #tags ⇒ Array<Types::Tag>

  Metadata, which can be used to manage the fleet metric.

• #unit ⇒ String

  Used to support unit transformation such as milliseconds to seconds.

Instance Attribute Details

#aggregation_field ⇒ String

The field to aggregate.

Returns:

• (String)

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

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#aggregation_type ⇒ Types::AggregationType

The type of the aggregation query.

Returns:

• (Types::AggregationType)

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

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The fleet metric description.

Returns:

• (String)

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

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The name of the index to search.

Returns:

• (String)

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

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#metric_name ⇒ String

The name of the fleet metric to create.

Returns:

• (String)

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

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#period ⇒ Integer

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

Returns:

• (Integer)

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

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#query_string ⇒ String

The search query string.

Returns:

• (String)

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

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#query_version ⇒ String

The query version.

Returns:

• (String)

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

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Metadata, which can be used to manage the fleet metric.

Returns:

• (Array<Types::Tag>)

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

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by [CW metric]. Default to null.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html

Returns:

• (String)

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

class CreateFleetMetricRequest < Struct.new(
  :metric_name,
  :query_string,
  :aggregation_type,
  :period,
  :aggregation_field,
  :description,
  :query_version,
  :index_name,
  :unit,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end