@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
143 lines (142 loc) • 5.81 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a single permission item for a service account. Conflicts with the "grafana.oss.ServiceAccountPermission" resource which manages the entire set of permissions for a service account.
* * [Official documentation](https://grafana.com/docs/grafana/latest/administration/service-accounts/#manage-users-and-teams-permissions-for-a-service-account-in-grafana)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const test = new grafana.oss.ServiceAccount("test", {
* name: "terraform-sa",
* role: "Editor",
* isDisabled: false,
* });
* const team = new grafana.oss.Team("team", {name: "Team Name"});
* const user = new grafana.oss.User("user", {
* email: "user.name@example.com",
* login: "user.name",
* password: "my-password",
* });
* const onTeam = new grafana.oss.ServiceAccountPermissionItem("on_team", {
* serviceAccountId: test.id,
* team: team.id,
* permission: "Admin",
* });
* const onUser = new grafana.oss.ServiceAccountPermissionItem("on_user", {
* serviceAccountId: test.id,
* user: user.id,
* permission: "Admin",
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import grafana:index/serviceAccountPermissionItem:ServiceAccountPermissionItem name "{{ serviceAccountID }}:{{ type (role, team, or user) }}:{{ identifier }}"
* ```
*
* ```sh
* $ pulumi import grafana:index/serviceAccountPermissionItem:ServiceAccountPermissionItem name "{{ orgID }}:{{ serviceAccountID }}:{{ type (role, team, or user) }}:{{ identifier }}"
* ```
*
* @deprecated grafana.index/serviceaccountpermissionitem.ServiceAccountPermissionItem has been deprecated in favor of grafana.oss/serviceaccountpermissionitem.ServiceAccountPermissionItem
*/
export declare class ServiceAccountPermissionItem extends pulumi.CustomResource {
/**
* Get an existing ServiceAccountPermissionItem 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?: ServiceAccountPermissionItemState, opts?: pulumi.CustomResourceOptions): ServiceAccountPermissionItem;
/**
* Returns true if the given object is an instance of ServiceAccountPermissionItem. 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 ServiceAccountPermissionItem;
/**
* The Organization ID. If not set, the default organization is used for basic authentication, or the one that owns your service account for token authentication.
*/
readonly orgId: pulumi.Output<string>;
/**
* the permission to be assigned
*/
readonly permission: pulumi.Output<string>;
/**
* The ID of the service account.
*/
readonly serviceAccountId: pulumi.Output<string>;
/**
* the team onto which the permission is to be assigned
*/
readonly team: pulumi.Output<string | undefined>;
/**
* the user or service account onto which the permission is to be assigned
*/
readonly user: pulumi.Output<string | undefined>;
/**
* Create a ServiceAccountPermissionItem 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.
*/
/** @deprecated grafana.index/serviceaccountpermissionitem.ServiceAccountPermissionItem has been deprecated in favor of grafana.oss/serviceaccountpermissionitem.ServiceAccountPermissionItem */
constructor(name: string, args: ServiceAccountPermissionItemArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServiceAccountPermissionItem resources.
*/
export interface ServiceAccountPermissionItemState {
/**
* The Organization ID. If not set, the default organization is used for basic authentication, or the one that owns your service account for token authentication.
*/
orgId?: pulumi.Input<string>;
/**
* the permission to be assigned
*/
permission?: pulumi.Input<string>;
/**
* The ID of the service account.
*/
serviceAccountId?: pulumi.Input<string>;
/**
* the team onto which the permission is to be assigned
*/
team?: pulumi.Input<string>;
/**
* the user or service account onto which the permission is to be assigned
*/
user?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ServiceAccountPermissionItem resource.
*/
export interface ServiceAccountPermissionItemArgs {
/**
* The Organization ID. If not set, the default organization is used for basic authentication, or the one that owns your service account for token authentication.
*/
orgId?: pulumi.Input<string>;
/**
* the permission to be assigned
*/
permission: pulumi.Input<string>;
/**
* The ID of the service account.
*/
serviceAccountId: pulumi.Input<string>;
/**
* the team onto which the permission is to be assigned
*/
team?: pulumi.Input<string>;
/**
* the user or service account onto which the permission is to be assigned
*/
user?: pulumi.Input<string>;
}