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 project. Each of these resources serves a different use case: * * * `gcp.projects.IAMPolicy`: Authoritative. Sets the IAM policy for the project and replaces any existing policy already attached. * * `gcp.projects.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 project are preserved. * * `gcp.projects.IAMMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the project are preserved. * * `gcp.projects.IAMAuditConfig`: Authoritative for a given service. Updates the IAM policy to enable audit logging for the given service. * * > **Note:** `gcp.projects.IAMPolicy` **cannot** be used in conjunction with `gcp.projects.IAMBinding`, `gcp.projects.IAMMember`, or `gcp.projects.IAMAuditConfig` or they will fight over what your policy should be. * * > **Note:** `gcp.projects.IAMBinding` resources **can be** used in conjunction with `gcp.projects.IAMMember` resources **only if** they do not grant privilege to the same role. * * > **Note:** The underlying API method `projects.setIamPolicy` has a lot of constraints which are documented [here](https://docs.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 400 error code so please review these if you encounter errors with this resource. * * ## gcp.projects.IAMPolicy * * !> **Be careful!** You can accidentally lock yourself out of your project * using this resource. Deleting a `gcp.projects.IAMPolicy` removes access * from anyone without organization-level access to the project. Proceed with caution. * It's not recommended to use `gcp.projects.IAMPolicy` with your provider project * to avoid locking yourself out, and it should generally only be used with projects * 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 project = new gcp.projects.IAMPolicy("project", { * project: "your-project-id", * 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 project = new gcp.projects.IAMPolicy("project", { * project: "your-project-id", * policyData: admin.then(admin => admin.policyData), * }); * ``` * * ## gcp.projects.IAMBinding * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const project = new gcp.projects.IAMBinding("project", { * project: "your-project-id", * 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 project = new gcp.projects.IAMBinding("project", { * project: "your-project-id", * 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.projects.IAMMember * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const project = new gcp.projects.IAMMember("project", { * project: "your-project-id", * 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 project = new gcp.projects.IAMMember("project", { * project: "your-project-id", * 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.projects.IAMAuditConfig * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const project = new gcp.projects.IAMAuditConfig("project", { * project: "your-project-id", * service: "allServices", * auditLogConfigs: [ * { * logType: "ADMIN_READ", * }, * { * logType: "DATA_READ", * exemptedMembers: ["user:joebloggs@example.com"], * }, * ], * }); * ``` * * ## gcp.projects.IAMPolicy * * !> **Be careful!** You can accidentally lock yourself out of your project * using this resource. Deleting a `gcp.projects.IAMPolicy` removes access * from anyone without organization-level access to the project. Proceed with caution. * It's not recommended to use `gcp.projects.IAMPolicy` with your provider project * to avoid locking yourself out, and it should generally only be used with projects * 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 project = new gcp.projects.IAMPolicy("project", { * project: "your-project-id", * 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 project = new gcp.projects.IAMPolicy("project", { * project: "your-project-id", * policyData: admin.then(admin => admin.policyData), * }); * ``` * * ## gcp.projects.IAMBinding * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const project = new gcp.projects.IAMBinding("project", { * project: "your-project-id", * 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 project = new gcp.projects.IAMBinding("project", { * project: "your-project-id", * 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.projects.IAMMember * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const project = new gcp.projects.IAMMember("project", { * project: "your-project-id", * 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 project = new gcp.projects.IAMMember("project", { * project: "your-project-id", * 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.projects.IAMAuditConfig * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const project = new gcp.projects.IAMAuditConfig("project", { * project: "your-project-id", * service: "allServices", * auditLogConfigs: [ * { * logType: "ADMIN_READ", * }, * { * logType: "DATA_READ", * exemptedMembers: ["user:joebloggs@example.com"], * }, * ], * }); * ``` * * ## Import * * > **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`. * * > **Conditional IAM Bindings**: If you're importing a IAM binding with a condition block, make sure * to include the title of condition, e.g. `terraform import google_project_iam_binding.my_project "{{your-project-id}} roles/{{role_id}} condition-title"` */ export declare class IAMAuditConfig extends pulumi.CustomResource { /** * Get an existing IAMAuditConfig 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?: IAMAuditConfigState, opts?: pulumi.CustomResourceOptions): IAMAuditConfig; /** * Returns true if the given object is an instance of IAMAuditConfig. 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 IAMAuditConfig; /** * The configuration for logging of each type of permission. This can be specified multiple times. Structure is documented below. */ readonly auditLogConfigs: pulumi.Output; /** * (Computed) The etag of the project's IAM policy. */ readonly etag: pulumi.Output; /** * The project id of the target project. This is not * inferred from the provider. */ readonly project: pulumi.Output; /** * Service which will be enabled for audit logging. The special value `allServices` covers all services. Note that if there are gcp.projects.IAMAuditConfig resources covering both `allServices` and a specific service then the union of the two AuditConfigs is used for that service: the `logTypes` specified in each `auditLogConfig` are enabled, and the `exemptedMembers` in each `auditLogConfig` are exempted. */ readonly service: pulumi.Output; /** * Create a IAMAuditConfig 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: IAMAuditConfigArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering IAMAuditConfig resources. */ export interface IAMAuditConfigState { /** * The configuration for logging of each type of permission. This can be specified multiple times. Structure is documented below. */ auditLogConfigs?: pulumi.Input[]>; /** * (Computed) The etag of the project's IAM policy. */ etag?: pulumi.Input; /** * The project id of the target project. This is not * inferred from the provider. */ project?: pulumi.Input; /** * Service which will be enabled for audit logging. The special value `allServices` covers all services. Note that if there are gcp.projects.IAMAuditConfig resources covering both `allServices` and a specific service then the union of the two AuditConfigs is used for that service: the `logTypes` specified in each `auditLogConfig` are enabled, and the `exemptedMembers` in each `auditLogConfig` are exempted. */ service?: pulumi.Input; } /** * The set of arguments for constructing a IAMAuditConfig resource. */ export interface IAMAuditConfigArgs { /** * The configuration for logging of each type of permission. This can be specified multiple times. Structure is documented below. */ auditLogConfigs: pulumi.Input[]>; /** * The project id of the target project. This is not * inferred from the provider. */ project: pulumi.Input; /** * Service which will be enabled for audit logging. The special value `allServices` covers all services. Note that if there are gcp.projects.IAMAuditConfig resources covering both `allServices` and a specific service then the union of the two AuditConfigs is used for that service: the `logTypes` specified in each `auditLogConfig` are enabled, and the `exemptedMembers` in each `auditLogConfig` are exempted. */ service: pulumi.Input; }