software.amazon.awscdk.services.iot

Interface CfnFleetMetricProps

All Known Implementing Classes:

CfnFleetMetricProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:26.007Z")
public interface CfnFleetMetricProps

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

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 java.lang.String	getAggregationField() The field to aggregate.
default java.lang.Object	getAggregationType() The type of the aggregation query.
default java.lang.String	getDescription() The fleet metric description.
default java.lang.String	getIndexName() The name of the index to search.
java.lang.String	getMetricName() The name of the fleet metric to create.
default java.lang.Number	getPeriod() The time in seconds between fleet metric emissions.
default java.lang.String	getQueryString() The search query string.
default java.lang.String	getQueryVersion() The query version.
default java.util.List<CfnTag>	getTags() Metadata which can be used to manage the fleet metric.
default java.lang.String	getUnit() Used to support unit transformation such as milliseconds to seconds.

Method Detail

getMetricName

java.lang.String getMetricName()

The name of the fleet metric to create.

getAggregationField

default java.lang.String getAggregationField()

The field to aggregate.

getAggregationType

default java.lang.Object getAggregationType()

The type of the aggregation query.

getDescription

default java.lang.String getDescription()

The fleet metric description.

getIndexName

default java.lang.String getIndexName()

The name of the index to search.

getPeriod

default java.lang.Number getPeriod()

The time in seconds between fleet metric emissions.

Range [60(1 min), 86400(1 day)] and must be multiple of 60.

getQueryString

default java.lang.String getQueryString()

The search query string.

getQueryVersion

default java.lang.String getQueryVersion()

The query version.

getTags

default java.util.List<CfnTag> getTags()

Metadata which can be used to manage the fleet metric.

getUnit

default java.lang.String getUnit()

Used to support unit transformation such as milliseconds to seconds.

Must be a unit supported by CW metric. Default to null.

builder

static CfnFleetMetricProps.Builder builder()

Returns:

a CfnFleetMetricProps.Builder of CfnFleetMetricProps