@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
167 lines (166 loc) • 7.71 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* import * as grafana from "@pulumiverse/grafana";
*
* const test = grafana.cloud.getStack({
* slug: "gcloudstacktest",
* });
* const testGetRole = aws.iam.getRole({
* name: "my-role",
* });
* const testAwsAccount = new grafana.cloudprovider.AwsAccount("test", {
* stackId: test.then(test => test.id),
* roleArn: testGetRole.then(testGetRole => testGetRole.arn),
* regions: [
* "us-east-1",
* "us-east-2",
* "us-west-1",
* ],
* });
* const testAwsResourceMetadataScrapeJob = new grafana.cloudprovider.AwsResourceMetadataScrapeJob("test", {
* stackId: test.then(test => test.id),
* name: "my-aws-resource-metadata-scrape-job",
* awsAccountResourceId: testAwsAccount.resourceId,
* services: [{
* name: "AWS/EC2",
* scrapeIntervalSeconds: 300,
* resourceDiscoveryTagFilters: [{
* key: "k8s.io/cluster-autoscaler/enabled",
* value: "true",
* }],
* }],
* staticLabels: {
* label1: "value1",
* label2: "value2",
* },
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import grafana:cloudProvider/awsResourceMetadataScrapeJob:AwsResourceMetadataScrapeJob name "{{ stack_id }}:{{ name }}"
* ```
*/
export declare class AwsResourceMetadataScrapeJob extends pulumi.CustomResource {
/**
* Get an existing AwsResourceMetadataScrapeJob 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?: AwsResourceMetadataScrapeJobState, opts?: pulumi.CustomResourceOptions): AwsResourceMetadataScrapeJob;
/**
* Returns true if the given object is an instance of AwsResourceMetadataScrapeJob. 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 AwsResourceMetadataScrapeJob;
/**
* The ID assigned by the Grafana Cloud Provider API to an AWS Account resource that should be associated with this Resource Metadata Scrape Job. This can be provided by the `resourceId` attribute of the `grafana.cloudProvider.AwsAccount` resource.
*/
readonly awsAccountResourceId: pulumi.Output<string>;
/**
* When the AWS Resource Metadata Scrape Job is disabled, this will show the reason that it is in that state.
*/
readonly disabledReason: pulumi.Output<string>;
/**
* Whether the AWS Resource Metadata Scrape Job is enabled or not. Defaults to `true`.
*/
readonly enabled: pulumi.Output<boolean>;
readonly name: pulumi.Output<string>;
/**
* A subset of the regions that are configured in the associated AWS Account resource to apply to this scrape job. If not set or empty, all of the Account resource's regions are scraped.
*/
readonly regionsSubsetOverrides: pulumi.Output<string[]>;
/**
* One or more configuration blocks to configure AWS services for the Resource Metadata Scrape Job to scrape. Each block must have a distinct `name` attribute. When accessing this as an attribute reference, it is a list of objects.
*/
readonly services: pulumi.Output<outputs.cloudProvider.AwsResourceMetadataScrapeJobService[] | undefined>;
readonly stackId: pulumi.Output<string>;
/**
* A set of static labels to add to all metrics exported by this scrape job.
*/
readonly staticLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a AwsResourceMetadataScrapeJob 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: AwsResourceMetadataScrapeJobArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AwsResourceMetadataScrapeJob resources.
*/
export interface AwsResourceMetadataScrapeJobState {
/**
* The ID assigned by the Grafana Cloud Provider API to an AWS Account resource that should be associated with this Resource Metadata Scrape Job. This can be provided by the `resourceId` attribute of the `grafana.cloudProvider.AwsAccount` resource.
*/
awsAccountResourceId?: pulumi.Input<string>;
/**
* When the AWS Resource Metadata Scrape Job is disabled, this will show the reason that it is in that state.
*/
disabledReason?: pulumi.Input<string>;
/**
* Whether the AWS Resource Metadata Scrape Job is enabled or not. Defaults to `true`.
*/
enabled?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
/**
* A subset of the regions that are configured in the associated AWS Account resource to apply to this scrape job. If not set or empty, all of the Account resource's regions are scraped.
*/
regionsSubsetOverrides?: pulumi.Input<pulumi.Input<string>[]>;
/**
* One or more configuration blocks to configure AWS services for the Resource Metadata Scrape Job to scrape. Each block must have a distinct `name` attribute. When accessing this as an attribute reference, it is a list of objects.
*/
services?: pulumi.Input<pulumi.Input<inputs.cloudProvider.AwsResourceMetadataScrapeJobService>[]>;
stackId?: pulumi.Input<string>;
/**
* A set of static labels to add to all metrics exported by this scrape job.
*/
staticLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a AwsResourceMetadataScrapeJob resource.
*/
export interface AwsResourceMetadataScrapeJobArgs {
/**
* The ID assigned by the Grafana Cloud Provider API to an AWS Account resource that should be associated with this Resource Metadata Scrape Job. This can be provided by the `resourceId` attribute of the `grafana.cloudProvider.AwsAccount` resource.
*/
awsAccountResourceId: pulumi.Input<string>;
/**
* Whether the AWS Resource Metadata Scrape Job is enabled or not. Defaults to `true`.
*/
enabled?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
/**
* A subset of the regions that are configured in the associated AWS Account resource to apply to this scrape job. If not set or empty, all of the Account resource's regions are scraped.
*/
regionsSubsetOverrides?: pulumi.Input<pulumi.Input<string>[]>;
/**
* One or more configuration blocks to configure AWS services for the Resource Metadata Scrape Job to scrape. Each block must have a distinct `name` attribute. When accessing this as an attribute reference, it is a list of objects.
*/
services?: pulumi.Input<pulumi.Input<inputs.cloudProvider.AwsResourceMetadataScrapeJobService>[]>;
stackId: pulumi.Input<string>;
/**
* A set of static labels to add to all metrics exported by this scrape job.
*/
staticLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}