1. Packages
  2. AWS Native
  3. API Docs
  4. iot
  5. FleetMetric

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.iot.FleetMetric

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const fleetMetricResource = new aws_native.iot.FleetMetric("fleetMetricResource", {
        aggregationField: "string",
        aggregationType: {
            name: "string",
            values: ["string"],
        },
        description: "string",
        indexName: "string",
        metricName: "string",
        period: 0,
        queryString: "string",
        queryVersion: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        unit: "string",
    });
    
    Coming soon!
    

    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

    The FleetMetric resource accepts the following input properties:

    AggregationField string
    The aggregation field to perform aggregation and metric emission
    AggregationType Pulumi.AwsNative.IoT.Inputs.FleetMetricAggregationType
    The type of the aggregation query.
    Description string
    The description of a fleet metric
    IndexName string
    The index name of a fleet metric
    MetricName string
    The name of the fleet metric
    Period int
    The period of metric emission in seconds
    QueryString string
    The Fleet Indexing query used by a fleet metric
    QueryVersion string
    The version of a Fleet Indexing query used by a fleet metric
    Tags List<Pulumi.AwsNative.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
    AggregationField string
    The aggregation field to perform aggregation and metric emission
    AggregationType FleetMetricAggregationTypeArgs
    The type of the aggregation query.
    Description string
    The description of a fleet metric
    IndexName string
    The index name of a fleet metric
    MetricName string
    The name of the fleet metric
    Period int
    The period of metric emission in seconds
    QueryString string
    The Fleet Indexing query used by a fleet metric
    QueryVersion string
    The version of a Fleet Indexing query used by a fleet metric
    Tags TagArgs
    An array of key-value pairs to apply to this resource
    Unit string
    The unit of data points emitted by a fleet metric
    aggregationField String
    The aggregation field to perform aggregation and metric emission
    aggregationType FleetMetricAggregationType
    The type of the aggregation query.
    description String
    The description of a fleet metric
    indexName String
    The index name of a fleet metric
    metricName String
    The name of the fleet metric
    period Integer
    The period of metric emission in seconds
    queryString String
    The Fleet Indexing query used by a fleet metric
    queryVersion String
    The version of a Fleet Indexing query used by a fleet metric
    tags 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
    aggregationField string
    The aggregation field to perform aggregation and metric emission
    aggregationType FleetMetricAggregationType
    The type of the aggregation query.
    description string
    The description of a fleet metric
    indexName string
    The index name of a fleet metric
    metricName string
    The name of the fleet metric
    period number
    The period of metric emission in seconds
    queryString string
    The Fleet Indexing query used by a fleet metric
    queryVersion string
    The version of a Fleet Indexing query used by a fleet metric
    tags 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 FleetMetricAggregationTypeArgs
    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
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource
    unit str
    The unit of data points emitted by a fleet metric
    aggregationField String
    The aggregation field to perform aggregation and metric emission
    aggregationType Property Map
    The type of the aggregation query.
    description String
    The description of a fleet metric
    indexName String
    The index name of a fleet metric
    metricName String
    The name of the fleet metric
    period Number
    The period of metric emission in seconds
    queryString String
    The Fleet Indexing query used by a fleet metric
    queryVersion String
    The version of a Fleet Indexing query used by a fleet metric
    tags 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:

    CreationDate string
    The creation date of a fleet metric
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedDate string
    The last modified date of a fleet metric
    MetricArn string
    The Amazon Resource Number (ARN) of a fleet metric metric
    Version double
    The version of a fleet metric
    CreationDate string
    The creation date of a fleet metric
    Id string
    The provider-assigned unique ID for this managed resource.
    LastModifiedDate string
    The last modified date of a fleet metric
    MetricArn string
    The Amazon Resource Number (ARN) of a fleet metric metric
    Version float64
    The version of a fleet metric
    creationDate String
    The creation date of a fleet metric
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedDate String
    The last modified date of a fleet metric
    metricArn String
    The Amazon Resource Number (ARN) of a fleet metric metric
    version Double
    The version of a fleet metric
    creationDate string
    The creation date of a fleet metric
    id string
    The provider-assigned unique ID for this managed resource.
    lastModifiedDate string
    The last modified date of a fleet metric
    metricArn 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_date str
    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
    creationDate String
    The creation date of a fleet metric
    id String
    The provider-assigned unique ID for this managed resource.
    lastModifiedDate String
    The last modified date of a fleet metric
    metricArn String
    The Amazon Resource Number (ARN) of a fleet metric metric
    version Number
    The version of a fleet metric

    Supporting Types

    FleetMetricAggregationType, FleetMetricAggregationTypeArgs

    Name string
    Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
    Values List<string>
    Fleet Indexing aggregation type values
    Name string
    Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
    Values []string
    Fleet Indexing aggregation type values
    name String
    Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
    values List<String>
    Fleet Indexing aggregation type values
    name string
    Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
    values string[]
    Fleet Indexing aggregation type values
    name str
    Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
    values Sequence[str]
    Fleet Indexing aggregation type values
    name String
    Fleet Indexing aggregation type names such as Statistics, Percentiles and Cardinality
    values List<String>
    Fleet Indexing aggregation type values

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi