@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
227 lines • 9.88 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.WorkforcePoolIamPolicy = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Three different resources help you manage your IAM policy for Cloud IAM WorkforcePool. Each of these resources serves a different use case:
*
* * `gcp.iam.WorkforcePoolIamPolicy`: Authoritative. Sets the IAM policy for the workforcepool and replaces any existing policy already attached.
* * `gcp.iam.WorkforcePoolIamBinding`: 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 workforcepool are preserved.
* * `gcp.iam.WorkforcePoolIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the workforcepool are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.iam.WorkforcePoolIamPolicy`: Retrieves the IAM policy for the workforcepool
*
* > **Note:** `gcp.iam.WorkforcePoolIamPolicy` **cannot** be used in conjunction with `gcp.iam.WorkforcePoolIamBinding` and `gcp.iam.WorkforcePoolIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.iam.WorkforcePoolIamBinding` resources **can be** used in conjunction with `gcp.iam.WorkforcePoolIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.iam.WorkforcePoolIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/iam.workforcePoolAdmin",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.iam.WorkforcePoolIamPolicy("policy", {
* location: example.location,
* workforcePoolId: example.workforcePoolId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.iam.WorkforcePoolIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.iam.WorkforcePoolIamBinding("binding", {
* location: example.location,
* workforcePoolId: example.workforcePoolId,
* role: "roles/iam.workforcePoolAdmin",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.iam.WorkforcePoolIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.iam.WorkforcePoolIamMember("member", {
* location: example.location,
* workforcePoolId: example.workforcePoolId,
* role: "roles/iam.workforcePoolAdmin",
* 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 Cloud IAM WorkforcePool
*
* Three different resources help you manage your IAM policy for Cloud IAM WorkforcePool. Each of these resources serves a different use case:
*
* * `gcp.iam.WorkforcePoolIamPolicy`: Authoritative. Sets the IAM policy for the workforcepool and replaces any existing policy already attached.
* * `gcp.iam.WorkforcePoolIamBinding`: 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 workforcepool are preserved.
* * `gcp.iam.WorkforcePoolIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the workforcepool are preserved.
*
* A data source can be used to retrieve policy data in advent you do not need creation
*
* * `gcp.iam.WorkforcePoolIamPolicy`: Retrieves the IAM policy for the workforcepool
*
* > **Note:** `gcp.iam.WorkforcePoolIamPolicy` **cannot** be used in conjunction with `gcp.iam.WorkforcePoolIamBinding` and `gcp.iam.WorkforcePoolIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.iam.WorkforcePoolIamBinding` resources **can be** used in conjunction with `gcp.iam.WorkforcePoolIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.iam.WorkforcePoolIamPolicy
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const admin = gcp.organizations.getIAMPolicy({
* bindings: [{
* role: "roles/iam.workforcePoolAdmin",
* members: ["user:jane@example.com"],
* }],
* });
* const policy = new gcp.iam.WorkforcePoolIamPolicy("policy", {
* location: example.location,
* workforcePoolId: example.workforcePoolId,
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.iam.WorkforcePoolIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const binding = new gcp.iam.WorkforcePoolIamBinding("binding", {
* location: example.location,
* workforcePoolId: example.workforcePoolId,
* role: "roles/iam.workforcePoolAdmin",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.iam.WorkforcePoolIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const member = new gcp.iam.WorkforcePoolIamMember("member", {
* location: example.location,
* workforcePoolId: example.workforcePoolId,
* role: "roles/iam.workforcePoolAdmin",
* member: "user:jane@example.com",
* });
* ```
*
* ## Import
*
* For all import syntaxes, the "resource in question" can take any of the following forms:
*
* * locations/{{location}}/workforcePools/{{workforce_pool_id}}
*
* * {{location}}/{{workforce_pool_id}}
*
* * {{workforce_pool_id}}
*
* Any variables not passed in the import command will be taken from the provider configuration.
*
* Cloud IAM workforcepool 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:iam/workforcePoolIamPolicy:WorkforcePoolIamPolicy editor "locations/{{location}}/workforcePools/{{workforce_pool_id}} roles/iam.workforcePoolViewer user:jane@example.com"
* ```
*
* IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.
*
* ```sh
* $ pulumi import gcp:iam/workforcePoolIamPolicy:WorkforcePoolIamPolicy editor "locations/{{location}}/workforcePools/{{workforce_pool_id}} roles/iam.workforcePoolViewer"
* ```
*
* IAM policy imports use the identifier of the resource in question, e.g.
*
* ```sh
* $ pulumi import gcp:iam/workforcePoolIamPolicy:WorkforcePoolIamPolicy editor locations/{{location}}/workforcePools/{{workforce_pool_id}}
* ```
*
* -> **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 WorkforcePoolIamPolicy extends pulumi.CustomResource {
/**
* Get an existing WorkforcePoolIamPolicy 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 WorkforcePoolIamPolicy(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of WorkforcePoolIamPolicy. 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'] === WorkforcePoolIamPolicy.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["etag"] = state?.etag;
resourceInputs["location"] = state?.location;
resourceInputs["policyData"] = state?.policyData;
resourceInputs["workforcePoolId"] = state?.workforcePoolId;
}
else {
const args = argsOrState;
if (args?.policyData === undefined && !opts.urn) {
throw new Error("Missing required property 'policyData'");
}
if (args?.workforcePoolId === undefined && !opts.urn) {
throw new Error("Missing required property 'workforcePoolId'");
}
resourceInputs["location"] = args?.location;
resourceInputs["policyData"] = args?.policyData;
resourceInputs["workforcePoolId"] = args?.workforcePoolId;
resourceInputs["etag"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(WorkforcePoolIamPolicy.__pulumiType, name, resourceInputs, opts);
}
}
exports.WorkforcePoolIamPolicy = WorkforcePoolIamPolicy;
/** @internal */
WorkforcePoolIamPolicy.__pulumiType = 'gcp:iam/workforcePoolIamPolicy:WorkforcePoolIamPolicy';
//# sourceMappingURL=workforcePoolIamPolicy.js.map