Class CfnFleetMetric
A CloudFormation AWS::IoT::FleetMetric
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public class CfnFleetMetric : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnFleetMetric
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Use the AWS::IoT::FleetMetric
resource to declare a fleet metric.
CloudformationResource: AWS::IoT::FleetMetric
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-fleetmetric.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnFleetMetric = new CfnFleetMetric(this, "MyCfnFleetMetric", new CfnFleetMetricProps {
MetricName = "metricName",
// the properties below are optional
AggregationField = "aggregationField",
AggregationType = new AggregationTypeProperty {
Name = "name",
Values = new [] { "values" }
},
Description = "description",
IndexName = "indexName",
Period = 123,
QueryString = "queryString",
QueryVersion = "queryVersion",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Unit = "unit"
});
Synopsis
Constructors
CfnFleetMetric(Construct, String, ICfnFleetMetricProps) | Create a new |
CfnFleetMetric(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFleetMetric(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AggregationField | The field to aggregate. |
AggregationType | The type of the aggregation query. |
AttrCreationDate | The time the fleet metric was created. |
AttrLastModifiedDate | The time the fleet metric was last modified. |
AttrMetricArn | The Amazon Resource Name (ARN) of the fleet metric. |
AttrVersion | The fleet metric version. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The fleet metric description. |
IndexName | The name of the index to search. |
MetricName | The name of the fleet metric to create. |
Period | The time in seconds between fleet metric emissions. |
QueryString | The search query string. |
QueryVersion | The query version. |
Tags | Metadata which can be used to manage the fleet metric. |
Unit | Used to support unit transformation such as milliseconds to seconds. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFleetMetric(Construct, String, ICfnFleetMetricProps)
Create a new AWS::IoT::FleetMetric
.
public CfnFleetMetric(Construct scope, string id, ICfnFleetMetricProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnFleetMetricProps
- resource properties.
CfnFleetMetric(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFleetMetric(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFleetMetric(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFleetMetric(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AggregationField
The field to aggregate.
public virtual string AggregationField { get; set; }
Property Value
System.String
Remarks
AggregationType
The type of the aggregation query.
public virtual object AggregationType { get; set; }
Property Value
System.Object
Remarks
AttrCreationDate
The time the fleet metric was created.
public virtual IResolvable AttrCreationDate { get; }
Property Value
Remarks
CloudformationAttribute: CreationDate
AttrLastModifiedDate
The time the fleet metric was last modified.
public virtual IResolvable AttrLastModifiedDate { get; }
Property Value
Remarks
CloudformationAttribute: LastModifiedDate
AttrMetricArn
The Amazon Resource Name (ARN) of the fleet metric.
public virtual string AttrMetricArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: MetricArn
AttrVersion
The fleet metric version.
public virtual IResolvable AttrVersion { get; }
Property Value
Remarks
CloudformationAttribute: Version
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The fleet metric description.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
IndexName
The name of the index to search.
public virtual string IndexName { get; set; }
Property Value
System.String
Remarks
MetricName
The name of the fleet metric to create.
public virtual string MetricName { get; set; }
Property Value
System.String
Remarks
Period
The time in seconds between fleet metric emissions.
public virtual Nullable<double> Period { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Range [60(1 min), 86400(1 day)] and must be multiple of 60.
QueryString
The search query string.
public virtual string QueryString { get; set; }
Property Value
System.String
Remarks
QueryVersion
The query version.
public virtual string QueryVersion { get; set; }
Property Value
System.String
Remarks
Tags
Metadata which can be used to manage the fleet metric.
public virtual TagManager Tags { get; }
Property Value
Remarks
Unit
Used to support unit transformation such as milliseconds to seconds.
public virtual string Unit { get; set; }
Property Value
System.String
Remarks
Must be a unit supported by CW metric. Default to null.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>