@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
242 lines • 10.5 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.InstanceIamMember = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Three different resources help you manage your IAM policy for Cloud AI Notebooks Instance. Each of these resources serves a different use case:
*
* * `gcp.notebooks.InstanceIamPolicy`: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
* * `gcp.notebooks.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.notebooks.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.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.notebooks.InstanceIamPolicy`: Retrieves the IAM policy for the instance
*
* > **Note:** `gcp.notebooks.InstanceIamPolicy` **cannot** be used in conjunction with `gcp.notebooks.InstanceIamBinding` and `gcp.notebooks.InstanceIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.notebooks.InstanceIamBinding` resources **can be** used in conjunction with `gcp.notebooks.InstanceIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.notebooks.InstanceIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/viewer",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.notebooks.InstanceIamPolicy("policy", {
* project: instance.project,
* location: instance.location,
* instanceName: instance.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.notebooks.InstanceIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.notebooks.InstanceIamBinding("binding", {
* project: instance.project,
* location: instance.location,
* instanceName: instance.name,
* role: "roles/viewer",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.notebooks.InstanceIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.notebooks.InstanceIamMember("member", {
* project: instance.project,
* location: instance.location,
* instanceName: instance.name,
* role: "roles/viewer",
* member: "user:jane@example.com",
* });
* ```
*
* ## This resource supports User Project Overrides.
*
* -
*
* # IAM policy for Cloud AI Notebooks Instance
* Three different resources help you manage your IAM policy for Cloud AI Notebooks Instance. Each of these resources serves a different use case:
*
* * `gcp.notebooks.InstanceIamPolicy`: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.
* * `gcp.notebooks.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.notebooks.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.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.notebooks.InstanceIamPolicy`: Retrieves the IAM policy for the instance
*
* > **Note:** `gcp.notebooks.InstanceIamPolicy` **cannot** be used in conjunction with `gcp.notebooks.InstanceIamBinding` and `gcp.notebooks.InstanceIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.notebooks.InstanceIamBinding` resources **can be** used in conjunction with `gcp.notebooks.InstanceIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.notebooks.InstanceIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/viewer",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.notebooks.InstanceIamPolicy("policy", {
* project: instance.project,
* location: instance.location,
* instanceName: instance.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.notebooks.InstanceIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.notebooks.InstanceIamBinding("binding", {
* project: instance.project,
* location: instance.location,
* instanceName: instance.name,
* role: "roles/viewer",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.notebooks.InstanceIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.notebooks.InstanceIamMember("member", {
* project: instance.project,
* location: instance.location,
* instanceName: instance.name,
* role: "roles/viewer",
* member: "user:jane@example.com",
* });
* ```
*
* ## Import
*
* For all import syntaxes, the "resource in question" can take any of the following forms:
*
* * projects/{{project}}/locations/{{location}}/instances/{{instance_name}}
*
* * {{project}}/{{location}}/{{instance_name}}
*
* * {{location}}/{{instance_name}}
*
* * {{instance_name}}
*
* Any variables not passed in the import command will be taken from the provider configuration.
*
* Cloud AI Notebooks instance 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:notebooks/instanceIamMember:InstanceIamMember editor "projects/{{project}}/locations/{{location}}/instances/{{instance_name}} roles/viewer user:jane@example.com"
* ```
*
* IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
*
* ```sh
* $ pulumi import gcp:notebooks/instanceIamMember:InstanceIamMember editor "projects/{{project}}/locations/{{location}}/instances/{{instance_name}} roles/viewer"
* ```
*
* IAM policy imports use the identifier of the resource in question, e.g.
*
* ```sh
* $ pulumi import gcp:notebooks/instanceIamMember:InstanceIamMember editor projects/{{project}}/locations/{{location}}/instances/{{instance_name}}
* ```
*
* -> **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 InstanceIamMember extends pulumi.CustomResource {
/**
* Get an existing InstanceIamMember 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 InstanceIamMember(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of InstanceIamMember. 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'] === InstanceIamMember.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["condition"] = state ? state.condition : undefined;
resourceInputs["etag"] = state ? state.etag : undefined;
resourceInputs["instanceName"] = state ? state.instanceName : undefined;
resourceInputs["location"] = state ? state.location : undefined;
resourceInputs["member"] = state ? state.member : undefined;
resourceInputs["project"] = state ? state.project : undefined;
resourceInputs["role"] = state ? state.role : undefined;
}
else {
const args = argsOrState;
if ((!args || args.instanceName === undefined) && !opts.urn) {
throw new Error("Missing required property 'instanceName'");
}
if ((!args || args.member === undefined) && !opts.urn) {
throw new Error("Missing required property 'member'");
}
if ((!args || args.role === undefined) && !opts.urn) {
throw new Error("Missing required property 'role'");
}
resourceInputs["condition"] = args ? args.condition : undefined;
resourceInputs["instanceName"] = args ? args.instanceName : undefined;
resourceInputs["location"] = args ? args.location : undefined;
resourceInputs["member"] = args ? args.member : undefined;
resourceInputs["project"] = args ? args.project : undefined;
resourceInputs["role"] = args ? args.role : undefined;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(InstanceIamMember.__pulumiType, name, resourceInputs, opts);
}
}
exports.InstanceIamMember = InstanceIamMember;
/** @internal */
InstanceIamMember.__pulumiType = 'gcp:notebooks/instanceIamMember:InstanceIamMember';
//# sourceMappingURL=instanceIamMember.js.map