@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
60 lines (59 loc) • 2.58 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This data sources allows for obtaining a list of dimension values by on query provided.
*/
export declare function getDimensionValues(args: GetDimensionValuesArgs, opts?: pulumi.InvokeOptions): Promise<GetDimensionValuesResult>;
/**
* A collection of arguments for invoking getDimensionValues.
*/
export interface GetDimensionValuesArgs {
/**
* This allows you to define how many dimensions are returned as the values output.
*/
limit?: number;
orderBy?: string;
/**
* Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
*/
query: string;
}
/**
* A collection of values returned by getDimensionValues.
*/
export interface GetDimensionValuesResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* This allows you to define how many dimensions are returned as the values output.
*/
readonly limit?: number;
readonly orderBy?: string;
/**
* Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
*/
readonly query: string;
/**
* List of all the match dimension values that the provided query, ordered by orderBy field
*/
readonly values: string[];
}
/**
* This data sources allows for obtaining a list of dimension values by on query provided.
*/
export declare function getDimensionValuesOutput(args: GetDimensionValuesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDimensionValuesResult>;
/**
* A collection of arguments for invoking getDimensionValues.
*/
export interface GetDimensionValuesOutputArgs {
/**
* This allows you to define how many dimensions are returned as the values output.
*/
limit?: pulumi.Input<number>;
orderBy?: pulumi.Input<string>;
/**
* Acepts a query string that allows for defining a key value deintion, wild card matching on values, or where the dimension value exists. Refer to https://dev.splunk.com/observability/reference/api/metrics_metadata/latest#endpoint-retrieve-dimensions-query for more details
*/
query: pulumi.Input<string>;
}