Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
aws-native.iot.getCustomMetric
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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 dictionaryThe following arguments are supported:
- Metric
Name 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 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 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 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.
- metric
Name 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:
- Display
Name 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.
- Metric
Arn string The Amazon Resource Number (ARN) of the custom metric.
-
List<Pulumi.
Aws Native. Io T. Outputs. Custom Metric Tag> An array of key-value pairs to apply to this resource.
- Display
Name 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.
- Metric
Arn string The Amazon Resource Number (ARN) of the custom metric.
-
[]Custom
Metric Tag An array of key-value pairs to apply to this resource.
- display
Name 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.
- metric
Arn String The Amazon Resource Number (ARN) of the custom metric.
-
List<Custom
Metric Tag> An array of key-value pairs to apply to this resource.
- display
Name 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.
- metric
Arn string The Amazon Resource Number (ARN) of the custom metric.
-
Custom
Metric 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.
-
Sequence[Custom
Metric Tag] An array of key-value pairs to apply to this resource.
- display
Name 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.
- metric
Arn String The Amazon Resource Number (ARN) of the custom metric.
- List<Property Map>
An array of key-value pairs to apply to this resource.
Supporting Types
CustomMetricTag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.