@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
113 lines (112 loc) • 4.03 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages Grafana Fleet Management collectors.
*
* * [Official documentation](https://grafana.com/docs/grafana-cloud/send-data/fleet-management/)
* * [API documentation](https://grafana.com/docs/grafana-cloud/send-data/fleet-management/api-reference/collector-api/)
* * Step-by-step guide
*
* Required access policy scopes:
*
* * fleet-management:read
* * fleet-management:write
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const test = new grafana.fleetmanagement.Collector("test", {
* id: "my_collector",
* remoteAttributes: {
* env: "PROD",
* owner: "TEAM-A",
* },
* enabled: true,
* });
* ```
*
* ## Import
*
* ```sh
* terraform import grafana_fleet_management_collector.name "{{ id }}"
* ```
*/
export declare class Collector extends pulumi.CustomResource {
/**
* Get an existing Collector resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CollectorState, opts?: pulumi.CustomResourceOptions): Collector;
/**
* Returns true if the given object is an instance of Collector. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Collector;
/**
* Type of the collector. Must be one of: ALLOY, OTEL. Defaults to ALLOY if not specified.
*/
readonly collectorType: pulumi.Output<string>;
/**
* Whether remote configuration for the collector is enabled or not. If the collector is disabled, it will receive empty configurations from the Fleet Management service
*/
readonly enabled: pulumi.Output<boolean>;
/**
* Remote attributes for the collector
*/
readonly remoteAttributes: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Collector resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: CollectorArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Collector resources.
*/
export interface CollectorState {
/**
* Type of the collector. Must be one of: ALLOY, OTEL. Defaults to ALLOY if not specified.
*/
collectorType?: pulumi.Input<string>;
/**
* Whether remote configuration for the collector is enabled or not. If the collector is disabled, it will receive empty configurations from the Fleet Management service
*/
enabled?: pulumi.Input<boolean>;
/**
* Remote attributes for the collector
*/
remoteAttributes?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a Collector resource.
*/
export interface CollectorArgs {
/**
* Type of the collector. Must be one of: ALLOY, OTEL. Defaults to ALLOY if not specified.
*/
collectorType?: pulumi.Input<string>;
/**
* Whether remote configuration for the collector is enabled or not. If the collector is disabled, it will receive empty configurations from the Fleet Management service
*/
enabled?: pulumi.Input<boolean>;
/**
* Remote attributes for the collector
*/
remoteAttributes?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}