Vantage v0.0.3 published on Wednesday, Jan 31, 2024 by lbrlabs
vantage.Dashboard
Explore with Pulumi AI
Manages a Dashboard.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vantage = Lbrlabs.PulumiPackage.Vantage;
return await Deployment.RunAsync(() =>
{
var demoDashboard = new Vantage.Dashboard("demoDashboard", new()
{
DateInterval = "last_month",
Title = "Demo Dashboard",
WidgetTokens = new[]
{
"rprt_a2846903070824f4",
},
});
});
package main
import (
"github.com/lbrlabs/pulumi-vantage/sdk/go/vantage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vantage.NewDashboard(ctx, "demoDashboard", &vantage.DashboardArgs{
DateInterval: pulumi.String("last_month"),
Title: pulumi.String("Demo Dashboard"),
WidgetTokens: pulumi.StringArray{
pulumi.String("rprt_a2846903070824f4"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vantage.Dashboard;
import com.pulumi.vantage.DashboardArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var demoDashboard = new Dashboard("demoDashboard", DashboardArgs.builder()
.dateInterval("last_month")
.title("Demo Dashboard")
.widgetTokens("rprt_a2846903070824f4")
.build());
}
}
import pulumi
import lbrlabs_pulumi_vantage as vantage
demo_dashboard = vantage.Dashboard("demoDashboard",
date_interval="last_month",
title="Demo Dashboard",
widget_tokens=["rprt_a2846903070824f4"])
import * as pulumi from "@pulumi/pulumi";
import * as vantage from "@lbrlabs/pulumi-vantage";
const demoDashboard = new vantage.Dashboard("demoDashboard", {
dateInterval: "last_month",
title: "Demo Dashboard",
widgetTokens: ["rprt_a2846903070824f4"],
});
resources:
demoDashboard:
type: vantage:Dashboard
properties:
dateInterval: last_month
title: Demo Dashboard
widgetTokens:
- rprt_a2846903070824f4
Create Dashboard Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
@overload
def Dashboard(resource_name: str,
args: DashboardArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Dashboard(resource_name: str,
opts: Optional[ResourceOptions] = None,
title: Optional[str] = None,
widget_tokens: Optional[Sequence[str]] = None,
date_bin: Optional[str] = None,
date_interval: Optional[str] = None,
end_date: Optional[str] = None,
start_date: Optional[str] = None,
workspace_token: Optional[str] = None)
func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
type: vantage:Dashboard
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 DashboardArgs
- 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 DashboardArgs
- 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 DashboardArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DashboardArgs
- 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 dashboardResource = new Vantage.Dashboard("dashboardResource", new()
{
Title = "string",
WidgetTokens = new[]
{
"string",
},
DateBin = "string",
DateInterval = "string",
EndDate = "string",
StartDate = "string",
WorkspaceToken = "string",
});
example, err := vantage.NewDashboard(ctx, "dashboardResource", &vantage.DashboardArgs{
Title: pulumi.String("string"),
WidgetTokens: pulumi.StringArray{
pulumi.String("string"),
},
DateBin: pulumi.String("string"),
DateInterval: pulumi.String("string"),
EndDate: pulumi.String("string"),
StartDate: pulumi.String("string"),
WorkspaceToken: pulumi.String("string"),
})
var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
.title("string")
.widgetTokens("string")
.dateBin("string")
.dateInterval("string")
.endDate("string")
.startDate("string")
.workspaceToken("string")
.build());
dashboard_resource = vantage.Dashboard("dashboardResource",
title="string",
widget_tokens=["string"],
date_bin="string",
date_interval="string",
end_date="string",
start_date="string",
workspace_token="string")
const dashboardResource = new vantage.Dashboard("dashboardResource", {
title: "string",
widgetTokens: ["string"],
dateBin: "string",
dateInterval: "string",
endDate: "string",
startDate: "string",
workspaceToken: "string",
});
type: vantage:Dashboard
properties:
dateBin: string
dateInterval: string
endDate: string
startDate: string
title: string
widgetTokens:
- string
workspaceToken: string
Dashboard 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 Dashboard resource accepts the following input properties:
- Title string
- Title of the dashboard
- Widget
Tokens List<string> - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- Date
Bin string - Determines how to group costs in the Dashboard.
- Date
Interval string - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- End
Date string - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- Start
Date string - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- Workspace
Token string - The token for the Workspace the Dashboard is a part of.
- Title string
- Title of the dashboard
- Widget
Tokens []string - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- Date
Bin string - Determines how to group costs in the Dashboard.
- Date
Interval string - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- End
Date string - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- Start
Date string - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- Workspace
Token string - The token for the Workspace the Dashboard is a part of.
- title String
- Title of the dashboard
- widget
Tokens List<String> - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- date
Bin String - Determines how to group costs in the Dashboard.
- date
Interval String - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- end
Date String - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- start
Date String - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- workspace
Token String - The token for the Workspace the Dashboard is a part of.
- title string
- Title of the dashboard
- widget
Tokens string[] - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- date
Bin string - Determines how to group costs in the Dashboard.
- date
Interval string - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- end
Date string - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- start
Date string - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- workspace
Token string - The token for the Workspace the Dashboard is a part of.
- title str
- Title of the dashboard
- widget_
tokens Sequence[str] - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- date_
bin str - Determines how to group costs in the Dashboard.
- date_
interval str - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- end_
date str - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- start_
date str - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- workspace_
token str - The token for the Workspace the Dashboard is a part of.
- title String
- Title of the dashboard
- widget
Tokens List<String> - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- date
Bin String - Determines how to group costs in the Dashboard.
- date
Interval String - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- end
Date String - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- start
Date String - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- workspace
Token String - The token for the Workspace the Dashboard is a part of.
Outputs
All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:
Look up Existing Dashboard Resource
Get an existing Dashboard 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?: DashboardState, opts?: CustomResourceOptions): Dashboard
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
date_bin: Optional[str] = None,
date_interval: Optional[str] = None,
end_date: Optional[str] = None,
start_date: Optional[str] = None,
title: Optional[str] = None,
token: Optional[str] = None,
widget_tokens: Optional[Sequence[str]] = None,
workspace_token: Optional[str] = None) -> Dashboard
func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
public static Dashboard get(String name, Output<String> id, DashboardState 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.
- Date
Bin string - Determines how to group costs in the Dashboard.
- Date
Interval string - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- End
Date string - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- Start
Date string - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- Title string
- Title of the dashboard
- Token string
- Unique dashboard identifier
- Widget
Tokens List<string> - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- Workspace
Token string - The token for the Workspace the Dashboard is a part of.
- Date
Bin string - Determines how to group costs in the Dashboard.
- Date
Interval string - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- End
Date string - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- Start
Date string - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- Title string
- Title of the dashboard
- Token string
- Unique dashboard identifier
- Widget
Tokens []string - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- Workspace
Token string - The token for the Workspace the Dashboard is a part of.
- date
Bin String - Determines how to group costs in the Dashboard.
- date
Interval String - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- end
Date String - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- start
Date String - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- title String
- Title of the dashboard
- token String
- Unique dashboard identifier
- widget
Tokens List<String> - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- workspace
Token String - The token for the Workspace the Dashboard is a part of.
- date
Bin string - Determines how to group costs in the Dashboard.
- date
Interval string - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- end
Date string - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- start
Date string - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- title string
- Title of the dashboard
- token string
- Unique dashboard identifier
- widget
Tokens string[] - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- workspace
Token string - The token for the Workspace the Dashboard is a part of.
- date_
bin str - Determines how to group costs in the Dashboard.
- date_
interval str - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- end_
date str - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- start_
date str - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- title str
- Title of the dashboard
- token str
- Unique dashboard identifier
- widget_
tokens Sequence[str] - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- workspace_
token str - The token for the Workspace the Dashboard is a part of.
- date
Bin String - Determines how to group costs in the Dashboard.
- date
Interval String - Determines the date range in the Dashboard. Guaranteed to be set to 'custom' if 'startdate' and 'enddate' are set.
- end
Date String - The end date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- start
Date String - The start date for the date range for CostReports in the Dashboard. ISO 8601 Formatted. Overwrites 'date_interval' if set.
- title String
- Title of the dashboard
- token String
- Unique dashboard identifier
- widget
Tokens List<String> - Tokens for widgets present in the dashboard. Currently only cost report tokens are supported.
- workspace
Token String - The token for the Workspace the Dashboard is a part of.
Package Details
- Repository
- vantage lbrlabs/pulumi-vantage
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vantage
Terraform Provider.