@lbrlabs/pulumi-grafana
Version:
A Pulumi package for creating and managing grafana.
78 lines (77 loc) • 2.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@lbrlabs/pulumi-grafana";
*
* const foo = new grafana.ApiKey("foo", {role: "Viewer"});
* const bar = new grafana.ApiKey("bar", {
* role: "Admin",
* secondsToLive: 30,
* });
* export const apiKeyFooKeyOnly = foo.key;
* export const apiKeyBar = bar;
* ```
*/
export declare class ApiKey extends pulumi.CustomResource {
/**
* Get an existing ApiKey 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?: ApiKeyState, opts?: pulumi.CustomResourceOptions): ApiKey;
/**
* Returns true if the given object is an instance of ApiKey. 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 ApiKey;
readonly expiration: pulumi.Output<string>;
readonly key: pulumi.Output<string>;
readonly name: pulumi.Output<string>;
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
readonly orgId: pulumi.Output<string | undefined>;
readonly role: pulumi.Output<string>;
readonly secondsToLive: pulumi.Output<number | undefined>;
/**
* Create a ApiKey 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: ApiKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ApiKey resources.
*/
export interface ApiKeyState {
expiration?: pulumi.Input<string>;
key?: pulumi.Input<string>;
name?: pulumi.Input<string>;
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
orgId?: pulumi.Input<string>;
role?: pulumi.Input<string>;
secondsToLive?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a ApiKey resource.
*/
export interface ApiKeyArgs {
name?: pulumi.Input<string>;
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
orgId?: pulumi.Input<string>;
role: pulumi.Input<string>;
secondsToLive?: pulumi.Input<number>;
}