UNPKG

@pulumi/gcp

Version:

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

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