software.amazon.awscdk.services.iot

Class CfnFleetMetric

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnFleetMetric

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.857Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnFleetMetric.AggregationTypeProperty The type of aggregation queries.
static class	CfnFleetMetric.Builder A fluent builder for CfnFleetMetric.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnFleetMetric(software.constructs.Construct scope, String id, CfnFleetMetricProps props) Create a new `AWS::IoT::FleetMetric`.
protected	CfnFleetMetric(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFleetMetric(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAggregationField() The field to aggregate.
Object	getAggregationType() The type of the aggregation query.
IResolvable	getAttrCreationDate() The time the fleet metric was created.
IResolvable	getAttrLastModifiedDate() The time the fleet metric was last modified.
String	getAttrMetricArn() The Amazon Resource Name (ARN) of the fleet metric.
IResolvable	getAttrVersion() The fleet metric version.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The fleet metric description.
String	getIndexName() The name of the index to search.
String	getMetricName() The name of the fleet metric to create.
Number	getPeriod() The time in seconds between fleet metric emissions.
String	getQueryString() The search query string.
String	getQueryVersion() The query version.
TagManager	getTags() Metadata which can be used to manage the fleet metric.
String	getUnit() Used to support unit transformation such as milliseconds to seconds.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAggregationField(String value) The field to aggregate.
void	setAggregationType(CfnFleetMetric.AggregationTypeProperty value) The type of the aggregation query.
void	setAggregationType(IResolvable value) The type of the aggregation query.
void	setDescription(String value) The fleet metric description.
void	setIndexName(String value) The name of the index to search.
void	setMetricName(String value) The name of the fleet metric to create.
void	setPeriod(Number value) The time in seconds between fleet metric emissions.
void	setQueryString(String value) The search query string.
void	setQueryVersion(String value) The query version.
void	setUnit(String value) Used to support unit transformation such as milliseconds to seconds.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnFleetMetric

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

CfnFleetMetric

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

CfnFleetMetric

@Stability(value=Stable)
public CfnFleetMetric(@NotNull
                                               software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public IResolvable getAttrCreationDate()

The time the fleet metric was created.

getAttrLastModifiedDate

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrLastModifiedDate()

The time the fleet metric was last modified.

getAttrMetricArn

@Stability(value=Stable)
 @NotNull
public String getAttrMetricArn()

The Amazon Resource Name (ARN) of the fleet metric.

getAttrVersion

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrVersion()

The fleet metric version.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Metadata which can be used to manage the fleet metric.

getMetricName

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

The name of the fleet metric to create.

setMetricName

@Stability(value=Stable)
public void setMetricName(@NotNull
                                                   String value)

The name of the fleet metric to create.

getAggregationField

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

The field to aggregate.

setAggregationField

@Stability(value=Stable)
public void setAggregationField(@Nullable
                                                         String value)

The field to aggregate.

getAggregationType

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

The type of the aggregation query.

setAggregationType

@Stability(value=Stable)
public void setAggregationType(@Nullable
                                                        CfnFleetMetric.AggregationTypeProperty value)

The type of the aggregation query.

setAggregationType

@Stability(value=Stable)
public void setAggregationType(@Nullable
                                                        IResolvable value)

The type of the aggregation query.

getDescription

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

The fleet metric description.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The fleet metric description.

getIndexName

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

The name of the index to search.

setIndexName

@Stability(value=Stable)
public void setIndexName(@Nullable
                                                  String value)

The name of the index to search.

getPeriod

@Stability(value=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(value=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(value=Stable)
 @Nullable
public String getQueryString()

The search query string.

setQueryString

@Stability(value=Stable)
public void setQueryString(@Nullable
                                                    String value)

The search query string.

getQueryVersion

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

The query version.

setQueryVersion

@Stability(value=Stable)
public void setQueryVersion(@Nullable
                                                     String value)

The query version.

getUnit

@Stability(value=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(value=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.