Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
grafana.Folder
Explore with Pulumi AI
Create Folder Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Folder(name: string, args: FolderArgs, opts?: CustomResourceOptions);
@overload
def Folder(resource_name: str,
args: FolderArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Folder(resource_name: str,
opts: Optional[ResourceOptions] = None,
title: Optional[str] = None,
org_id: Optional[str] = None,
parent_folder_uid: Optional[str] = None,
prevent_destroy_if_not_empty: Optional[bool] = None,
uid: Optional[str] = None)
func NewFolder(ctx *Context, name string, args FolderArgs, opts ...ResourceOption) (*Folder, error)
public Folder(string name, FolderArgs args, CustomResourceOptions? opts = null)
public Folder(String name, FolderArgs args)
public Folder(String name, FolderArgs args, CustomResourceOptions options)
type: grafana:Folder
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FolderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FolderArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FolderArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FolderArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FolderArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
var folderResource = new Grafana.Folder("folderResource", new()
{
Title = "string",
OrgId = "string",
ParentFolderUid = "string",
PreventDestroyIfNotEmpty = false,
Uid = "string",
});
example, err := grafana.NewFolder(ctx, "folderResource", &grafana.FolderArgs{
Title: pulumi.String("string"),
OrgId: pulumi.String("string"),
ParentFolderUid: pulumi.String("string"),
PreventDestroyIfNotEmpty: pulumi.Bool(false),
Uid: pulumi.String("string"),
})
var folderResource = new Folder("folderResource", FolderArgs.builder()
.title("string")
.orgId("string")
.parentFolderUid("string")
.preventDestroyIfNotEmpty(false)
.uid("string")
.build());
folder_resource = grafana.Folder("folderResource",
title="string",
org_id="string",
parent_folder_uid="string",
prevent_destroy_if_not_empty=False,
uid="string")
const folderResource = new grafana.Folder("folderResource", {
title: "string",
orgId: "string",
parentFolderUid: "string",
preventDestroyIfNotEmpty: false,
uid: "string",
});
type: grafana:Folder
properties:
orgId: string
parentFolderUid: string
preventDestroyIfNotEmpty: false
title: string
uid: string
Folder Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Folder resource accepts the following input properties:
- Title string
- The title of the folder.
- Org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- Parent
Folder stringUid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- Prevent
Destroy boolIf Not Empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- Uid string
- Unique identifier.
- Title string
- The title of the folder.
- Org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- Parent
Folder stringUid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- Prevent
Destroy boolIf Not Empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- Uid string
- Unique identifier.
- title String
- The title of the folder.
- org
Id String - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- parent
Folder StringUid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- prevent
Destroy BooleanIf Not Empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- uid String
- Unique identifier.
- title string
- The title of the folder.
- org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- parent
Folder stringUid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- prevent
Destroy booleanIf Not Empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- uid string
- Unique identifier.
- title str
- The title of the folder.
- org_
id str - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- parent_
folder_ struid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- prevent_
destroy_ boolif_ not_ empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- uid str
- Unique identifier.
- title String
- The title of the folder.
- org
Id String - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- parent
Folder StringUid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- prevent
Destroy BooleanIf Not Empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- uid String
- Unique identifier.
Outputs
All input properties are implicitly available as output properties. Additionally, the Folder resource produces the following output properties:
Look up Existing Folder Resource
Get an existing Folder resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FolderState, opts?: CustomResourceOptions): Folder
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
org_id: Optional[str] = None,
parent_folder_uid: Optional[str] = None,
prevent_destroy_if_not_empty: Optional[bool] = None,
title: Optional[str] = None,
uid: Optional[str] = None,
url: Optional[str] = None) -> Folder
func GetFolder(ctx *Context, name string, id IDInput, state *FolderState, opts ...ResourceOption) (*Folder, error)
public static Folder Get(string name, Input<string> id, FolderState? state, CustomResourceOptions? opts = null)
public static Folder get(String name, Output<String> id, FolderState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- Parent
Folder stringUid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- Prevent
Destroy boolIf Not Empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- Title string
- The title of the folder.
- Uid string
- Unique identifier.
- Url string
- The full URL of the folder.
- Org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- Parent
Folder stringUid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- Prevent
Destroy boolIf Not Empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- Title string
- The title of the folder.
- Uid string
- Unique identifier.
- Url string
- The full URL of the folder.
- org
Id String - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- parent
Folder StringUid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- prevent
Destroy BooleanIf Not Empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- title String
- The title of the folder.
- uid String
- Unique identifier.
- url String
- The full URL of the folder.
- org
Id string - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- parent
Folder stringUid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- prevent
Destroy booleanIf Not Empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- title string
- The title of the folder.
- uid string
- Unique identifier.
- url string
- The full URL of the folder.
- org_
id str - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- parent_
folder_ struid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- prevent_
destroy_ boolif_ not_ empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- title str
- The title of the folder.
- uid str
- Unique identifier.
- url str
- The full URL of the folder.
- org
Id String - The Organization ID. If not set, the Org ID defined in the provider block will be used.
- parent
Folder StringUid - The uid of the parent folder. If set, the folder will be nested. If not set, the folder will be created in the root folder. Note: This requires the nestedFolders feature flag to be enabled on your Grafana instance.
- prevent
Destroy BooleanIf Not Empty - Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
- title String
- The title of the folder.
- uid String
- Unique identifier.
- url String
- The full URL of the folder.
Package Details
- Repository
- grafana pulumiverse/pulumi-grafana
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
grafana
Terraform Provider.