@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
113 lines (112 loc) • 3.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* **Note:** This resource is available only with Grafana Enterprise.
*
* * [Official documentation](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-scim-provisioning/)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const _default = new grafana.enterprise.ScimConfig("default", {
* enableUserSync: true,
* enableGroupSync: false,
* allowNonProvisionedUsers: false,
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import grafana:enterprise/scimConfig:ScimConfig name ""
* ```
*
* ```sh
* $ pulumi import grafana:enterprise/scimConfig:ScimConfig name "{{ orgID }}"
* ```
*/
export declare class ScimConfig extends pulumi.CustomResource {
/**
* Get an existing ScimConfig 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?: ScimConfigState, opts?: pulumi.CustomResourceOptions): ScimConfig;
/**
* Returns true if the given object is an instance of ScimConfig. 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 ScimConfig;
/**
* Whether to allow non-provisioned users to access Grafana.
*/
readonly allowNonProvisionedUsers: pulumi.Output<boolean>;
/**
* Whether group synchronization is enabled.
*/
readonly enableGroupSync: pulumi.Output<boolean>;
/**
* Whether user synchronization is enabled.
*/
readonly enableUserSync: pulumi.Output<boolean>;
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
readonly orgId: pulumi.Output<string | undefined>;
/**
* Create a ScimConfig 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: ScimConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ScimConfig resources.
*/
export interface ScimConfigState {
/**
* Whether to allow non-provisioned users to access Grafana.
*/
allowNonProvisionedUsers?: pulumi.Input<boolean>;
/**
* Whether group synchronization is enabled.
*/
enableGroupSync?: pulumi.Input<boolean>;
/**
* Whether user synchronization is enabled.
*/
enableUserSync?: pulumi.Input<boolean>;
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
orgId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ScimConfig resource.
*/
export interface ScimConfigArgs {
/**
* Whether to allow non-provisioned users to access Grafana.
*/
allowNonProvisionedUsers: pulumi.Input<boolean>;
/**
* Whether group synchronization is enabled.
*/
enableGroupSync: pulumi.Input<boolean>;
/**
* Whether user synchronization is enabled.
*/
enableUserSync: pulumi.Input<boolean>;
/**
* The Organization ID. If not set, the Org ID defined in the provider block will be used.
*/
orgId?: pulumi.Input<string>;
}