@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
126 lines • 5.5 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Dashboard = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Resource for managing a QuickSight Dashboard.
*
* ## Example Usage
*
* ### From Source Template
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.Dashboard("example", {
* dashboardId: "example-id",
* name: "example-name",
* versionDescription: "version",
* sourceEntity: {
* sourceTemplate: {
* arn: source.arn,
* dataSetReferences: [{
* dataSetArn: dataset.arn,
* dataSetPlaceholder: "1",
* }],
* },
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import a QuickSight Dashboard using the AWS account ID and dashboard ID separated by a comma (`,`). For example:
*
* ```sh
* $ pulumi import aws:quicksight/dashboard:Dashboard example 123456789012,example-id
* ```
*/
class Dashboard extends pulumi.CustomResource {
/**
* Get an existing Dashboard resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new Dashboard(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Dashboard. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Dashboard.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["arn"] = state?.arn;
resourceInputs["awsAccountId"] = state?.awsAccountId;
resourceInputs["createdTime"] = state?.createdTime;
resourceInputs["dashboardId"] = state?.dashboardId;
resourceInputs["dashboardPublishOptions"] = state?.dashboardPublishOptions;
resourceInputs["lastPublishedTime"] = state?.lastPublishedTime;
resourceInputs["lastUpdatedTime"] = state?.lastUpdatedTime;
resourceInputs["name"] = state?.name;
resourceInputs["parameters"] = state?.parameters;
resourceInputs["permissions"] = state?.permissions;
resourceInputs["region"] = state?.region;
resourceInputs["sourceEntity"] = state?.sourceEntity;
resourceInputs["sourceEntityArn"] = state?.sourceEntityArn;
resourceInputs["status"] = state?.status;
resourceInputs["tags"] = state?.tags;
resourceInputs["tagsAll"] = state?.tagsAll;
resourceInputs["themeArn"] = state?.themeArn;
resourceInputs["versionDescription"] = state?.versionDescription;
resourceInputs["versionNumber"] = state?.versionNumber;
}
else {
const args = argsOrState;
if (args?.dashboardId === undefined && !opts.urn) {
throw new Error("Missing required property 'dashboardId'");
}
if (args?.versionDescription === undefined && !opts.urn) {
throw new Error("Missing required property 'versionDescription'");
}
resourceInputs["awsAccountId"] = args?.awsAccountId;
resourceInputs["dashboardId"] = args?.dashboardId;
resourceInputs["dashboardPublishOptions"] = args?.dashboardPublishOptions;
resourceInputs["name"] = args?.name;
resourceInputs["parameters"] = args?.parameters;
resourceInputs["permissions"] = args?.permissions;
resourceInputs["region"] = args?.region;
resourceInputs["sourceEntity"] = args?.sourceEntity;
resourceInputs["tags"] = args?.tags;
resourceInputs["themeArn"] = args?.themeArn;
resourceInputs["versionDescription"] = args?.versionDescription;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["createdTime"] = undefined /*out*/;
resourceInputs["lastPublishedTime"] = undefined /*out*/;
resourceInputs["lastUpdatedTime"] = undefined /*out*/;
resourceInputs["sourceEntityArn"] = undefined /*out*/;
resourceInputs["status"] = undefined /*out*/;
resourceInputs["tagsAll"] = undefined /*out*/;
resourceInputs["versionNumber"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Dashboard.__pulumiType, name, resourceInputs, opts);
}
}
exports.Dashboard = Dashboard;
/** @internal */
Dashboard.__pulumiType = 'aws:quicksight/dashboard:Dashboard';
//# sourceMappingURL=dashboard.js.map