@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
188 lines • 7.02 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.InstanceIamPolicy = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Three different resources help you manage IAM policies on bigtable instances. Each of these resources serves a different use case:
*
* * `gcp.bigtable.InstanceIamPolicy`: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
* * `gcp.bigtable.InstanceIamBinding`: 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 instance are preserved.
* * `gcp.bigtable.InstanceIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the instance are preserved.
*
* > **Note:** `gcp.bigtable.InstanceIamPolicy` **cannot** be used in conjunction with `gcp.bigtable.InstanceIamBinding` and `gcp.bigtable.InstanceIamMember` or they will fight over what your policy should be. In addition, be careful not to accidentally unset ownership of the instance as `gcp.bigtable.InstanceIamPolicy` replaces the entire policy.
*
* > **Note:** `gcp.bigtable.InstanceIamBinding` resources **can be** used in conjunction with `gcp.bigtable.InstanceIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.bigtable.InstanceIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/bigtable.user",
* members: ["user:jane@example.com"],
* }],
* });
* const editor = new gcp.bigtable.InstanceIamPolicy("editor", {
* project: "your-project",
* instance: "your-bigtable-instance",
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.bigtable.InstanceIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const editor = new gcp.bigtable.InstanceIamBinding("editor", {
* instance: "your-bigtable-instance",
* role: "roles/bigtable.user",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.bigtable.InstanceIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const editor = new gcp.bigtable.InstanceIamMember("editor", {
* instance: "your-bigtable-instance",
* role: "roles/bigtable.user",
* member: "user:jane@example.com",
* });
* ```
*
* ## gcp.bigtable.InstanceIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/bigtable.user",
* members: ["user:jane@example.com"],
* }],
* });
* const editor = new gcp.bigtable.InstanceIamPolicy("editor", {
* project: "your-project",
* instance: "your-bigtable-instance",
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.bigtable.InstanceIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const editor = new gcp.bigtable.InstanceIamBinding("editor", {
* instance: "your-bigtable-instance",
* role: "roles/bigtable.user",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.bigtable.InstanceIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const editor = new gcp.bigtable.InstanceIamMember("editor", {
* instance: "your-bigtable-instance",
* role: "roles/bigtable.user",
* member: "user:jane@example.com",
* });
* ```
*
* ## Import
*
* ### Importing IAM policies
*
* IAM policy imports use the `instance` identifier of the Bigtable Instance resource only. For example:
*
* * `"projects/{project}/instances/{instance}"`
*
* An `import` block (Terraform v1.5.0 and later) can be used to import IAM policies:
*
* tf
*
* import {
*
* id = "projects/{project}/instances/{instance}"
*
* to = google_bigtable_instance_iam_policy.default
*
* }
*
* The `pulumi import` command can also be used:
*
* ```sh
* $ pulumi import gcp:bigtable/instanceIamPolicy:InstanceIamPolicy default projects/{project}/instances/{instance}
* ```
*/
class InstanceIamPolicy extends pulumi.CustomResource {
/**
* Get an existing InstanceIamPolicy 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 InstanceIamPolicy(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of InstanceIamPolicy. 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'] === InstanceIamPolicy.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["etag"] = state?.etag;
resourceInputs["instance"] = state?.instance;
resourceInputs["policyData"] = state?.policyData;
resourceInputs["project"] = state?.project;
}
else {
const args = argsOrState;
if (args?.instance === undefined && !opts.urn) {
throw new Error("Missing required property 'instance'");
}
if (args?.policyData === undefined && !opts.urn) {
throw new Error("Missing required property 'policyData'");
}
resourceInputs["instance"] = args?.instance;
resourceInputs["policyData"] = args?.policyData;
resourceInputs["project"] = args?.project;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(InstanceIamPolicy.__pulumiType, name, resourceInputs, opts);
}
}
exports.InstanceIamPolicy = InstanceIamPolicy;
/** @internal */
InstanceIamPolicy.__pulumiType = 'gcp:bigtable/instanceIamPolicy:InstanceIamPolicy';
//# sourceMappingURL=instanceIamPolicy.js.map