CfnFleetMetricProps¶

class aws_cdk.aws_iot.CfnFleetMetricProps(*, metric_name, aggregation_field=None, aggregation_type=None, description=None, index_name=None, period=None, query_string=None, query_version=None, tags=None, unit=None)¶

Bases: object

Properties for defining a CfnFleetMetric.

Parameters

metric_name (str) – The name of the fleet metric to create.
aggregation_field (Optional[str]) – The field to aggregate.
aggregation_type (Union[IResolvable, AggregationTypeProperty, Dict[str, Any], None]) – The type of the aggregation query.
description (Optional[str]) – The fleet metric description.
index_name (Optional[str]) – The name of the index to search.
period (Union[int, float, None]) – The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
query_string (Optional[str]) – The search query string.
query_version (Optional[str]) – The query version.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata which can be used to manage the fleet metric.
unit (Optional[str]) – Used to support unit transformation such as milliseconds to seconds. Must be a unit supported by CW metric. Default to null.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot as iot

cfn_fleet_metric_props = iot.CfnFleetMetricProps(
    metric_name="metricName",

    # the properties below are optional
    aggregation_field="aggregationField",
    aggregation_type=iot.CfnFleetMetric.AggregationTypeProperty(
        name="name",
        values=["values"]
    ),
    description="description",
    index_name="indexName",
    period=123,
    query_string="queryString",
    query_version="queryVersion",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    unit="unit"
)