Interface CfnFleetMetricProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFleetMetricProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-04T00:39:33.489Z")
@Stability(Stable)
public interface CfnFleetMetricProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnFleetMetric
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.iot.*; CfnFleetMetricProps cfnFleetMetricProps = CfnFleetMetricProps.builder() .metricName("metricName") // the properties below are optional .aggregationField("aggregationField") .aggregationType(AggregationTypeProperty.builder() .name("name") .values(List.of("values")) .build()) .description("description") .indexName("indexName") .period(123) .queryString("queryString") .queryVersion("queryVersion") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .unit("unit") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnFleetMetricProps
static final class
An implementation forCfnFleetMetricProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnFleetMetricProps.Builder
builder()
default String
The field to aggregate.default Object
The type of the aggregation query.default String
The fleet metric description.default String
The name of the index to search.The name of the fleet metric to create.default Number
The time in seconds between fleet metric emissions.default String
The search query string.default String
The query version.getTags()
Metadata which can be used to manage the fleet metric.default String
getUnit()
Used to support unit transformation such as milliseconds to seconds.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getMetricName
The name of the fleet metric to create.- See Also:
-
getAggregationField
The field to aggregate.- See Also:
-
getAggregationType
The type of the aggregation query.- See Also:
-
getDescription
The fleet metric description.- See Also:
-
getIndexName
The name of the index to search.- See Also:
-
getPeriod
The time in seconds between fleet metric emissions.Range [60(1 min), 86400(1 day)] and must be multiple of 60.
- See Also:
-
getQueryString
The search query string.- See Also:
-
getQueryVersion
The query version.- See Also:
-
getTags
Metadata which can be used to manage the fleet metric.- See Also:
-
getUnit
Used to support unit transformation such as milliseconds to seconds.Must be a unit supported by CW metric. Default to null.
- See Also:
-
builder
- Returns:
- a
CfnFleetMetricProps.Builder
ofCfnFleetMetricProps
-