@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
207 lines • 8.67 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.DatasetIamMember = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Three different resources help you manage your IAM policy for BigQuery dataset. Each of these resources serves a different use case:
*
* * `gcp.bigquery.DatasetIamPolicy`: Authoritative. Sets the IAM policy for the dataset and replaces any existing policy already attached.
* * `gcp.bigquery.DatasetIamBinding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the dataset are preserved.
* * `gcp.bigquery.DatasetIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the dataset are preserved.
*
* These resources are intended to convert the permissions system for BigQuery datasets to the standard IAM interface. For advanced usages, including [creating authorized views](https://cloud.google.com/bigquery/docs/share-access-views), please use either `gcp.bigquery.DatasetAccess` or the `access` field on `gcp.bigquery.Dataset`.
*
* > **Note:** These resources **cannot** be used with `gcp.bigquery.DatasetAccess` resources or the `access` field on `gcp.bigquery.Dataset` or they will fight over what the policy should be.
*
* > **Note:** Using any of these resources will remove any authorized view permissions from the dataset. To assign and preserve authorized view permissions use the `gcp.bigquery.DatasetAccess` instead.
*
* > **Note:** Legacy BigQuery roles `OWNER` `WRITER` and `READER` **cannot** be used with any of these IAM resources. Instead use the full role form of: `roles/bigquery.dataOwner` `roles/bigquery.dataEditor` and `roles/bigquery.dataViewer`.
*
* > **Note:** `gcp.bigquery.DatasetIamPolicy` **cannot** be used in conjunction with `gcp.bigquery.DatasetIamBinding` and `gcp.bigquery.DatasetIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.bigquery.DatasetIamBinding` resources **can be** used in conjunction with `gcp.bigquery.DatasetIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.bigquery.DatasetIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const owner = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/bigquery.dataOwner",
* members: ["user:jane@example.com"],
* }],
* });
* const datasetDataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
* const dataset = new gcp.bigquery.DatasetIamPolicy("dataset", {
* datasetId: datasetDataset.datasetId,
* policyData: owner.then(owner => owner.policyData),
* });
* ```
*
* ## gcp.bigquery.DatasetIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
* const reader = new gcp.bigquery.DatasetIamBinding("reader", {
* datasetId: dataset.datasetId,
* role: "roles/bigquery.dataViewer",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.bigquery.DatasetIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
* const editor = new gcp.bigquery.DatasetIamMember("editor", {
* datasetId: dataset.datasetId,
* role: "roles/bigquery.dataEditor",
* member: "user:jane@example.com",
* });
* ```
*
* ## gcp.bigquery.DatasetIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const owner = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/bigquery.dataOwner",
* members: ["user:jane@example.com"],
* }],
* });
* const datasetDataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
* const dataset = new gcp.bigquery.DatasetIamPolicy("dataset", {
* datasetId: datasetDataset.datasetId,
* policyData: owner.then(owner => owner.policyData),
* });
* ```
*
* ## gcp.bigquery.DatasetIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
* const reader = new gcp.bigquery.DatasetIamBinding("reader", {
* datasetId: dataset.datasetId,
* role: "roles/bigquery.dataViewer",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.bigquery.DatasetIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
* const editor = new gcp.bigquery.DatasetIamMember("editor", {
* datasetId: dataset.datasetId,
* role: "roles/bigquery.dataEditor",
* member: "user:jane@example.com",
* });
* ```
*
* ## Import
*
* ### Importing IAM policies
*
* IAM policy imports use the identifier of the BigQuery Dataset resource. For example:
*
* * `projects/{{project_id}}/datasets/{{dataset_id}}`
*
* An `import` block (Terraform v1.5.0 and later) can be used to import IAM policies:
*
* tf
*
* import {
*
* id = projects/{{project_id}}/datasets/{{dataset_id}}
*
* to = google_bigquery_dataset_iam_policy.default
*
* }
*
* The `pulumi import` command can also be used:
*
* ```sh
* $ pulumi import gcp:bigquery/datasetIamMember:DatasetIamMember default projects/{{project_id}}/datasets/{{dataset_id}}
* ```
*/
class DatasetIamMember extends pulumi.CustomResource {
/**
* Get an existing DatasetIamMember 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 DatasetIamMember(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of DatasetIamMember. 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'] === DatasetIamMember.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["condition"] = state?.condition;
resourceInputs["datasetId"] = state?.datasetId;
resourceInputs["etag"] = state?.etag;
resourceInputs["member"] = state?.member;
resourceInputs["project"] = state?.project;
resourceInputs["role"] = state?.role;
}
else {
const args = argsOrState;
if (args?.datasetId === undefined && !opts.urn) {
throw new Error("Missing required property 'datasetId'");
}
if (args?.member === undefined && !opts.urn) {
throw new Error("Missing required property 'member'");
}
if (args?.role === undefined && !opts.urn) {
throw new Error("Missing required property 'role'");
}
resourceInputs["condition"] = args?.condition;
resourceInputs["datasetId"] = args?.datasetId;
resourceInputs["member"] = args?.member;
resourceInputs["project"] = args?.project;
resourceInputs["role"] = args?.role;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(DatasetIamMember.__pulumiType, name, resourceInputs, opts);
}
}
exports.DatasetIamMember = DatasetIamMember;
/** @internal */
DatasetIamMember.__pulumiType = 'gcp:bigquery/datasetIamMember:DatasetIamMember';
//# sourceMappingURL=datasetIamMember.js.map