@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
143 lines • 5.32 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.Folder = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Resource for managing a QuickSight Folder.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.Folder("example", {
* folderId: "example-id",
* name: "example-name",
* });
* ```
*
* ### With Permissions
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.Folder("example", {
* folderId: "example-id",
* name: "example-name",
* permissions: [{
* actions: [
* "quicksight:CreateFolder",
* "quicksight:DescribeFolder",
* "quicksight:UpdateFolder",
* "quicksight:DeleteFolder",
* "quicksight:CreateFolderMembership",
* "quicksight:DeleteFolderMembership",
* "quicksight:DescribeFolderPermissions",
* "quicksight:UpdateFolderPermissions",
* ],
* principal: exampleAwsQuicksightUser.arn,
* }],
* });
* ```
*
* ### With Parent Folder
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const parent = new aws.quicksight.Folder("parent", {
* folderId: "parent-id",
* name: "parent-name",
* });
* const example = new aws.quicksight.Folder("example", {
* folderId: "example-id",
* name: "example-name",
* parentFolderArn: parent.arn,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import a QuickSight folder using the AWS account ID and folder ID name separated by a comma (`,`). For example:
*
* ```sh
* $ pulumi import aws:quicksight/folder:Folder example 123456789012,example-id
* ```
*/
class Folder extends pulumi.CustomResource {
/**
* Get an existing Folder 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 Folder(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Folder. 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'] === Folder.__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["folderId"] = state?.folderId;
resourceInputs["folderPaths"] = state?.folderPaths;
resourceInputs["folderType"] = state?.folderType;
resourceInputs["lastUpdatedTime"] = state?.lastUpdatedTime;
resourceInputs["name"] = state?.name;
resourceInputs["parentFolderArn"] = state?.parentFolderArn;
resourceInputs["permissions"] = state?.permissions;
resourceInputs["region"] = state?.region;
resourceInputs["tags"] = state?.tags;
resourceInputs["tagsAll"] = state?.tagsAll;
}
else {
const args = argsOrState;
if (args?.folderId === undefined && !opts.urn) {
throw new Error("Missing required property 'folderId'");
}
resourceInputs["awsAccountId"] = args?.awsAccountId;
resourceInputs["folderId"] = args?.folderId;
resourceInputs["folderType"] = args?.folderType;
resourceInputs["name"] = args?.name;
resourceInputs["parentFolderArn"] = args?.parentFolderArn;
resourceInputs["permissions"] = args?.permissions;
resourceInputs["region"] = args?.region;
resourceInputs["tags"] = args?.tags;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["createdTime"] = undefined /*out*/;
resourceInputs["folderPaths"] = undefined /*out*/;
resourceInputs["lastUpdatedTime"] = undefined /*out*/;
resourceInputs["tagsAll"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Folder.__pulumiType, name, resourceInputs, opts);
}
}
exports.Folder = Folder;
/** @internal */
Folder.__pulumiType = 'aws:quicksight/folder:Folder';
//# sourceMappingURL=folder.js.map