Package 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.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFleetMetricProps.Builder	builder()
default String	getAggregationField()	The field to aggregate.
default Object	getAggregationType()	The type of the aggregation query.
default String	getDescription()	The fleet metric description.
default String	getIndexName()	The name of the index to search.
String	getMetricName()	The name of the fleet metric to create.
default Number	getPeriod()	The time in seconds between fleet metric emissions.
default String	getQueryString()	The search query string.
default String	getQueryVersion()	The query version.
default List<CfnTag>	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

@Stability(Stable)
@NotNull
String getMetricName()

The name of the fleet metric to create.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html#cfn-iot-fleetmetric-metricname

getAggregationField

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

The field to aggregate.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html#cfn-iot-fleetmetric-aggregationfield

getAggregationType

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

The type of the aggregation query.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html#cfn-iot-fleetmetric-aggregationtype

getDescription

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

The fleet metric description.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html#cfn-iot-fleetmetric-description

getIndexName

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

The name of the index to search.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html#cfn-iot-fleetmetric-indexname

getPeriod

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

The time in seconds between fleet metric emissions.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html#cfn-iot-fleetmetric-period

getQueryString

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

The search query string.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html#cfn-iot-fleetmetric-querystring

getQueryVersion

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

The query version.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html#cfn-iot-fleetmetric-queryversion

getTags

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

Metadata which can be used to manage the fleet metric.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html#cfn-iot-fleetmetric-tags

getUnit

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

Used to support unit transformation such as milliseconds to seconds.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html#cfn-iot-fleetmetric-unit

builder

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

Returns:

a CfnFleetMetricProps.Builder of CfnFleetMetricProps