UNPKG

@pulumi/gcp

Version:

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

206 lines (205 loc) 7.11 kB
import * as pulumi from "@pulumi/pulumi"; /** * Three different resources help you manage IAM policies on billing accounts. Each of these resources serves a different use case: * * * `gcp.billing.AccountIamPolicy`: Authoritative. Sets the IAM policy for the billing accounts and replaces any existing policy already attached. * * `gcp.billing.AccountIamBinding`: 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 table are preserved. * * `gcp.billing.AccountIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role of the billing accounts are preserved. * * > **Note:** `gcp.billing.AccountIamPolicy` **cannot** be used in conjunction with `gcp.billing.AccountIamBinding` and `gcp.billing.AccountIamMember` or they will fight over what your policy should be. In addition, be careful not to accidentally unset ownership of the billing account as `gcp.billing.AccountIamPolicy` replaces the entire policy. * * > **Note:** `gcp.billing.AccountIamBinding` resources **can be** used in conjunction with `gcp.billing.AccountIamMember` resources **only if** they do not grant privilege to the same role. * * ## gcp.billing.AccountIamPolicy * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const admin = gcp.organizations.getIAMPolicy({ * bindings: [{ * role: "roles/billing.viewer", * members: ["user:jane@example.com"], * }], * }); * const editor = new gcp.billing.AccountIamPolicy("editor", { * billingAccountId: "00AA00-000AAA-00AA0A", * policyData: admin.then(admin => admin.policyData), * }); * ``` * * ## gcp.billing.AccountIamBinding * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const editor = new gcp.billing.AccountIamBinding("editor", { * billingAccountId: "00AA00-000AAA-00AA0A", * role: "roles/billing.viewer", * members: ["user:jane@example.com"], * }); * ``` * * ## gcp.billing.AccountIamMember * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const editor = new gcp.billing.AccountIamMember("editor", { * billingAccountId: "00AA00-000AAA-00AA0A", * role: "roles/billing.viewer", * member: "user:jane@example.com", * }); * ``` * * ## gcp.billing.AccountIamPolicy * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const admin = gcp.organizations.getIAMPolicy({ * bindings: [{ * role: "roles/billing.viewer", * members: ["user:jane@example.com"], * }], * }); * const editor = new gcp.billing.AccountIamPolicy("editor", { * billingAccountId: "00AA00-000AAA-00AA0A", * policyData: admin.then(admin => admin.policyData), * }); * ``` * * ## gcp.billing.AccountIamBinding * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const editor = new gcp.billing.AccountIamBinding("editor", { * billingAccountId: "00AA00-000AAA-00AA0A", * role: "roles/billing.viewer", * members: ["user:jane@example.com"], * }); * ``` * * ## gcp.billing.AccountIamMember * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const editor = new gcp.billing.AccountIamMember("editor", { * billingAccountId: "00AA00-000AAA-00AA0A", * role: "roles/billing.viewer", * member: "user:jane@example.com", * }); * ``` * * ## Import * * ### Importing IAM policies * * IAM policy imports use the `billing_account_id` identifier of the Billing Account resource only. For example: * * * `{{billing_account_id}}` * * An `import` block (Terraform v1.5.0 and later) can be used to import IAM policies: * * tf * * import { * * id = {{billing_account_id}} * * to = google_billing_account_iam_policy.default * * } * * The `pulumi import` command can also be used: * * ```sh * $ pulumi import gcp:billing/accountIamPolicy:AccountIamPolicy default {{billing_account_id}} * ``` */ export declare class AccountIamPolicy extends pulumi.CustomResource { /** * Get an existing AccountIamPolicy 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<pulumi.ID>, state?: AccountIamPolicyState, opts?: pulumi.CustomResourceOptions): AccountIamPolicy; /** * Returns true if the given object is an instance of AccountIamPolicy. 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 AccountIamPolicy; /** * The billing account id. * * For `gcp.billing.AccountIamMember` or `gcp.billing.AccountIamBinding`: */ readonly billingAccountId: pulumi.Output<string>; /** * (Computed) The etag of the billing account's IAM policy. */ readonly etag: pulumi.Output<string>; /** * The policy data generated by a `gcp.organizations.getIAMPolicy` data source. * * - - - */ readonly policyData: pulumi.Output<string>; /** * Create a AccountIamPolicy 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: AccountIamPolicyArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering AccountIamPolicy resources. */ export interface AccountIamPolicyState { /** * The billing account id. * * For `gcp.billing.AccountIamMember` or `gcp.billing.AccountIamBinding`: */ billingAccountId?: pulumi.Input<string>; /** * (Computed) The etag of the billing account's IAM policy. */ etag?: pulumi.Input<string>; /** * The policy data generated by a `gcp.organizations.getIAMPolicy` data source. * * - - - */ policyData?: pulumi.Input<string>; } /** * The set of arguments for constructing a AccountIamPolicy resource. */ export interface AccountIamPolicyArgs { /** * The billing account id. * * For `gcp.billing.AccountIamMember` or `gcp.billing.AccountIamBinding`: */ billingAccountId: pulumi.Input<string>; /** * The policy data generated by a `gcp.organizations.getIAMPolicy` data source. * * - - - */ policyData: pulumi.Input<string>; }