UNPKG

@pulumi/gcp

Version:

A Pulumi package for creating and managing Google Cloud Platform resources.

192 lines 6.89 kB
"use strict"; // *** 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.JobIAMPolicy = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("../utilities"); /** * Three different resources help you manage IAM policies on dataproc jobs. Each of these resources serves a different use case: * * * `gcp.dataproc.JobIAMPolicy`: Authoritative. Sets the IAM policy for the job and replaces any existing policy already attached. * * `gcp.dataproc.JobIAMBinding`: 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 job are preserved. * * `gcp.dataproc.JobIAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the job are preserved. * * > **Note:** `gcp.dataproc.JobIAMPolicy` **cannot** be used in conjunction with `gcp.dataproc.JobIAMBinding` and `gcp.dataproc.JobIAMMember` or they will fight over what your policy should be. In addition, be careful not to accidentally unset ownership of the job as `gcp.dataproc.JobIAMPolicy` replaces the entire policy. * * > **Note:** `gcp.dataproc.JobIAMBinding` resources **can be** used in conjunction with `gcp.dataproc.JobIAMMember` resources **only if** they do not grant privilege to the same role. * * ## gcp.dataproc.JobIAMPolicy * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const admin = gcp.organizations.getIAMPolicy({ * bindings: [{ * role: "roles/editor", * members: ["user:jane@example.com"], * }], * }); * const editor = new gcp.dataproc.JobIAMPolicy("editor", { * project: "your-project", * region: "your-region", * jobId: "your-dataproc-job", * policyData: admin.then(admin => admin.policyData), * }); * ``` * * ## gcp.dataproc.JobIAMBinding * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const editor = new gcp.dataproc.JobIAMBinding("editor", { * jobId: "your-dataproc-job", * role: "roles/editor", * members: ["user:jane@example.com"], * }); * ``` * * ## gcp.dataproc.JobIAMMember * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const editor = new gcp.dataproc.JobIAMMember("editor", { * jobId: "your-dataproc-job", * role: "roles/editor", * member: "user:jane@example.com", * }); * ``` * * ## gcp.dataproc.JobIAMPolicy * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const admin = gcp.organizations.getIAMPolicy({ * bindings: [{ * role: "roles/editor", * members: ["user:jane@example.com"], * }], * }); * const editor = new gcp.dataproc.JobIAMPolicy("editor", { * project: "your-project", * region: "your-region", * jobId: "your-dataproc-job", * policyData: admin.then(admin => admin.policyData), * }); * ``` * * ## gcp.dataproc.JobIAMBinding * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const editor = new gcp.dataproc.JobIAMBinding("editor", { * jobId: "your-dataproc-job", * role: "roles/editor", * members: ["user:jane@example.com"], * }); * ``` * * ## gcp.dataproc.JobIAMMember * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const editor = new gcp.dataproc.JobIAMMember("editor", { * jobId: "your-dataproc-job", * role: "roles/editor", * member: "user:jane@example.com", * }); * ``` * * ## Import * * ### Importing IAM policies * * IAM policy imports use the `job_id` identifier of the Dataproc Job resource only. For example: * * * `projects/{project}/regions/{region}/jobs/{job_id}` * * An `import` block (Terraform v1.5.0 and later) can be used to import IAM policies: * * tf * * import { * * id = "projects/{project}/regions/{region}/jobs/{job_id}" * * to = google_dataproc_job_iam_policy.default * * } * * The `pulumi import` command can also be used: * * ```sh * $ pulumi import gcp:dataproc/jobIAMPolicy:JobIAMPolicy default "projects/{project}/regions/{region}/jobs/{job_id}" * ``` */ class JobIAMPolicy extends pulumi.CustomResource { /** * Get an existing JobIAMPolicy 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 JobIAMPolicy(name, state, { ...opts, id: id }); } /** * Returns true if the given object is an instance of JobIAMPolicy. 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'] === JobIAMPolicy.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["etag"] = state?.etag; resourceInputs["jobId"] = state?.jobId; resourceInputs["policyData"] = state?.policyData; resourceInputs["project"] = state?.project; resourceInputs["region"] = state?.region; } else { const args = argsOrState; if (args?.jobId === undefined && !opts.urn) { throw new Error("Missing required property 'jobId'"); } if (args?.policyData === undefined && !opts.urn) { throw new Error("Missing required property 'policyData'"); } resourceInputs["jobId"] = args?.jobId; resourceInputs["policyData"] = args?.policyData; resourceInputs["project"] = args?.project; resourceInputs["region"] = args?.region; resourceInputs["etag"] = undefined /*out*/; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(JobIAMPolicy.__pulumiType, name, resourceInputs, opts); } } exports.JobIAMPolicy = JobIAMPolicy; /** @internal */ JobIAMPolicy.__pulumiType = 'gcp:dataproc/jobIAMPolicy:JobIAMPolicy'; //# sourceMappingURL=jobIAMPolicy.js.map