UNPKG

@pulumiverse/grafana

Version:

A Pulumi package for creating and managing grafana.

149 lines (148 loc) 6.28 kB
import * as pulumi from "@pulumi/pulumi"; /** * * [Official documentation](https://grafana.com/docs/grafana-cloud/connect-externally-hosted/private-data-source-connect/) * * [API documentation](https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#create-an-access-policy) * * Required access policy scopes: * * * accesspolicies:read * * accesspolicies:write * * accesspolicies:delete * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as grafana from "@pulumi/grafana"; * import * as grafana from "@pulumiverse/grafana"; * * const current = grafana.cloud.getStack({ * slug: "<your slug>", * }); * const test = new grafana.cloud.PrivateDataSourceConnectNetwork("test", { * region: "prod-us-east-0", * name: "my-pdc", * displayName: "My PDC", * stackIdentifier: current.then(current => current.id), * }); * const testPrivateDataSourceConnectNetworkToken = new grafana.cloud.PrivateDataSourceConnectNetworkToken("test", { * pdcNetworkId: test.pdcNetworkId, * region: test.region, * name: "my-pdc-token", * displayName: "My PDC Token", * }); * ``` * * ## Import * * ```sh * $ pulumi import grafana:cloud/privateDataSourceConnectNetwork:PrivateDataSourceConnectNetwork name "{{ region }}:{{ policyId }}" * ``` */ export declare class PrivateDataSourceConnectNetwork extends pulumi.CustomResource { /** * Get an existing PrivateDataSourceConnectNetwork 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?: PrivateDataSourceConnectNetworkState, opts?: pulumi.CustomResourceOptions): PrivateDataSourceConnectNetwork; /** * Returns true if the given object is an instance of PrivateDataSourceConnectNetwork. 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 PrivateDataSourceConnectNetwork; /** * Creation date of the private data source connect network. */ readonly createdAt: pulumi.Output<string>; /** * Display name of the PDC network. Defaults to the name. */ readonly displayName: pulumi.Output<string | undefined>; /** * Name of the PDC network.**Note:** The name must be lowercase and can contain hyphens or underscores. See full requirements here: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#request-body */ readonly name: pulumi.Output<string>; /** * ID of the private data source connect network. */ readonly pdcNetworkId: pulumi.Output<string>; /** * The region where your stack is deployed. Use the instances list API to get the region for your instance - use the regionSlug property: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-stacks */ readonly region: pulumi.Output<string>; /** * The identifier of the stack. */ readonly stackIdentifier: pulumi.Output<string>; /** * Last update date of the private data source connect network. */ readonly updatedAt: pulumi.Output<string>; /** * Create a PrivateDataSourceConnectNetwork 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: PrivateDataSourceConnectNetworkArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering PrivateDataSourceConnectNetwork resources. */ export interface PrivateDataSourceConnectNetworkState { /** * Creation date of the private data source connect network. */ createdAt?: pulumi.Input<string>; /** * Display name of the PDC network. Defaults to the name. */ displayName?: pulumi.Input<string>; /** * Name of the PDC network.**Note:** The name must be lowercase and can contain hyphens or underscores. See full requirements here: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#request-body */ name?: pulumi.Input<string>; /** * ID of the private data source connect network. */ pdcNetworkId?: pulumi.Input<string>; /** * The region where your stack is deployed. Use the instances list API to get the region for your instance - use the regionSlug property: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-stacks */ region?: pulumi.Input<string>; /** * The identifier of the stack. */ stackIdentifier?: pulumi.Input<string>; /** * Last update date of the private data source connect network. */ updatedAt?: pulumi.Input<string>; } /** * The set of arguments for constructing a PrivateDataSourceConnectNetwork resource. */ export interface PrivateDataSourceConnectNetworkArgs { /** * Display name of the PDC network. Defaults to the name. */ displayName?: pulumi.Input<string>; /** * Name of the PDC network.**Note:** The name must be lowercase and can contain hyphens or underscores. See full requirements here: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#request-body */ name?: pulumi.Input<string>; /** * The region where your stack is deployed. Use the instances list API to get the region for your instance - use the regionSlug property: https://grafana.com/docs/grafana-cloud/developer-resources/api-reference/cloud-api/#list-stacks */ region: pulumi.Input<string>; /** * The identifier of the stack. */ stackIdentifier: pulumi.Input<string>; }