1. Packages
  2. Grafana Cloud
  3. API Docs
  4. experimental
  5. AppsDashboard
Grafana v0.19.2 published on Friday, Jul 18, 2025 by pulumiverse

grafana.experimental.AppsDashboard

Explore with Pulumi AI

grafana logo
Grafana v0.19.2 published on Friday, Jul 18, 2025 by pulumiverse

    Manages Grafana dashboards using the new Grafana APIs.

    Create AppsDashboard Resource

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

    Constructor syntax

    new AppsDashboard(name: string, args?: AppsDashboardArgs, opts?: CustomResourceOptions);
    @overload
    def AppsDashboard(resource_name: str,
                      args: Optional[AppsDashboardArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def AppsDashboard(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      metadata: Optional[AppsDashboardMetadataArgs] = None,
                      options: Optional[AppsDashboardOptionsArgs] = None,
                      spec: Optional[AppsDashboardSpecArgs] = None)
    func NewAppsDashboard(ctx *Context, name string, args *AppsDashboardArgs, opts ...ResourceOption) (*AppsDashboard, error)
    public AppsDashboard(string name, AppsDashboardArgs? args = null, CustomResourceOptions? opts = null)
    public AppsDashboard(String name, AppsDashboardArgs args)
    public AppsDashboard(String name, AppsDashboardArgs args, CustomResourceOptions options)
    
    type: grafana:experimental:AppsDashboard
    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 AppsDashboardArgs
    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 AppsDashboardArgs
    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 AppsDashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppsDashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppsDashboardArgs
    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 appsDashboardResource = new Grafana.Experimental.AppsDashboard("appsDashboardResource", new()
    {
        Metadata = new Grafana.Experimental.Inputs.AppsDashboardMetadataArgs
        {
            Uid = "string",
            FolderUid = "string",
            Url = "string",
            Uuid = "string",
            Version = "string",
        },
        Options = new Grafana.Experimental.Inputs.AppsDashboardOptionsArgs
        {
            Overwrite = false,
        },
        Spec = new Grafana.Experimental.Inputs.AppsDashboardSpecArgs
        {
            Json = "string",
            Tags = new[]
            {
                "string",
            },
            Title = "string",
        },
    });
    
    example, err := experimental.NewAppsDashboard(ctx, "appsDashboardResource", &experimental.AppsDashboardArgs{
    	Metadata: &experimental.AppsDashboardMetadataArgs{
    		Uid:       pulumi.String("string"),
    		FolderUid: pulumi.String("string"),
    		Url:       pulumi.String("string"),
    		Uuid:      pulumi.String("string"),
    		Version:   pulumi.String("string"),
    	},
    	Options: &experimental.AppsDashboardOptionsArgs{
    		Overwrite: pulumi.Bool(false),
    	},
    	Spec: &experimental.AppsDashboardSpecArgs{
    		Json: pulumi.String("string"),
    		Tags: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		Title: pulumi.String("string"),
    	},
    })
    
    var appsDashboardResource = new AppsDashboard("appsDashboardResource", AppsDashboardArgs.builder()
        .metadata(AppsDashboardMetadataArgs.builder()
            .uid("string")
            .folderUid("string")
            .url("string")
            .uuid("string")
            .version("string")
            .build())
        .options(AppsDashboardOptionsArgs.builder()
            .overwrite(false)
            .build())
        .spec(AppsDashboardSpecArgs.builder()
            .json("string")
            .tags("string")
            .title("string")
            .build())
        .build());
    
    apps_dashboard_resource = grafana.experimental.AppsDashboard("appsDashboardResource",
        metadata={
            "uid": "string",
            "folder_uid": "string",
            "url": "string",
            "uuid": "string",
            "version": "string",
        },
        options={
            "overwrite": False,
        },
        spec={
            "json": "string",
            "tags": ["string"],
            "title": "string",
        })
    
    const appsDashboardResource = new grafana.experimental.AppsDashboard("appsDashboardResource", {
        metadata: {
            uid: "string",
            folderUid: "string",
            url: "string",
            uuid: "string",
            version: "string",
        },
        options: {
            overwrite: false,
        },
        spec: {
            json: "string",
            tags: ["string"],
            title: "string",
        },
    });
    
    type: grafana:experimental:AppsDashboard
    properties:
        metadata:
            folderUid: string
            uid: string
            url: string
            uuid: string
            version: string
        options:
            overwrite: false
        spec:
            json: string
            tags:
                - string
            title: string
    

    AppsDashboard 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 AppsDashboard resource accepts the following input properties:

    Metadata AppsDashboardMetadataArgs
    The metadata of the resource.
    Options AppsDashboardOptionsArgs
    Options for applying the resource.
    Spec AppsDashboardSpecArgs
    The spec of the resource.
    metadata AppsDashboardMetadata
    The metadata of the resource.
    options AppsDashboardOptions
    Options for applying the resource.
    spec AppsDashboardSpec
    The spec of the resource.
    metadata AppsDashboardMetadata
    The metadata of the resource.
    options AppsDashboardOptions
    Options for applying the resource.
    spec AppsDashboardSpec
    The spec of the resource.
    metadata AppsDashboardMetadataArgs
    The metadata of the resource.
    options AppsDashboardOptionsArgs
    Options for applying the resource.
    spec AppsDashboardSpecArgs
    The spec of the resource.
    metadata Property Map
    The metadata of the resource.
    options Property Map
    Options for applying the resource.
    spec Property Map
    The spec of the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AppsDashboard resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AppsDashboard Resource

    Get an existing AppsDashboard 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?: AppsDashboardState, opts?: CustomResourceOptions): AppsDashboard
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            metadata: Optional[AppsDashboardMetadataArgs] = None,
            options: Optional[AppsDashboardOptionsArgs] = None,
            spec: Optional[AppsDashboardSpecArgs] = None) -> AppsDashboard
    func GetAppsDashboard(ctx *Context, name string, id IDInput, state *AppsDashboardState, opts ...ResourceOption) (*AppsDashboard, error)
    public static AppsDashboard Get(string name, Input<string> id, AppsDashboardState? state, CustomResourceOptions? opts = null)
    public static AppsDashboard get(String name, Output<String> id, AppsDashboardState state, CustomResourceOptions options)
    resources:  _:    type: grafana:experimental:AppsDashboard    get:      id: ${id}
    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.
    The following state arguments are supported:
    Metadata AppsDashboardMetadataArgs
    The metadata of the resource.
    Options AppsDashboardOptionsArgs
    Options for applying the resource.
    Spec AppsDashboardSpecArgs
    The spec of the resource.
    metadata AppsDashboardMetadata
    The metadata of the resource.
    options AppsDashboardOptions
    Options for applying the resource.
    spec AppsDashboardSpec
    The spec of the resource.
    metadata AppsDashboardMetadata
    The metadata of the resource.
    options AppsDashboardOptions
    Options for applying the resource.
    spec AppsDashboardSpec
    The spec of the resource.
    metadata AppsDashboardMetadataArgs
    The metadata of the resource.
    options AppsDashboardOptionsArgs
    Options for applying the resource.
    spec AppsDashboardSpecArgs
    The spec of the resource.
    metadata Property Map
    The metadata of the resource.
    options Property Map
    Options for applying the resource.
    spec Property Map
    The spec of the resource.

    Supporting Types

    AppsDashboardMetadata, AppsDashboardMetadataArgs

    Uid string
    The unique identifier of the resource.
    FolderUid string
    The UID of the folder to save the resource in.
    Url string
    The full URL of the resource.
    Uuid string
    The globally unique identifier of a resource, used by the API for tracking.
    Version string
    The version of the resource.
    Uid string
    The unique identifier of the resource.
    FolderUid string
    The UID of the folder to save the resource in.
    Url string
    The full URL of the resource.
    Uuid string
    The globally unique identifier of a resource, used by the API for tracking.
    Version string
    The version of the resource.
    uid String
    The unique identifier of the resource.
    folderUid String
    The UID of the folder to save the resource in.
    url String
    The full URL of the resource.
    uuid String
    The globally unique identifier of a resource, used by the API for tracking.
    version String
    The version of the resource.
    uid string
    The unique identifier of the resource.
    folderUid string
    The UID of the folder to save the resource in.
    url string
    The full URL of the resource.
    uuid string
    The globally unique identifier of a resource, used by the API for tracking.
    version string
    The version of the resource.
    uid str
    The unique identifier of the resource.
    folder_uid str
    The UID of the folder to save the resource in.
    url str
    The full URL of the resource.
    uuid str
    The globally unique identifier of a resource, used by the API for tracking.
    version str
    The version of the resource.
    uid String
    The unique identifier of the resource.
    folderUid String
    The UID of the folder to save the resource in.
    url String
    The full URL of the resource.
    uuid String
    The globally unique identifier of a resource, used by the API for tracking.
    version String
    The version of the resource.

    AppsDashboardOptions, AppsDashboardOptionsArgs

    Overwrite bool
    Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
    Overwrite bool
    Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
    overwrite Boolean
    Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
    overwrite boolean
    Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
    overwrite bool
    Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
    overwrite Boolean
    Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.

    AppsDashboardSpec, AppsDashboardSpecArgs

    Json string
    The JSON representation of the dashboard spec.
    Tags List<string>
    The tags of the dashboard. If not set, the tags will be derived from the JSON spec.
    Title string
    The title of the dashboard. If not set, the title will be derived from the JSON spec.
    Json string
    The JSON representation of the dashboard spec.
    Tags []string
    The tags of the dashboard. If not set, the tags will be derived from the JSON spec.
    Title string
    The title of the dashboard. If not set, the title will be derived from the JSON spec.
    json String
    The JSON representation of the dashboard spec.
    tags List<String>
    The tags of the dashboard. If not set, the tags will be derived from the JSON spec.
    title String
    The title of the dashboard. If not set, the title will be derived from the JSON spec.
    json string
    The JSON representation of the dashboard spec.
    tags string[]
    The tags of the dashboard. If not set, the tags will be derived from the JSON spec.
    title string
    The title of the dashboard. If not set, the title will be derived from the JSON spec.
    json str
    The JSON representation of the dashboard spec.
    tags Sequence[str]
    The tags of the dashboard. If not set, the tags will be derived from the JSON spec.
    title str
    The title of the dashboard. If not set, the title will be derived from the JSON spec.
    json String
    The JSON representation of the dashboard spec.
    tags List<String>
    The tags of the dashboard. If not set, the tags will be derived from the JSON spec.
    title String
    The title of the dashboard. If not set, the title will be derived from the JSON spec.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.19.2 published on Friday, Jul 18, 2025 by pulumiverse