We recommend new projects start with resources from the AWS provider.
aws-native.iot.FleetMetric
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
An aggregated metric of certain devices in your fleet
Create FleetMetric Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new FleetMetric(name: string, args?: FleetMetricArgs, opts?: CustomResourceOptions);
@overload
def FleetMetric(resource_name: str,
args: Optional[FleetMetricArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def FleetMetric(resource_name: str,
opts: Optional[ResourceOptions] = None,
aggregation_field: Optional[str] = None,
aggregation_type: Optional[FleetMetricAggregationTypeArgs] = None,
description: Optional[str] = None,
index_name: Optional[str] = None,
metric_name: Optional[str] = None,
period: Optional[int] = None,
query_string: Optional[str] = None,
query_version: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
unit: Optional[str] = None)
func NewFleetMetric(ctx *Context, name string, args *FleetMetricArgs, opts ...ResourceOption) (*FleetMetric, error)
public FleetMetric(string name, FleetMetricArgs? args = null, CustomResourceOptions? opts = null)
public FleetMetric(String name, FleetMetricArgs args)
public FleetMetric(String name, FleetMetricArgs args, CustomResourceOptions options)
type: aws-native:iot:FleetMetric
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FleetMetricArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FleetMetricArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FleetMetricArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FleetMetricArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FleetMetricArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
FleetMetric Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The FleetMetric resource accepts the following input properties:
- Aggregation
Field string - The aggregation field to perform aggregation and metric emission
- Aggregation
Type Pulumi.Aws Native. Io T. Inputs. Fleet Metric Aggregation Type - The type of the aggregation query.
- Description string
- The description of a fleet metric
- Index
Name string - The index name of a fleet metric
- Metric
Name string - The name of the fleet metric
- Period int
- The period of metric emission in seconds
- Query
String string - The Fleet Indexing query used by a fleet metric
- Query
Version string - The version of a Fleet Indexing query used by a fleet metric
- List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource
- Unit string
- The unit of data points emitted by a fleet metric
- Aggregation
Field string - The aggregation field to perform aggregation and metric emission
- Aggregation
Type FleetMetric Aggregation Type Args - The type of the aggregation query.
- Description string
- The description of a fleet metric
- Index
Name string - The index name of a fleet metric
- Metric
Name string - The name of the fleet metric
- Period int
- The period of metric emission in seconds
- Query
String string - The Fleet Indexing query used by a fleet metric
- Query
Version string - The version of a Fleet Indexing query used by a fleet metric
- Tag
Args - An array of key-value pairs to apply to this resource
- Unit string
- The unit of data points emitted by a fleet metric
- aggregation
Field String - The aggregation field to perform aggregation and metric emission
- aggregation
Type FleetMetric Aggregation Type - The type of the aggregation query.
- description String
- The description of a fleet metric
- index
Name String - The index name of a fleet metric
- metric
Name String - The name of the fleet metric
- period Integer
- The period of metric emission in seconds
- query
String String - The Fleet Indexing query used by a fleet metric
- query
Version String - The version of a Fleet Indexing query used by a fleet metric
- List<Tag>
- An array of key-value pairs to apply to this resource
- unit String
- The unit of data points emitted by a fleet metric
- aggregation
Field string - The aggregation field to perform aggregation and metric emission
- aggregation
Type FleetMetric Aggregation Type - The type of the aggregation query.
- description string
- The description of a fleet metric
- index
Name string - The index name of a fleet metric
- metric
Name string - The name of the fleet metric
- period number
- The period of metric emission in seconds
- query
String string - The Fleet Indexing query used by a fleet metric
- query
Version string - The version of a Fleet Indexing query used by a fleet metric
- Tag[]
- An array of key-value pairs to apply to this resource
- unit string
- The unit of data points emitted by a fleet metric
- aggregation_
field str - The aggregation field to perform aggregation and metric emission
- aggregation_
type FleetMetric Aggregation Type Args - The type of the aggregation query.
- description str
- The description of a fleet metric
- index_
name str - The index name of a fleet metric
- metric_
name str - The name of the fleet metric
- period int
- The period of metric emission in seconds
- query_
string str - The Fleet Indexing query used by a fleet metric
- query_
version str - The version of a Fleet Indexing query used by a fleet metric
- Sequence[Tag
Args] - An array of key-value pairs to apply to this resource
- unit str
- The unit of data points emitted by a fleet metric
- aggregation
Field String - The aggregation field to perform aggregation and metric emission
- aggregation
Type Property Map - The type of the aggregation query.
- description String
- The description of a fleet metric
- index
Name String - The index name of a fleet metric
- metric
Name String - The name of the fleet metric
- period Number
- The period of metric emission in seconds
- query
String String - The Fleet Indexing query used by a fleet metric
- query
Version String - The version of a Fleet Indexing query used by a fleet metric
- List<Property Map>
- An array of key-value pairs to apply to this resource
- unit String
- The unit of data points emitted by a fleet metric
Outputs
All input properties are implicitly available as output properties. Additionally, the FleetMetric resource produces the following output properties:
- Creation
Date string - The creation date of a fleet metric
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringDate - The last modified date of a fleet metric
- Metric
Arn string - The Amazon Resource Number (ARN) of a fleet metric metric
- Version double
- The version of a fleet metric
- Creation
Date string - The creation date of a fleet metric
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringDate - The last modified date of a fleet metric
- Metric
Arn string - The Amazon Resource Number (ARN) of a fleet metric metric
- Version float64
- The version of a fleet metric
- creation
Date String - The creation date of a fleet metric
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringDate - The last modified date of a fleet metric
- metric
Arn String - The Amazon Resource Number (ARN) of a fleet metric metric
- version Double
- The version of a fleet metric
- creation
Date string - The creation date of a fleet metric
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringDate - The last modified date of a fleet metric
- metric
Arn string - The Amazon Resource Number (ARN) of a fleet metric metric
- version number
- The version of a fleet metric
- creation_
date str - The creation date of a fleet metric
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strdate - The last modified date of a fleet metric
- metric_
arn str - The Amazon Resource Number (ARN) of a fleet metric metric
- version float
- The version of a fleet metric
- creation
Date String - The creation date of a fleet metric
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringDate - The last modified date of a fleet metric
- metric
Arn String - The Amazon Resource Number (ARN) of a fleet metric metric
- version Number
- The version of a fleet metric
Supporting Types
FleetMetricAggregationType, FleetMetricAggregationTypeArgs
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.