Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iot
  5. getCustomMetric

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iot.getCustomMetric

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

A custom metric published by your devices to Device Defender.

Using getCustomMetric

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCustomMetric(args: GetCustomMetricArgs, opts?: InvokeOptions): Promise<GetCustomMetricResult>
function getCustomMetricOutput(args: GetCustomMetricOutputArgs, opts?: InvokeOptions): Output<GetCustomMetricResult>
Copy
def get_custom_metric(metric_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCustomMetricResult
def get_custom_metric_output(metric_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCustomMetricResult]
Copy
func LookupCustomMetric(ctx *Context, args *LookupCustomMetricArgs, opts ...InvokeOption) (*LookupCustomMetricResult, error)
func LookupCustomMetricOutput(ctx *Context, args *LookupCustomMetricOutputArgs, opts ...InvokeOption) LookupCustomMetricResultOutput
Copy

> Note: This function is named LookupCustomMetric in the Go SDK.

public static class GetCustomMetric 
{
    public static Task<GetCustomMetricResult> InvokeAsync(GetCustomMetricArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomMetricResult> Invoke(GetCustomMetricInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCustomMetricResult> getCustomMetric(GetCustomMetricArgs args, InvokeOptions options)
public static Output<GetCustomMetricResult> getCustomMetric(GetCustomMetricArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:iot:getCustomMetric
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

MetricName This property is required. string
The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
MetricName This property is required. string
The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
metricName This property is required. String
The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
metricName This property is required. string
The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
metric_name This property is required. str
The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.
metricName This property is required. String
The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws: . Cannot be updated once defined.

getCustomMetric Result

The following output properties are available:

DisplayName string
Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
MetricArn string
The Amazon Resource Number (ARN) of the custom metric.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
DisplayName string
Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
MetricArn string
The Amazon Resource Number (ARN) of the custom metric.
Tags Tag
An array of key-value pairs to apply to this resource.
displayName String
Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
metricArn String
The Amazon Resource Number (ARN) of the custom metric.
tags List<Tag>
An array of key-value pairs to apply to this resource.
displayName string
Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
metricArn string
The Amazon Resource Number (ARN) of the custom metric.
tags Tag[]
An array of key-value pairs to apply to this resource.
display_name str
Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
metric_arn str
The Amazon Resource Number (ARN) of the custom metric.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
displayName String
Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.
metricArn String
The Amazon Resource Number (ARN) of the custom metric.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

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

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native