@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
226 lines • 8.99 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.ApiIamPolicy = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:
*
* * `gcp.apigateway.ApiIamPolicy`: Authoritative. Sets the IAM policy for the api and replaces any existing policy already attached.
* * `gcp.apigateway.ApiIamBinding`: 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 api are preserved.
* * `gcp.apigateway.ApiIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the api are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.apigateway.ApiIamPolicy`: Retrieves the IAM policy for the api
*
* > **Note:** `gcp.apigateway.ApiIamPolicy` **cannot** be used in conjunction with `gcp.apigateway.ApiIamBinding` and `gcp.apigateway.ApiIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.apigateway.ApiIamBinding` resources **can be** used in conjunction with `gcp.apigateway.ApiIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.apigateway.ApiIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/apigateway.viewer",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.apigateway.ApiIamPolicy("policy", {
* project: api.project,
* api: api.apiId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.apigateway.ApiIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.apigateway.ApiIamBinding("binding", {
* project: api.project,
* api: api.apiId,
* role: "roles/apigateway.viewer",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.apigateway.ApiIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.apigateway.ApiIamMember("member", {
* project: api.project,
* api: api.apiId,
* role: "roles/apigateway.viewer",
* member: "user:jane@example.com",
* });
* ```
*
* ## This resource supports User Project Overrides.
*
* -
*
* # IAM policy for API Gateway Api
*
* Three different resources help you manage your IAM policy for API Gateway Api. Each of these resources serves a different use case:
*
* * `gcp.apigateway.ApiIamPolicy`: Authoritative. Sets the IAM policy for the api and replaces any existing policy already attached.
* * `gcp.apigateway.ApiIamBinding`: 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 api are preserved.
* * `gcp.apigateway.ApiIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the api are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.apigateway.ApiIamPolicy`: Retrieves the IAM policy for the api
*
* > **Note:** `gcp.apigateway.ApiIamPolicy` **cannot** be used in conjunction with `gcp.apigateway.ApiIamBinding` and `gcp.apigateway.ApiIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.apigateway.ApiIamBinding` resources **can be** used in conjunction with `gcp.apigateway.ApiIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.apigateway.ApiIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/apigateway.viewer",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.apigateway.ApiIamPolicy("policy", {
* project: api.project,
* api: api.apiId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.apigateway.ApiIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.apigateway.ApiIamBinding("binding", {
* project: api.project,
* api: api.apiId,
* role: "roles/apigateway.viewer",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.apigateway.ApiIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.apigateway.ApiIamMember("member", {
* project: api.project,
* api: api.apiId,
* role: "roles/apigateway.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/global/apis/{{api}}
*
* * {{project}}/{{api}}
*
* * {{api}}
*
* Any variables not passed in the import command will be taken from the provider configuration.
*
* API Gateway api 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:apigateway/apiIamPolicy:ApiIamPolicy editor "projects/{{project}}/locations/global/apis/{{api}} roles/apigateway.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:apigateway/apiIamPolicy:ApiIamPolicy editor "projects/{{project}}/locations/global/apis/{{api}} roles/apigateway.viewer"
* ```
*
* IAM policy imports use the identifier of the resource in question, e.g.
*
* ```sh
* $ pulumi import gcp:apigateway/apiIamPolicy:ApiIamPolicy editor projects/{{project}}/locations/global/apis/{{api}}
* ```
*
* -> **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 ApiIamPolicy extends pulumi.CustomResource {
/**
* Get an existing ApiIamPolicy 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 ApiIamPolicy(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of ApiIamPolicy. 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'] === ApiIamPolicy.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["api"] = state?.api;
resourceInputs["etag"] = state?.etag;
resourceInputs["policyData"] = state?.policyData;
resourceInputs["project"] = state?.project;
}
else {
const args = argsOrState;
if (args?.api === undefined && !opts.urn) {
throw new Error("Missing required property 'api'");
}
if (args?.policyData === undefined && !opts.urn) {
throw new Error("Missing required property 'policyData'");
}
resourceInputs["api"] = args?.api;
resourceInputs["policyData"] = args?.policyData;
resourceInputs["project"] = args?.project;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(ApiIamPolicy.__pulumiType, name, resourceInputs, opts);
}
}
exports.ApiIamPolicy = ApiIamPolicy;
/** @internal */
ApiIamPolicy.__pulumiType = 'gcp:apigateway/apiIamPolicy:ApiIamPolicy';
//# sourceMappingURL=apiIamPolicy.js.map