getCustomMetric

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>
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]
func LookupCustomMetric(ctx *Context, args *LookupCustomMetricArgs, opts ...InvokeOption) (*LookupCustomMetricResult, error)
func LookupCustomMetricOutput(ctx *Context, args *LookupCustomMetricOutputArgs, opts ...InvokeOption) LookupCustomMetricResultOutput

> 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)
}
public static CompletableFuture<GetCustomMetricResult> getCustomMetric(GetCustomMetricArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: aws-native:iot:getCustomMetric
  arguments:
    # arguments dictionary

The following arguments are supported:

MetricName 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 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 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 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 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 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.IoT.Outputs.CustomMetricTag>

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 []CustomMetricTag

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<CustomMetricTag>

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 CustomMetricTag[]

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[CustomMetricTag]

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

CustomMetricTag

Key string

The tag's key.

Value string

The tag's value.

Key string

The tag's key.

Value string

The tag's value.

key String

The tag's key.

value String

The tag's value.

key string

The tag's key.

value string

The tag's value.

key str

The tag's key.

value str

The tag's value.

key String

The tag's key.

value String

The tag's value.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0