@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
131 lines (130 loc) • 4.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This resource allows you to link your AWS Account to Grafana Cloud for use in creating Cloud Provider resources.
*
* See the Grafana Provider configuration docs
* for information on authentication and required access policy scopes.
*
* * [Official Grafana Cloud documentation](https://grafana.com/docs/grafana-cloud/monitor-infrastructure/monitor-cloud-provider/aws/)
*
* ## 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 testIamRole = aws.index.IamRole({
* name: "my-role",
* });
* const testAwsAccount = new grafana.cloudprovider.AwsAccount("test", {
* stackId: test.then(test => test.id),
* roleArn: testIamRole.arn,
* regions: [
* "us-east-1",
* "us-east-2",
* "us-west-1",
* ],
* });
* ```
*
* ## Import
*
* ```sh
* terraform import grafana_cloud_provider_aws_account.name "{{ stack_id }}:{{ resource_id }}"
* ```
*/
export declare class AwsAccount extends pulumi.CustomResource {
/**
* Get an existing AwsAccount 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?: AwsAccountState, opts?: pulumi.CustomResourceOptions): AwsAccount;
/**
* Returns true if the given object is an instance of AwsAccount. 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 AwsAccount;
/**
* An optional human-readable name for this AWS Account resource.
*/
readonly name: pulumi.Output<string>;
/**
* A set of regions that this AWS Account resource applies to.
*/
readonly regions: pulumi.Output<string[]>;
/**
* The ID given by the Grafana Cloud Provider API to this AWS Account resource.
*/
readonly resourceId: pulumi.Output<string>;
/**
* An IAM Role ARN string to represent with this AWS Account resource.
*/
readonly roleArn: pulumi.Output<string>;
/**
* The StackID of the Grafana Cloud instance. Part of the Terraform Resource ID.
*/
readonly stackId: pulumi.Output<string>;
/**
* Create a AwsAccount 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: AwsAccountArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AwsAccount resources.
*/
export interface AwsAccountState {
/**
* An optional human-readable name for this AWS Account resource.
*/
name?: pulumi.Input<string>;
/**
* A set of regions that this AWS Account resource applies to.
*/
regions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID given by the Grafana Cloud Provider API to this AWS Account resource.
*/
resourceId?: pulumi.Input<string>;
/**
* An IAM Role ARN string to represent with this AWS Account resource.
*/
roleArn?: pulumi.Input<string>;
/**
* The StackID of the Grafana Cloud instance. Part of the Terraform Resource ID.
*/
stackId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AwsAccount resource.
*/
export interface AwsAccountArgs {
/**
* An optional human-readable name for this AWS Account resource.
*/
name?: pulumi.Input<string>;
/**
* A set of regions that this AWS Account resource applies to.
*/
regions: pulumi.Input<pulumi.Input<string>[]>;
/**
* An IAM Role ARN string to represent with this AWS Account resource.
*/
roleArn: pulumi.Input<string>;
/**
* The StackID of the Grafana Cloud instance. Part of the Terraform Resource ID.
*/
stackId: pulumi.Input<string>;
}