@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
262 lines • 9.55 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.DataSet = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Resource for managing a QuickSight Data Set.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.DataSet("example", {
* dataSetId: "example-id",
* name: "example-name",
* importMode: "SPICE",
* physicalTableMaps: [{
* physicalTableMapId: "example-id",
* s3Source: {
* dataSourceArn: exampleAwsQuicksightDataSource.arn,
* inputColumns: [{
* name: "Column1",
* type: "STRING",
* }],
* uploadSettings: {
* format: "JSON",
* },
* },
* }],
* });
* ```
*
* ### With Column Level Permission Rules
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.DataSet("example", {
* dataSetId: "example-id",
* name: "example-name",
* importMode: "SPICE",
* physicalTableMaps: [{
* physicalTableMapId: "example-id",
* s3Source: {
* dataSourceArn: exampleAwsQuicksightDataSource.arn,
* inputColumns: [{
* name: "Column1",
* type: "STRING",
* }],
* uploadSettings: {
* format: "JSON",
* },
* },
* }],
* columnLevelPermissionRules: [{
* columnNames: ["Column1"],
* principals: [exampleAwsQuicksightUser.arn],
* }],
* });
* ```
*
* ### With Field Folders
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.DataSet("example", {
* dataSetId: "example-id",
* name: "example-name",
* importMode: "SPICE",
* physicalTableMaps: [{
* physicalTableMapId: "example-id",
* s3Source: {
* dataSourceArn: exampleAwsQuicksightDataSource.arn,
* inputColumns: [{
* name: "Column1",
* type: "STRING",
* }],
* uploadSettings: {
* format: "JSON",
* },
* },
* }],
* fieldFolders: [{
* fieldFoldersId: "example-id",
* columns: ["Column1"],
* description: "example description",
* }],
* });
* ```
*
* ### With Permissions
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.DataSet("example", {
* dataSetId: "example-id",
* name: "example-name",
* importMode: "SPICE",
* physicalTableMaps: [{
* physicalTableMapId: "example-id",
* s3Source: {
* dataSourceArn: exampleAwsQuicksightDataSource.arn,
* inputColumns: [{
* name: "Column1",
* type: "STRING",
* }],
* uploadSettings: {
* format: "JSON",
* },
* },
* }],
* permissions: [{
* actions: [
* "quicksight:DescribeDataSet",
* "quicksight:DescribeDataSetPermissions",
* "quicksight:PassDataSet",
* "quicksight:DescribeIngestion",
* "quicksight:ListIngestions",
* ],
* principal: exampleAwsQuicksightUser.arn,
* }],
* });
* ```
*
* ### With Row Level Permission Tag Configuration
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.quicksight.DataSet("example", {
* dataSetId: "example-id",
* name: "example-name",
* importMode: "SPICE",
* physicalTableMaps: [{
* physicalTableMapId: "example-id",
* s3Source: {
* dataSourceArn: exampleAwsQuicksightDataSource.arn,
* inputColumns: [{
* name: "Column1",
* type: "STRING",
* }],
* uploadSettings: {
* format: "JSON",
* },
* },
* }],
* rowLevelPermissionTagConfiguration: {
* status: "ENABLED",
* tagRules: [{
* columnName: "Column1",
* tagKey: "tagkey",
* matchAllValue: "*",
* tagMultiValueDelimiter: ",",
* }],
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import a QuickSight Data Set using the AWS account ID and data set ID separated by a comma (`,`). For example:
*
* ```sh
* $ pulumi import aws:quicksight/dataSet:DataSet example 123456789012,example-id
* ```
*/
class DataSet extends pulumi.CustomResource {
/**
* Get an existing DataSet 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 DataSet(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of DataSet. 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'] === DataSet.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["arn"] = state?.arn;
resourceInputs["awsAccountId"] = state?.awsAccountId;
resourceInputs["columnGroups"] = state?.columnGroups;
resourceInputs["columnLevelPermissionRules"] = state?.columnLevelPermissionRules;
resourceInputs["dataSetId"] = state?.dataSetId;
resourceInputs["dataSetUsageConfiguration"] = state?.dataSetUsageConfiguration;
resourceInputs["fieldFolders"] = state?.fieldFolders;
resourceInputs["importMode"] = state?.importMode;
resourceInputs["logicalTableMaps"] = state?.logicalTableMaps;
resourceInputs["name"] = state?.name;
resourceInputs["outputColumns"] = state?.outputColumns;
resourceInputs["permissions"] = state?.permissions;
resourceInputs["physicalTableMaps"] = state?.physicalTableMaps;
resourceInputs["refreshProperties"] = state?.refreshProperties;
resourceInputs["region"] = state?.region;
resourceInputs["rowLevelPermissionDataSet"] = state?.rowLevelPermissionDataSet;
resourceInputs["rowLevelPermissionTagConfiguration"] = state?.rowLevelPermissionTagConfiguration;
resourceInputs["tags"] = state?.tags;
resourceInputs["tagsAll"] = state?.tagsAll;
}
else {
const args = argsOrState;
if (args?.dataSetId === undefined && !opts.urn) {
throw new Error("Missing required property 'dataSetId'");
}
if (args?.importMode === undefined && !opts.urn) {
throw new Error("Missing required property 'importMode'");
}
resourceInputs["awsAccountId"] = args?.awsAccountId;
resourceInputs["columnGroups"] = args?.columnGroups;
resourceInputs["columnLevelPermissionRules"] = args?.columnLevelPermissionRules;
resourceInputs["dataSetId"] = args?.dataSetId;
resourceInputs["dataSetUsageConfiguration"] = args?.dataSetUsageConfiguration;
resourceInputs["fieldFolders"] = args?.fieldFolders;
resourceInputs["importMode"] = args?.importMode;
resourceInputs["logicalTableMaps"] = args?.logicalTableMaps;
resourceInputs["name"] = args?.name;
resourceInputs["permissions"] = args?.permissions;
resourceInputs["physicalTableMaps"] = args?.physicalTableMaps;
resourceInputs["refreshProperties"] = args?.refreshProperties;
resourceInputs["region"] = args?.region;
resourceInputs["rowLevelPermissionDataSet"] = args?.rowLevelPermissionDataSet;
resourceInputs["rowLevelPermissionTagConfiguration"] = args?.rowLevelPermissionTagConfiguration;
resourceInputs["tags"] = args?.tags;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["outputColumns"] = undefined /*out*/;
resourceInputs["tagsAll"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(DataSet.__pulumiType, name, resourceInputs, opts);
}
}
exports.DataSet = DataSet;
/** @internal */
DataSet.__pulumiType = 'aws:quicksight/dataSet:DataSet';
//# sourceMappingURL=dataSet.js.map