software.amazon.awscdk.services.iot

Interface CfnFleetMetricProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleetMetricProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.966Z")
 @Stability(value=Stable)
public interface CfnFleetMetricProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::IoT::FleetMetric`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFleetMetricProps.Builder A builder for CfnFleetMetricProps
static class	CfnFleetMetricProps.Jsii$Proxy An implementation for CfnFleetMetricProps

Method Summary

Modifier and Type	Method and Description
static CfnFleetMetricProps.Builder	builder()
default String	getAggregationField() `AWS::IoT::FleetMetric.AggregationField`.
default Object	getAggregationType() `AWS::IoT::FleetMetric.AggregationType`.
default String	getDescription() `AWS::IoT::FleetMetric.Description`.
default String	getIndexName() `AWS::IoT::FleetMetric.IndexName`.
String	getMetricName() `AWS::IoT::FleetMetric.MetricName`.
default Number	getPeriod() `AWS::IoT::FleetMetric.Period`.
default String	getQueryString() `AWS::IoT::FleetMetric.QueryString`.
default String	getQueryVersion() `AWS::IoT::FleetMetric.QueryVersion`.
default List<CfnTag>	getTags() `AWS::IoT::FleetMetric.Tags`.
default String	getUnit() `AWS::IoT::FleetMetric.Unit`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAggregationField

@Stability(value=Stable)
 @Nullable
default String getAggregationField()

`AWS::IoT::FleetMetric.AggregationField`.

getAggregationType

@Stability(value=Stable)
 @Nullable
default Object getAggregationType()

`AWS::IoT::FleetMetric.AggregationType`.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

`AWS::IoT::FleetMetric.Description`.

getIndexName

@Stability(value=Stable)
 @Nullable
default String getIndexName()

`AWS::IoT::FleetMetric.IndexName`.

getMetricName

@Stability(value=Stable)
 @NotNull
String getMetricName()

`AWS::IoT::FleetMetric.MetricName`.

getPeriod

@Stability(value=Stable)
 @Nullable
default Number getPeriod()

`AWS::IoT::FleetMetric.Period`.

getQueryString

@Stability(value=Stable)
 @Nullable
default String getQueryString()

`AWS::IoT::FleetMetric.QueryString`.

getQueryVersion

@Stability(value=Stable)
 @Nullable
default String getQueryVersion()

`AWS::IoT::FleetMetric.QueryVersion`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::IoT::FleetMetric.Tags`.

getUnit

@Stability(value=Stable)
 @Nullable
default String getUnit()

`AWS::IoT::FleetMetric.Unit`.

builder

@Stability(value=Stable)
static CfnFleetMetricProps.Builder builder()

Returns:

a CfnFleetMetricProps.Builder of CfnFleetMetricProps