UNPKG

@pulumi/gcp

Version:

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

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