Docs Packages
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. DashboardPublic
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-grafana

grafana.DashboardPublic

Explore with Pulumi AI

grafana logo
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-grafana

    Create DashboardPublic Resource

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

    Constructor syntax

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

@overload
def DashboardPublic(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    dashboard_uid: Optional[str] = None,
                    access_token: Optional[str] = None,
                    annotations_enabled: Optional[bool] = None,
                    is_enabled: Optional[bool] = None,
                    org_id: Optional[str] = None,
                    share: Optional[str] = None,
                    time_selection_enabled: Optional[bool] = None,
                    uid: Optional[str] = None)
    func NewDashboardPublic(ctx *Context, name string, args DashboardPublicArgs, opts ...ResourceOption) (*DashboardPublic, error)
    public DashboardPublic(string name, DashboardPublicArgs args, CustomResourceOptions? opts = null)
    public DashboardPublic(String name, DashboardPublicArgs args)
public DashboardPublic(String name, DashboardPublicArgs args, CustomResourceOptions options)

    type: grafana:DashboardPublic
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 DashboardPublicArgs
    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 DashboardPublicArgs
    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 DashboardPublicArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardPublicArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardPublicArgs
    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 dashboardPublicResource = new Grafana.DashboardPublic("dashboardPublicResource", new()
{
    DashboardUid = "string",
    AccessToken = "string",
    AnnotationsEnabled = false,
    IsEnabled = false,
    OrgId = "string",
    Share = "string",
    TimeSelectionEnabled = false,
    Uid = "string",
});

    example, err := grafana.NewDashboardPublic(ctx, "dashboardPublicResource", &grafana.DashboardPublicArgs{
	DashboardUid:         pulumi.String("string"),
	AccessToken:          pulumi.String("string"),
	AnnotationsEnabled:   pulumi.Bool(false),
	IsEnabled:            pulumi.Bool(false),
	OrgId:                pulumi.String("string"),
	Share:                pulumi.String("string"),
	TimeSelectionEnabled: pulumi.Bool(false),
	Uid:                  pulumi.String("string"),
})

    var dashboardPublicResource = new DashboardPublic("dashboardPublicResource", DashboardPublicArgs.builder()        
    .dashboardUid("string")
    .accessToken("string")
    .annotationsEnabled(false)
    .isEnabled(false)
    .orgId("string")
    .share("string")
    .timeSelectionEnabled(false)
    .uid("string")
    .build());

    dashboard_public_resource = grafana.DashboardPublic("dashboardPublicResource",
    dashboard_uid="string",
    access_token="string",
    annotations_enabled=False,
    is_enabled=False,
    org_id="string",
    share="string",
    time_selection_enabled=False,
    uid="string")

    const dashboardPublicResource = new grafana.DashboardPublic("dashboardPublicResource", {
    dashboardUid: "string",
    accessToken: "string",
    annotationsEnabled: false,
    isEnabled: false,
    orgId: "string",
    share: "string",
    timeSelectionEnabled: false,
    uid: "string",
});

    type: grafana:DashboardPublic
properties:
    accessToken: string
    annotationsEnabled: false
    dashboardUid: string
    isEnabled: false
    orgId: string
    share: string
    timeSelectionEnabled: false
    uid: string

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

    DashboardUid string
    The unique identifier of the original dashboard.
    AccessToken string
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    AnnotationsEnabled bool
    Set to true to show annotations. The default value is false.
    IsEnabled bool
    Set to true to enable the public dashboard. The default value is false.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Share string
    Set the share mode. The default value is public.
    TimeSelectionEnabled bool
    Set to true to enable the time picker in the public dashboard. The default value is false.
    Uid string
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.
    DashboardUid string
    The unique identifier of the original dashboard.
    AccessToken string
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    AnnotationsEnabled bool
    Set to true to show annotations. The default value is false.
    IsEnabled bool
    Set to true to enable the public dashboard. The default value is false.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Share string
    Set the share mode. The default value is public.
    TimeSelectionEnabled bool
    Set to true to enable the time picker in the public dashboard. The default value is false.
    Uid string
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.
    dashboardUid String
    The unique identifier of the original dashboard.
    accessToken String
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    annotationsEnabled Boolean
    Set to true to show annotations. The default value is false.
    isEnabled Boolean
    Set to true to enable the public dashboard. The default value is false.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    share String
    Set the share mode. The default value is public.
    timeSelectionEnabled Boolean
    Set to true to enable the time picker in the public dashboard. The default value is false.
    uid String
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.
    dashboardUid string
    The unique identifier of the original dashboard.
    accessToken string
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    annotationsEnabled boolean
    Set to true to show annotations. The default value is false.
    isEnabled boolean
    Set to true to enable the public dashboard. The default value is false.
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    share string
    Set the share mode. The default value is public.
    timeSelectionEnabled boolean
    Set to true to enable the time picker in the public dashboard. The default value is false.
    uid string
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.
    dashboard_uid str
    The unique identifier of the original dashboard.
    access_token str
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    annotations_enabled bool
    Set to true to show annotations. The default value is false.
    is_enabled bool
    Set to true to enable the public dashboard. The default value is false.
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    share str
    Set the share mode. The default value is public.
    time_selection_enabled bool
    Set to true to enable the time picker in the public dashboard. The default value is false.
    uid str
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.
    dashboardUid String
    The unique identifier of the original dashboard.
    accessToken String
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    annotationsEnabled Boolean
    Set to true to show annotations. The default value is false.
    isEnabled Boolean
    Set to true to enable the public dashboard. The default value is false.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    share String
    Set the share mode. The default value is public.
    timeSelectionEnabled Boolean
    Set to true to enable the time picker in the public dashboard. The default value is false.
    uid String
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DashboardPublic 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 DashboardPublic Resource

    Get an existing DashboardPublic 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?: DashboardPublicState, opts?: CustomResourceOptions): DashboardPublic
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_token: Optional[str] = None,
        annotations_enabled: Optional[bool] = None,
        dashboard_uid: Optional[str] = None,
        is_enabled: Optional[bool] = None,
        org_id: Optional[str] = None,
        share: Optional[str] = None,
        time_selection_enabled: Optional[bool] = None,
        uid: Optional[str] = None) -> DashboardPublic
    func GetDashboardPublic(ctx *Context, name string, id IDInput, state *DashboardPublicState, opts ...ResourceOption) (*DashboardPublic, error)
    public static DashboardPublic Get(string name, Input<string> id, DashboardPublicState? state, CustomResourceOptions? opts = null)
    public static DashboardPublic get(String name, Output<String> id, DashboardPublicState 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.
    The following state arguments are supported:
    AccessToken string
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    AnnotationsEnabled bool
    Set to true to show annotations. The default value is false.
    DashboardUid string
    The unique identifier of the original dashboard.
    IsEnabled bool
    Set to true to enable the public dashboard. The default value is false.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Share string
    Set the share mode. The default value is public.
    TimeSelectionEnabled bool
    Set to true to enable the time picker in the public dashboard. The default value is false.
    Uid string
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.
    AccessToken string
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    AnnotationsEnabled bool
    Set to true to show annotations. The default value is false.
    DashboardUid string
    The unique identifier of the original dashboard.
    IsEnabled bool
    Set to true to enable the public dashboard. The default value is false.
    OrgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    Share string
    Set the share mode. The default value is public.
    TimeSelectionEnabled bool
    Set to true to enable the time picker in the public dashboard. The default value is false.
    Uid string
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.
    accessToken String
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    annotationsEnabled Boolean
    Set to true to show annotations. The default value is false.
    dashboardUid String
    The unique identifier of the original dashboard.
    isEnabled Boolean
    Set to true to enable the public dashboard. The default value is false.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    share String
    Set the share mode. The default value is public.
    timeSelectionEnabled Boolean
    Set to true to enable the time picker in the public dashboard. The default value is false.
    uid String
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.
    accessToken string
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    annotationsEnabled boolean
    Set to true to show annotations. The default value is false.
    dashboardUid string
    The unique identifier of the original dashboard.
    isEnabled boolean
    Set to true to enable the public dashboard. The default value is false.
    orgId string
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    share string
    Set the share mode. The default value is public.
    timeSelectionEnabled boolean
    Set to true to enable the time picker in the public dashboard. The default value is false.
    uid string
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.
    access_token str
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    annotations_enabled bool
    Set to true to show annotations. The default value is false.
    dashboard_uid str
    The unique identifier of the original dashboard.
    is_enabled bool
    Set to true to enable the public dashboard. The default value is false.
    org_id str
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    share str
    Set the share mode. The default value is public.
    time_selection_enabled bool
    Set to true to enable the time picker in the public dashboard. The default value is false.
    uid str
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.
    accessToken String
    A public unique identifier of a public dashboard. This is used to construct its URL. It's automatically generated if not provided when creating a public dashboard.
    annotationsEnabled Boolean
    Set to true to show annotations. The default value is false.
    dashboardUid String
    The unique identifier of the original dashboard.
    isEnabled Boolean
    Set to true to enable the public dashboard. The default value is false.
    orgId String
    The Organization ID. If not set, the Org ID defined in the provider block will be used.
    share String
    Set the share mode. The default value is public.
    timeSelectionEnabled Boolean
    Set to true to enable the time picker in the public dashboard. The default value is false.
    uid String
    The unique identifier of a public dashboard. It's automatically generated if not provided when creating a public dashboard.

    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.4.2 published on Monday, Apr 15, 2024 by pulumiverse
    pulumiverse/pulumi-grafana