import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Four different resources help you manage your IAM policy for a folder. Each of these resources serves a different use case: * * * `gcp.folder.IAMPolicy`: Authoritative. Sets the IAM policy for the folder and replaces any existing policy already attached. * * `gcp.folder.IAMBinding`: 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 folder are preserved. * * `gcp.folder.IAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the folder are preserved. * * `gcp.folder.IamAuditConfig`: Authoritative for a given service. Updates the IAM policy to enable audit logging for the given service. * * > **Note:** `gcp.folder.IAMPolicy` **cannot** be used in conjunction with `gcp.folder.IAMBinding`, `gcp.folder.IAMMember`, or `gcp.folder.IamAuditConfig` or they will fight over what your policy should be. * * > **Note:** `gcp.folder.IAMBinding` resources **can be** used in conjunction with `gcp.folder.IAMMember` resources **only if** they do not grant privilege to the same role. * * > **Note:** The underlying API method `projects.setIamPolicy` has constraints which are documented [here](https://cloud.google.com/resource-manager/reference/rest/v1/projects/setIamPolicy). In addition to these constraints, * IAM Conditions cannot be used with Basic Roles such as Owner. Violating these constraints will result in the API returning a 400 error code so please review these if you encounter errors with this resource. * * ## gcp.folder.IAMPolicy * * !> **Be careful!** You can accidentally lock yourself out of your folder * using this resource. Deleting a `gcp.folder.IAMPolicy` removes access * from anyone without permissions on its parent folder/organization. Proceed with caution. * It's not recommended to use `gcp.folder.IAMPolicy` with your provider folder * to avoid locking yourself out, and it should generally only be used with folders * fully managed by this provider. If you do use this resource, it is recommended to **import** the policy before * applying the change. * * ```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 folder = new gcp.folder.IAMPolicy("folder", { * folder: "folders/1234567", * 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.admin", * 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 folder = new gcp.folder.IAMPolicy("folder", { * folder: "folders/1234567", * policyData: admin.then(admin => admin.policyData), * }); * ``` * * ## gcp.folder.IAMBinding * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const folder = new gcp.folder.IAMBinding("folder", { * folder: "folders/1234567", * role: "roles/editor", * members: ["user:jane@example.com"], * }); * ``` * * With IAM Conditions: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const folder = new gcp.folder.IAMBinding("folder", { * folder: "folders/1234567", * role: "roles/container.admin", * 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.folder.IAMMember * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const folder = new gcp.folder.IAMMember("folder", { * folder: "folders/1234567", * role: "roles/editor", * member: "user:jane@example.com", * }); * ``` * * With IAM Conditions: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const folder = new gcp.folder.IAMMember("folder", { * folder: "folders/1234567", * role: "roles/firebase.admin", * 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\")", * }, * }); * ``` * * ## gcp.folder.IamAuditConfig * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const folder = new gcp.folder.IamAuditConfig("folder", { * folder: "folders/1234567", * service: "allServices", * auditLogConfigs: [ * { * logType: "ADMIN_READ", * }, * { * logType: "DATA_READ", * exemptedMembers: ["user:joebloggs@example.com"], * }, * ], * }); * ``` * * ## gcp.folder.IAMBinding * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const folder = new gcp.folder.IAMBinding("folder", { * folder: "folders/1234567", * role: "roles/editor", * members: ["user:jane@example.com"], * }); * ``` * * With IAM Conditions: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const folder = new gcp.folder.IAMBinding("folder", { * folder: "folders/1234567", * role: "roles/container.admin", * 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.folder.IAMMember * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const folder = new gcp.folder.IAMMember("folder", { * folder: "folders/1234567", * role: "roles/editor", * member: "user:jane@example.com", * }); * ``` * * With IAM Conditions: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const folder = new gcp.folder.IAMMember("folder", { * folder: "folders/1234567", * role: "roles/firebase.admin", * 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\")", * }, * }); * ``` * * ## gcp.folder.IamAuditConfig * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const folder = new gcp.folder.IamAuditConfig("folder", { * folder: "folders/1234567", * service: "allServices", * auditLogConfigs: [ * { * logType: "ADMIN_READ", * }, * { * logType: "DATA_READ", * exemptedMembers: ["user:joebloggs@example.com"], * }, * ], * }); * ``` * * ## Import * * ### Importing Audit Configs * * An audit config can be imported into a `google_folder_iam_audit_config` resource using the resource's `folder_id` and the `service`, e.g: * * * `"folder/{{folder_id}} foo.googleapis.com"` * * An `import` block (Terraform v1.5.0 and later) can be used to import audit configs: * * tf * * import { * * id = "folder/{{folder_id}} foo.googleapis.com" * * to = google_folder_iam_audit_config.default * * } * * The `pulumi import` command can also be used: * * ```sh * $ pulumi import gcp:folder/iAMMember:IAMMember default "folder/{{folder_id}} foo.googleapis.com" * ``` */ export declare class IAMMember extends pulumi.CustomResource { /** * Get an existing IAMMember 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: string, id: pulumi.Input, state?: IAMMemberState, opts?: pulumi.CustomResourceOptions): IAMMember; /** * Returns true if the given object is an instance of IAMMember. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is IAMMember; /** * An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. * Structure is documented below. */ readonly condition: pulumi.Output; /** * (Computed) The etag of the folder's IAM policy. */ readonly etag: pulumi.Output; /** * The resource name of the folder the policy is attached to. Its format is folders/{folder_id}. */ readonly folder: pulumi.Output; /** * Identities that will be granted the privilege in `role`. * Each entry can have one of the following values: * * **user:{emailid}**: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com. * * **serviceAccount:{emailid}**: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. * * **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com. * * **domain:{domain}**: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com. */ readonly member: pulumi.Output; /** * The role that should be applied. Only one * `gcp.folder.IAMBinding` can be used per role. Note that custom roles must be of the format * `organizations/{{org_id}}/roles/{{role_id}}`. */ readonly role: pulumi.Output; /** * Create a IAMMember resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: IAMMemberArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering IAMMember resources. */ export interface IAMMemberState { /** * An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. * Structure is documented below. */ condition?: pulumi.Input; /** * (Computed) The etag of the folder's IAM policy. */ etag?: pulumi.Input; /** * The resource name of the folder the policy is attached to. Its format is folders/{folder_id}. */ folder?: pulumi.Input; /** * Identities that will be granted the privilege in `role`. * Each entry can have one of the following values: * * **user:{emailid}**: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com. * * **serviceAccount:{emailid}**: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. * * **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com. * * **domain:{domain}**: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com. */ member?: pulumi.Input; /** * The role that should be applied. Only one * `gcp.folder.IAMBinding` can be used per role. Note that custom roles must be of the format * `organizations/{{org_id}}/roles/{{role_id}}`. */ role?: pulumi.Input; } /** * The set of arguments for constructing a IAMMember resource. */ export interface IAMMemberArgs { /** * An [IAM Condition](https://cloud.google.com/iam/docs/conditions-overview) for a given binding. * Structure is documented below. */ condition?: pulumi.Input; /** * The resource name of the folder the policy is attached to. Its format is folders/{folder_id}. */ folder: pulumi.Input; /** * Identities that will be granted the privilege in `role`. * Each entry can have one of the following values: * * **user:{emailid}**: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com. * * **serviceAccount:{emailid}**: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. * * **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com. * * **domain:{domain}**: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com. */ member: pulumi.Input; /** * The role that should be applied. Only one * `gcp.folder.IAMBinding` can be used per role. Note that custom roles must be of the format * `organizations/{{org_id}}/roles/{{role_id}}`. */ role: pulumi.Input; }