@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
246 lines • 10.6 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! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.EnvironmentIamPolicy = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* Three different resources help you manage your IAM policy for Apigee Environment. Each of these resources serves a different use case:
*
* * `gcp.apigee.EnvironmentIamPolicy`: Authoritative. Sets the IAM policy for the environment and replaces any existing policy already attached.
* * `gcp.apigee.EnvironmentIamBinding`: 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 environment are preserved.
* * `gcp.apigee.EnvironmentIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the environment are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.apigee.EnvironmentIamPolicy`: Retrieves the IAM policy for the environment
*
* > **Note:** `gcp.apigee.EnvironmentIamPolicy` **cannot** be used in conjunction with `gcp.apigee.EnvironmentIamBinding` and `gcp.apigee.EnvironmentIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.apigee.EnvironmentIamBinding` resources **can be** used in conjunction with `gcp.apigee.EnvironmentIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.apigee.EnvironmentIamPolicy
*
* ```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.apigee.EnvironmentIamPolicy("policy", {
* orgId: apigeeEnvironment.orgId,
* envId: apigeeEnvironment.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.apigee.EnvironmentIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.apigee.EnvironmentIamBinding("binding", {
* orgId: apigeeEnvironment.orgId,
* envId: apigeeEnvironment.name,
* role: "roles/viewer",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.apigee.EnvironmentIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.apigee.EnvironmentIamMember("member", {
* orgId: apigeeEnvironment.orgId,
* envId: apigeeEnvironment.name,
* role: "roles/viewer",
* member: "user:jane@example.com",
* });
* ```
*
* ## > **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`.
* ---
*
* # IAM policy for Apigee Environment
*
* Three different resources help you manage your IAM policy for Apigee Environment. Each of these resources serves a different use case:
*
* * `gcp.apigee.EnvironmentIamPolicy`: Authoritative. Sets the IAM policy for the environment and replaces any existing policy already attached.
* * `gcp.apigee.EnvironmentIamBinding`: 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 environment are preserved.
* * `gcp.apigee.EnvironmentIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the environment are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.apigee.EnvironmentIamPolicy`: Retrieves the IAM policy for the environment
*
* > **Note:** `gcp.apigee.EnvironmentIamPolicy` **cannot** be used in conjunction with `gcp.apigee.EnvironmentIamBinding` and `gcp.apigee.EnvironmentIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.apigee.EnvironmentIamBinding` resources **can be** used in conjunction with `gcp.apigee.EnvironmentIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.apigee.EnvironmentIamPolicy
*
* ```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.apigee.EnvironmentIamPolicy("policy", {
* orgId: apigeeEnvironment.orgId,
* envId: apigeeEnvironment.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.apigee.EnvironmentIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.apigee.EnvironmentIamBinding("binding", {
* orgId: apigeeEnvironment.orgId,
* envId: apigeeEnvironment.name,
* role: "roles/viewer",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.apigee.EnvironmentIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.apigee.EnvironmentIamMember("member", {
* orgId: apigeeEnvironment.orgId,
* envId: apigeeEnvironment.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:
*
* * {{org_id}}/environments/{{name}}
* * {{name}}
*
* Any variables not passed in the import command will be taken from the provider configuration.
*
* Apigee environment 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
* $ terraform import google_apigee_environment_iam_member.editor "{{org_id}}/environments/{{environment}} roles/viewer user:jane@example.com"
* ```
*
* IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
* ```sh
* $ terraform import google_apigee_environment_iam_binding.editor "{{org_id}}/environments/{{environment}} roles/viewer"
* ```
*
* IAM policy imports use the identifier of the resource in question, e.g.
* ```sh
* $ pulumi import gcp:apigee/environmentIamPolicy:EnvironmentIamPolicy editor {{org_id}}/environments/{{environment}}
* ```
*
* > **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 EnvironmentIamPolicy extends pulumi.CustomResource {
/**
* Get an existing EnvironmentIamPolicy 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 EnvironmentIamPolicy(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'gcp:apigee/environmentIamPolicy:EnvironmentIamPolicy';
/**
* Returns true if the given object is an instance of EnvironmentIamPolicy. 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'] === EnvironmentIamPolicy.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["envId"] = state?.envId;
resourceInputs["etag"] = state?.etag;
resourceInputs["orgId"] = state?.orgId;
resourceInputs["policyData"] = state?.policyData;
}
else {
const args = argsOrState;
if (args?.envId === undefined && !opts.urn) {
throw new Error("Missing required property 'envId'");
}
if (args?.orgId === undefined && !opts.urn) {
throw new Error("Missing required property 'orgId'");
}
if (args?.policyData === undefined && !opts.urn) {
throw new Error("Missing required property 'policyData'");
}
resourceInputs["envId"] = args?.envId;
resourceInputs["orgId"] = args?.orgId;
resourceInputs["policyData"] = args?.policyData;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(EnvironmentIamPolicy.__pulumiType, name, resourceInputs, opts);
}
}
exports.EnvironmentIamPolicy = EnvironmentIamPolicy;
//# sourceMappingURL=environmentIamPolicy.js.map