1. Packages
  2. Coralogix Provider
  3. API Docs
  4. GrafanaFolder
coralogix 2.0.16 published on Monday, Apr 14, 2025 by coralogix

coralogix.GrafanaFolder

Explore with Pulumi AI

Create GrafanaFolder Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GrafanaFolder(name: string, args: GrafanaFolderArgs, opts?: CustomResourceOptions);
@overload
def GrafanaFolder(resource_name: str,
                  args: GrafanaFolderArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def GrafanaFolder(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  title: Optional[str] = None,
                  grafana_folder_id: Optional[str] = None,
                  prevent_destroy_if_not_empty: Optional[bool] = None,
                  uid: Optional[str] = None)
func NewGrafanaFolder(ctx *Context, name string, args GrafanaFolderArgs, opts ...ResourceOption) (*GrafanaFolder, error)
public GrafanaFolder(string name, GrafanaFolderArgs args, CustomResourceOptions? opts = null)
public GrafanaFolder(String name, GrafanaFolderArgs args)
public GrafanaFolder(String name, GrafanaFolderArgs args, CustomResourceOptions options)
type: coralogix:GrafanaFolder
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GrafanaFolderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GrafanaFolderArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GrafanaFolderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GrafanaFolderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GrafanaFolderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var grafanaFolderResource = new Coralogix.GrafanaFolder("grafanaFolderResource", new()
{
    Title = "string",
    GrafanaFolderId = "string",
    PreventDestroyIfNotEmpty = false,
    Uid = "string",
});
Copy
example, err := coralogix.NewGrafanaFolder(ctx, "grafanaFolderResource", &coralogix.GrafanaFolderArgs{
Title: pulumi.String("string"),
GrafanaFolderId: pulumi.String("string"),
PreventDestroyIfNotEmpty: pulumi.Bool(false),
Uid: pulumi.String("string"),
})
Copy
var grafanaFolderResource = new GrafanaFolder("grafanaFolderResource", GrafanaFolderArgs.builder()
    .title("string")
    .grafanaFolderId("string")
    .preventDestroyIfNotEmpty(false)
    .uid("string")
    .build());
Copy
grafana_folder_resource = coralogix.GrafanaFolder("grafanaFolderResource",
    title="string",
    grafana_folder_id="string",
    prevent_destroy_if_not_empty=False,
    uid="string")
Copy
const grafanaFolderResource = new coralogix.GrafanaFolder("grafanaFolderResource", {
    title: "string",
    grafanaFolderId: "string",
    preventDestroyIfNotEmpty: false,
    uid: "string",
});
Copy
type: coralogix:GrafanaFolder
properties:
    grafanaFolderId: string
    preventDestroyIfNotEmpty: false
    title: string
    uid: string
Copy

GrafanaFolder Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GrafanaFolder resource accepts the following input properties:

Title This property is required. string
The title of the folder.
GrafanaFolderId string
The ID of this resource.
PreventDestroyIfNotEmpty bool
Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
Uid string
Unique identifier.
Title This property is required. string
The title of the folder.
GrafanaFolderId string
The ID of this resource.
PreventDestroyIfNotEmpty bool
Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
Uid string
Unique identifier.
title This property is required. String
The title of the folder.
grafanaFolderId String
The ID of this resource.
preventDestroyIfNotEmpty Boolean
Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
uid String
Unique identifier.
title This property is required. string
The title of the folder.
grafanaFolderId string
The ID of this resource.
preventDestroyIfNotEmpty boolean
Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
uid string
Unique identifier.
title This property is required. str
The title of the folder.
grafana_folder_id str
The ID of this resource.
prevent_destroy_if_not_empty bool
Prevent deletion of the folder if it is not empty (contains dashboards or alert rules).
uid str
Unique identifier.
title This property is required. String
The title of the folder.
grafanaFolderId String
The ID of this resource.
preventDestroyIfNotEmpty Boolean
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 GrafanaFolder resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Url string
The full URL of the folder.
Id string
The provider-assigned unique ID for this managed resource.
Url string
The full URL of the folder.
id String
The provider-assigned unique ID for this managed resource.
url String
The full URL of the folder.
id string
The provider-assigned unique ID for this managed resource.
url string
The full URL of the folder.
id str
The provider-assigned unique ID for this managed resource.
url str
The full URL of the folder.
id String
The provider-assigned unique ID for this managed resource.
url String
The full URL of the folder.

Look up Existing GrafanaFolder Resource

Get an existing GrafanaFolder 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?: GrafanaFolderState, opts?: CustomResourceOptions): GrafanaFolder
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        grafana_folder_id: Optional[str] = None,
        prevent_destroy_if_not_empty: Optional[bool] = None,
        title: Optional[str] = None,
        uid: Optional[str] = None,
        url: Optional[str] = None) -> GrafanaFolder
func GetGrafanaFolder(ctx *Context, name string, id IDInput, state *GrafanaFolderState, opts ...ResourceOption) (*GrafanaFolder, error)
public static GrafanaFolder Get(string name, Input<string> id, GrafanaFolderState? state, CustomResourceOptions? opts = null)
public static GrafanaFolder get(String name, Output<String> id, GrafanaFolderState state, CustomResourceOptions options)
resources:  _:    type: coralogix:GrafanaFolder    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
GrafanaFolderId string
The ID of this resource.
PreventDestroyIfNotEmpty bool
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.
GrafanaFolderId string
The ID of this resource.
PreventDestroyIfNotEmpty bool
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.
grafanaFolderId String
The ID of this resource.
preventDestroyIfNotEmpty Boolean
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.
grafanaFolderId string
The ID of this resource.
preventDestroyIfNotEmpty boolean
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.
grafana_folder_id str
The ID of this resource.
prevent_destroy_if_not_empty bool
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.
grafanaFolderId String
The ID of this resource.
preventDestroyIfNotEmpty Boolean
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
coralogix coralogix/terraform-provider-coralogix
License
Notes
This Pulumi package is based on the coralogix Terraform Provider.