CfnFleetMetricPropsMixin

class aws_cdk.cfn_property_mixins.aws_iot.CfnFleetMetricPropsMixin(props, *, strategy=None)

Bases: Mixin

Use the AWS::IoT::FleetMetric resource to declare a fleet metric.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html
CloudformationResource:: AWS::IoT::FleetMetric
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# merge_strategy: cdk.IMergeStrategy

cfn_fleet_metric_props_mixin = iot.CfnFleetMetricPropsMixin(iot.CfnFleetMetricMixinProps(
    aggregation_field="aggregationField",
    aggregation_type=iot.CfnFleetMetricPropsMixin.AggregationTypeProperty(
        name="name",
        values=["values"]
    ),
    description="description",
    index_name="indexName",
    metric_name="metricName",
    period=123,
    query_string="queryString",
    query_version="queryVersion",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    unit="unit"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::IoT::FleetMetric.

Parameters:

props (Union[CfnFleetMetricMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['aggregationField', 'aggregationType', 'description', 'indexName', 'metricName', 'period', 'queryString', 'queryVersion', 'tags', 'unit']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

AggregationTypeProperty

class CfnFleetMetricPropsMixin.AggregationTypeProperty(*, name=None, values=None)

Bases: object

The type of aggregation queries.

Parameters:

name (Optional[str]) – The name of the aggregation type.
values (Optional[Sequence[str]]) – A list of the values of aggregation types.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

aggregation_type_property = iot.CfnFleetMetricPropsMixin.AggregationTypeProperty(
    name="name",
    values=["values"]
)

Attributes

name

The name of the aggregation type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-fleetmetric-aggregationtype.html#cfn-iot-fleetmetric-aggregationtype-name

values

A list of the values of aggregation types.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-fleetmetric-aggregationtype.html#cfn-iot-fleetmetric-aggregationtype-values