UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

128 lines 5.69 kB
"use strict"; // *** 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.RowAccessPolicy = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("../utilities"); /** * Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy. * * ## Example Usage * * ### Bigquery Row Access Policy Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.bigquery.Dataset("example", { * datasetId: "dataset_id", * location: "US", * }); * const exampleTable = new gcp.bigquery.Table("example", { * deletionProtection: false, * datasetId: example.datasetId, * tableId: "table_id", * }); * const exampleRowAccessPolicy = new gcp.bigquery.RowAccessPolicy("example", { * datasetId: example.datasetId, * tableId: exampleTable.tableId, * policyId: "policy_id", * filterPredicate: "nullable_field is not NULL", * grantees: ["domain:google.com"], * }); * ``` * * ## Import * * RowAccessPolicy can be imported using any of these accepted formats: * * * `projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}/rowAccessPolicies/{{policy_id}}` * * * `{{project}}/{{dataset_id}}/{{table_id}}/{{policy_id}}` * * * `{{dataset_id}}/{{table_id}}/{{policy_id}}` * * When using the `pulumi import` command, RowAccessPolicy can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:bigquery/rowAccessPolicy:RowAccessPolicy default projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}/rowAccessPolicies/{{policy_id}} * ``` * * ```sh * $ pulumi import gcp:bigquery/rowAccessPolicy:RowAccessPolicy default {{project}}/{{dataset_id}}/{{table_id}}/{{policy_id}} * ``` * * ```sh * $ pulumi import gcp:bigquery/rowAccessPolicy:RowAccessPolicy default {{dataset_id}}/{{table_id}}/{{policy_id}} * ``` */ class RowAccessPolicy extends pulumi.CustomResource { /** * Get an existing RowAccessPolicy 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 RowAccessPolicy(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of RowAccessPolicy. 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'] === RowAccessPolicy.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["creationTime"] = state ? state.creationTime : undefined; resourceInputs["datasetId"] = state ? state.datasetId : undefined; resourceInputs["filterPredicate"] = state ? state.filterPredicate : undefined; resourceInputs["grantees"] = state ? state.grantees : undefined; resourceInputs["lastModifiedTime"] = state ? state.lastModifiedTime : undefined; resourceInputs["policyId"] = state ? state.policyId : undefined; resourceInputs["project"] = state ? state.project : undefined; resourceInputs["tableId"] = state ? state.tableId : undefined; } else { const args = argsOrState; if ((!args || args.datasetId === undefined) && !opts.urn) { throw new Error("Missing required property 'datasetId'"); } if ((!args || args.filterPredicate === undefined) && !opts.urn) { throw new Error("Missing required property 'filterPredicate'"); } if ((!args || args.policyId === undefined) && !opts.urn) { throw new Error("Missing required property 'policyId'"); } if ((!args || args.tableId === undefined) && !opts.urn) { throw new Error("Missing required property 'tableId'"); } resourceInputs["datasetId"] = args ? args.datasetId : undefined; resourceInputs["filterPredicate"] = args ? args.filterPredicate : undefined; resourceInputs["grantees"] = args ? args.grantees : undefined; resourceInputs["policyId"] = args ? args.policyId : undefined; resourceInputs["project"] = args ? args.project : undefined; resourceInputs["tableId"] = args ? args.tableId : undefined; resourceInputs["creationTime"] = undefined /*out*/; resourceInputs["lastModifiedTime"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(RowAccessPolicy.__pulumiType, name, resourceInputs, opts); } } exports.RowAccessPolicy = RowAccessPolicy; /** @internal */ RowAccessPolicy.__pulumiType = 'gcp:bigquery/rowAccessPolicy:RowAccessPolicy'; //# sourceMappingURL=rowAccessPolicy.js.map