Interface ICfnFleetMetricProps
Properties for defining a CfnFleetMetric
.
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnFleetMetricProps
Syntax (vb)
Public Interface ICfnFleetMetricProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnFleetMetricProps = new CfnFleetMetricProps {
MetricName = "metricName",
// the properties below are optional
AggregationField = "aggregationField",
AggregationType = new AggregationTypeProperty {
Name = "name",
Values = new [] { "values" }
},
Description = "description",
IndexName = "indexName",
Period = 123,
QueryString = "queryString",
QueryVersion = "queryVersion",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Unit = "unit"
};
Synopsis
Properties
AggregationField | The field to aggregate. |
AggregationType | The type of the aggregation query. |
Description | The fleet metric description. |
IndexName | The name of the index to search. |
MetricName | The name of the fleet metric to create. |
Period | The time in seconds between fleet metric emissions. |
QueryString | The search query string. |
QueryVersion | The query version. |
Tags | Metadata which can be used to manage the fleet metric. |
Unit | Used to support unit transformation such as milliseconds to seconds. |
Properties
AggregationField
The field to aggregate.
virtual string AggregationField { get; }
Property Value
System.String
Remarks
AggregationType
The type of the aggregation query.
virtual object AggregationType { get; }
Property Value
System.Object
Remarks
Description
The fleet metric description.
virtual string Description { get; }
Property Value
System.String
Remarks
IndexName
The name of the index to search.
virtual string IndexName { get; }
Property Value
System.String
Remarks
MetricName
The name of the fleet metric to create.
string MetricName { get; }
Property Value
System.String
Remarks
Period
The time in seconds between fleet metric emissions.
virtual Nullable<double> Period { get; }
Property Value
System.Nullable<System.Double>
Remarks
Range [60(1 min), 86400(1 day)] and must be multiple of 60.
QueryString
The search query string.
virtual string QueryString { get; }
Property Value
System.String
Remarks
QueryVersion
The query version.
virtual string QueryVersion { get; }
Property Value
System.String
Remarks
Tags
Metadata which can be used to manage the fleet metric.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
Unit
Used to support unit transformation such as milliseconds to seconds.
virtual string Unit { get; }
Property Value
System.String
Remarks
Must be a unit supported by CW metric. Default to null.