Package software.amazon.awscdk.services.iot

Class CfnFleetMetric

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iot.CfnFleetMetric
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.544Z") @Stability(Stable) public class CfnFleetMetric extends CfnResource implements IInspectable
A CloudFormation AWS::IoT::FleetMetric.

Use the AWS::IoT::FleetMetric resource to declare a fleet metric.

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.*;
 CfnFleetMetric cfnFleetMetric = CfnFleetMetric.Builder.create(this, "MyCfnFleetMetric")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFleetMetric

      protected CfnFleetMetric(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFleetMetric

      protected CfnFleetMetric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFleetMetric

      @Stability(Stable) public CfnFleetMetric(@NotNull Construct scope, @NotNull String id, @NotNull CfnFleetMetricProps props)
      Create a new AWS::IoT::FleetMetric.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreationDate

      @Stability(Stable) @NotNull public IResolvable getAttrCreationDate()
      The time the fleet metric was created.

    • getAttrLastModifiedDate

      @Stability(Stable) @NotNull public IResolvable getAttrLastModifiedDate()
      The time the fleet metric was last modified.

    • getAttrMetricArn

      @Stability(Stable) @NotNull public String getAttrMetricArn()
      The Amazon Resource Name (ARN) of the fleet metric.

    • getAttrVersion

      @Stability(Stable) @NotNull public IResolvable getAttrVersion()
      The fleet metric version.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata which can be used to manage the fleet metric.

    • getMetricName

      @Stability(Stable) @NotNull public String getMetricName()
      The name of the fleet metric to create.

    • setMetricName

      @Stability(Stable) public void setMetricName(@NotNull String value)
      The name of the fleet metric to create.

    • getAggregationField

      @Stability(Stable) @Nullable public String getAggregationField()
      The field to aggregate.

    • setAggregationField

      @Stability(Stable) public void setAggregationField(@Nullable String value)
      The field to aggregate.

    • getAggregationType

      @Stability(Stable) @Nullable public Object getAggregationType()
      The type of the aggregation query.

    • setAggregationType

      @Stability(Stable) public void setAggregationType(@Nullable IResolvable value)
      The type of the aggregation query.

    • setAggregationType

      @Stability(Stable) public void setAggregationType(@Nullable CfnFleetMetric.AggregationTypeProperty value)
      The type of the aggregation query.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The fleet metric description.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The fleet metric description.

    • getIndexName

      @Stability(Stable) @Nullable public String getIndexName()
      The name of the index to search.

    • setIndexName

      @Stability(Stable) public void setIndexName(@Nullable String value)
      The name of the index to search.

    • getPeriod

      @Stability(Stable) @Nullable public Number getPeriod()
      The time in seconds between fleet metric emissions.

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

    • setPeriod

      @Stability(Stable) public void setPeriod(@Nullable Number value)
      The time in seconds between fleet metric emissions.

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

    • getQueryString

      @Stability(Stable) @Nullable public String getQueryString()
      The search query string.

    • setQueryString

      @Stability(Stable) public void setQueryString(@Nullable String value)
      The search query string.

    • getQueryVersion

      @Stability(Stable) @Nullable public String getQueryVersion()
      The query version.

    • setQueryVersion

      @Stability(Stable) public void setQueryVersion(@Nullable String value)
      The query version.

    • getUnit

      @Stability(Stable) @Nullable public String getUnit()
      Used to support unit transformation such as milliseconds to seconds.

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

    • setUnit

      @Stability(Stable) public void setUnit(@Nullable String value)
      Used to support unit transformation such as milliseconds to seconds.

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