@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
246 lines • 9.79 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.IamMember = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Three different resources help you manage your IAM policy for BigQuery Table. Each of these resources serves a different use case:
*
* * `gcp.bigquery.IamPolicy`: Authoritative. Sets the IAM policy for the table and replaces any existing policy already attached.
* * `gcp.bigquery.IamBinding`: 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 table are preserved.
* * `gcp.bigquery.IamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the table are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.bigquery.IamPolicy`: Retrieves the IAM policy for the table
*
* > **Note:** `gcp.bigquery.IamPolicy` **cannot** be used in conjunction with `gcp.bigquery.IamBinding` and `gcp.bigquery.IamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.bigquery.IamBinding` resources **can be** used in conjunction with `gcp.bigquery.IamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.bigquery.IamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/bigquery.dataOwner",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.bigquery.IamPolicy("policy", {
* project: test.project,
* datasetId: test.datasetId,
* tableId: test.tableId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.bigquery.IamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.bigquery.IamBinding("binding", {
* project: test.project,
* datasetId: test.datasetId,
* tableId: test.tableId,
* role: "roles/bigquery.dataOwner",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.bigquery.IamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.bigquery.IamMember("member", {
* project: test.project,
* datasetId: test.datasetId,
* tableId: test.tableId,
* role: "roles/bigquery.dataOwner",
* member: "user:jane@example.com",
* });
* ```
*
* ## This resource supports User Project Overrides.
*
* -
*
* # IAM policy for BigQuery Table
*
* Three different resources help you manage your IAM policy for BigQuery Table. Each of these resources serves a different use case:
*
* * `gcp.bigquery.IamPolicy`: Authoritative. Sets the IAM policy for the table and replaces any existing policy already attached.
* * `gcp.bigquery.IamBinding`: 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 table are preserved.
* * `gcp.bigquery.IamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the table are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.bigquery.IamPolicy`: Retrieves the IAM policy for the table
*
* > **Note:** `gcp.bigquery.IamPolicy` **cannot** be used in conjunction with `gcp.bigquery.IamBinding` and `gcp.bigquery.IamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.bigquery.IamBinding` resources **can be** used in conjunction with `gcp.bigquery.IamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.bigquery.IamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/bigquery.dataOwner",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.bigquery.IamPolicy("policy", {
* project: test.project,
* datasetId: test.datasetId,
* tableId: test.tableId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.bigquery.IamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.bigquery.IamBinding("binding", {
* project: test.project,
* datasetId: test.datasetId,
* tableId: test.tableId,
* role: "roles/bigquery.dataOwner",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.bigquery.IamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.bigquery.IamMember("member", {
* project: test.project,
* datasetId: test.datasetId,
* tableId: test.tableId,
* role: "roles/bigquery.dataOwner",
* member: "user:jane@example.com",
* });
* ```
*
* ## Import
*
* For all import syntaxes, the "resource in question" can take any of the following forms:
*
* * projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}
*
* * {{project}}/{{dataset_id}}/{{table_id}}
*
* * {{dataset_id}}/{{table_id}}
*
* * {{table_id}}
*
* Any variables not passed in the import command will be taken from the provider configuration.
*
* BigQuery table IAM resources can be imported using the resource identifiers, role, and member.
*
* IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.
*
* ```sh
* $ pulumi import gcp:bigquery/iamMember:IamMember editor "projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}} roles/bigquery.dataOwner user:jane@example.com"
* ```
*
* IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
*
* ```sh
* $ pulumi import gcp:bigquery/iamMember:IamMember editor "projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}} roles/bigquery.dataOwner"
* ```
*
* IAM policy imports use the identifier of the resource in question, e.g.
*
* ```sh
* $ pulumi import gcp:bigquery/iamMember:IamMember editor projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}
* ```
*
* -> **Custom Roles** If you're importing a IAM resource with a custom role, make sure to use the
*
* full name of the custom role, e.g. `[projects/my-project|organizations/my-org]/roles/my-custom-role`.
*/
class IamMember extends pulumi.CustomResource {
/**
* Get an existing IamMember 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 IamMember(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of IamMember. 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'] === IamMember.__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;
resourceInputs["tableId"] = state?.tableId;
}
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'");
}
if (args?.tableId === undefined && !opts.urn) {
throw new Error("Missing required property 'tableId'");
}
resourceInputs["condition"] = args?.condition;
resourceInputs["datasetId"] = args?.datasetId;
resourceInputs["member"] = args?.member;
resourceInputs["project"] = args?.project;
resourceInputs["role"] = args?.role;
resourceInputs["tableId"] = args?.tableId;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(IamMember.__pulumiType, name, resourceInputs, opts);
}
}
exports.IamMember = IamMember;
/** @internal */
IamMember.__pulumiType = 'gcp:bigquery/iamMember:IamMember';
//# sourceMappingURL=iamMember.js.map