@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
373 lines • 15.9 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.SubnetworkIAMBinding = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Three different resources help you manage your IAM policy for Compute Engine Subnetwork. Each of these resources serves a different use case:
*
* * `gcp.compute.SubnetworkIAMPolicy`: Authoritative. Sets the IAM policy for the subnetwork and replaces any existing policy already attached.
* * `gcp.compute.SubnetworkIAMBinding`: 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 subnetwork are preserved.
* * `gcp.compute.SubnetworkIAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the subnetwork are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.compute.SubnetworkIAMPolicy`: Retrieves the IAM policy for the subnetwork
*
* > **Note:** `gcp.compute.SubnetworkIAMPolicy` **cannot** be used in conjunction with `gcp.compute.SubnetworkIAMBinding` and `gcp.compute.SubnetworkIAMMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.compute.SubnetworkIAMBinding` resources **can be** used in conjunction with `gcp.compute.SubnetworkIAMMember` resources **only if** they do not grant privilege to the same role.
*
* > **Note:** This resource supports IAM Conditions but they have some known limitations which can be found [here](https://cloud.google.com/iam/docs/conditions-overview#limitations). Please review this article if you are having issues with IAM Conditions.
*
* ## gcp.compute.SubnetworkIAMPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/compute.networkUser",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.compute.SubnetworkIAMPolicy("policy", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/compute.networkUser",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* }],
* });
* const policy = new gcp.compute.SubnetworkIAMPolicy("policy", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
* ## gcp.compute.SubnetworkIAMBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.compute.SubnetworkIAMBinding("binding", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* role: "roles/compute.networkUser",
* members: ["user:jane@example.com"],
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.compute.SubnetworkIAMBinding("binding", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* role: "roles/compute.networkUser",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
* ## gcp.compute.SubnetworkIAMMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.compute.SubnetworkIAMMember("member", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* role: "roles/compute.networkUser",
* member: "user:jane@example.com",
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.compute.SubnetworkIAMMember("member", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* role: "roles/compute.networkUser",
* member: "user:jane@example.com",
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
*
* ## This resource supports User Project Overrides.
*
* -
*
* # IAM policy for Compute Engine Subnetwork
*
* Three different resources help you manage your IAM policy for Compute Engine Subnetwork. Each of these resources serves a different use case:
*
* * `gcp.compute.SubnetworkIAMPolicy`: Authoritative. Sets the IAM policy for the subnetwork and replaces any existing policy already attached.
* * `gcp.compute.SubnetworkIAMBinding`: 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 subnetwork are preserved.
* * `gcp.compute.SubnetworkIAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the subnetwork are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.compute.SubnetworkIAMPolicy`: Retrieves the IAM policy for the subnetwork
*
* > **Note:** `gcp.compute.SubnetworkIAMPolicy` **cannot** be used in conjunction with `gcp.compute.SubnetworkIAMBinding` and `gcp.compute.SubnetworkIAMMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.compute.SubnetworkIAMBinding` resources **can be** used in conjunction with `gcp.compute.SubnetworkIAMMember` resources **only if** they do not grant privilege to the same role.
*
* > **Note:** This resource supports IAM Conditions but they have some known limitations which can be found [here](https://cloud.google.com/iam/docs/conditions-overview#limitations). Please review this article if you are having issues with IAM Conditions.
*
* ## gcp.compute.SubnetworkIAMPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/compute.networkUser",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.compute.SubnetworkIAMPolicy("policy", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/compute.networkUser",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* }],
* });
* const policy = new gcp.compute.SubnetworkIAMPolicy("policy", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
* ## gcp.compute.SubnetworkIAMBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.compute.SubnetworkIAMBinding("binding", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* role: "roles/compute.networkUser",
* members: ["user:jane@example.com"],
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.compute.SubnetworkIAMBinding("binding", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* role: "roles/compute.networkUser",
* members: ["user:jane@example.com"],
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
* ## gcp.compute.SubnetworkIAMMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.compute.SubnetworkIAMMember("member", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* role: "roles/compute.networkUser",
* member: "user:jane@example.com",
* });
* ```
*
* With IAM Conditions:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.compute.SubnetworkIAMMember("member", {
* project: network_with_private_secondary_ip_ranges.project,
* region: network_with_private_secondary_ip_ranges.region,
* subnetwork: network_with_private_secondary_ip_ranges.name,
* role: "roles/compute.networkUser",
* member: "user:jane@example.com",
* condition: {
* title: "expires_after_2019_12_31",
* description: "Expiring at midnight of 2019-12-31",
* expression: "request.time < timestamp(\"2020-01-01T00:00:00Z\")",
* },
* });
* ```
*
* ## Import
*
* For all import syntaxes, the "resource in question" can take any of the following forms:
*
* * projects/{{project}}/regions/{{region}}/subnetworks/{{name}}
*
* * {{project}}/{{region}}/{{name}}
*
* * {{region}}/{{name}}
*
* * {{name}}
*
* Any variables not passed in the import command will be taken from the provider configuration.
*
* Compute Engine subnetwork 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:compute/subnetworkIAMBinding:SubnetworkIAMBinding editor "projects/{{project}}/regions/{{region}}/subnetworks/{{subnetwork}} roles/compute.networkUser user:jane@example.com"
* ```
*
* IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
*
* ```sh
* $ pulumi import gcp:compute/subnetworkIAMBinding:SubnetworkIAMBinding editor "projects/{{project}}/regions/{{region}}/subnetworks/{{subnetwork}} roles/compute.networkUser"
* ```
*
* IAM policy imports use the identifier of the resource in question, e.g.
*
* ```sh
* $ pulumi import gcp:compute/subnetworkIAMBinding:SubnetworkIAMBinding editor projects/{{project}}/regions/{{region}}/subnetworks/{{subnetwork}}
* ```
*
* -> **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 SubnetworkIAMBinding extends pulumi.CustomResource {
/**
* Get an existing SubnetworkIAMBinding 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 SubnetworkIAMBinding(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of SubnetworkIAMBinding. 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'] === SubnetworkIAMBinding.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["condition"] = state?.condition;
resourceInputs["etag"] = state?.etag;
resourceInputs["members"] = state?.members;
resourceInputs["project"] = state?.project;
resourceInputs["region"] = state?.region;
resourceInputs["role"] = state?.role;
resourceInputs["subnetwork"] = state?.subnetwork;
}
else {
const args = argsOrState;
if (args?.members === undefined && !opts.urn) {
throw new Error("Missing required property 'members'");
}
if (args?.role === undefined && !opts.urn) {
throw new Error("Missing required property 'role'");
}
if (args?.subnetwork === undefined && !opts.urn) {
throw new Error("Missing required property 'subnetwork'");
}
resourceInputs["condition"] = args?.condition;
resourceInputs["members"] = args?.members;
resourceInputs["project"] = args?.project;
resourceInputs["region"] = args?.region;
resourceInputs["role"] = args?.role;
resourceInputs["subnetwork"] = args?.subnetwork;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(SubnetworkIAMBinding.__pulumiType, name, resourceInputs, opts);
}
}
exports.SubnetworkIAMBinding = SubnetworkIAMBinding;
/** @internal */
SubnetworkIAMBinding.__pulumiType = 'gcp:compute/subnetworkIAMBinding:SubnetworkIAMBinding';
//# sourceMappingURL=subnetworkIAMBinding.js.map