@pulumi/gcp/bigquery/datasetIamMember.d.ts

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

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Three different resources help you manage your IAM policy for BigQuery dataset. Each of these resources serves a different use case:
 *
 * * `gcp.bigquery.DatasetIamPolicy`: Authoritative. Sets the IAM policy for the dataset and replaces any existing policy already attached.
 * * `gcp.bigquery.DatasetIamBinding`: 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 dataset are preserved.
 * * `gcp.bigquery.DatasetIamMember`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the dataset are preserved.
 *
 * These resources are intended to convert the permissions system for BigQuery datasets to the standard IAM interface. For advanced usages, including [creating authorized views](https://cloud.google.com/bigquery/docs/share-access-views), please use either `gcp.bigquery.DatasetAccess` or the `access` field on `gcp.bigquery.Dataset`.
 *
 * > **Note:** These resources **cannot** be used with `gcp.bigquery.DatasetAccess` resources or the `access` field on `gcp.bigquery.Dataset` or they will fight over what the policy should be.
 *
 * > **Note:** Using any of these resources will remove any authorized view permissions from the dataset. To assign and preserve authorized view permissions use the `gcp.bigquery.DatasetAccess` instead.
 *
 * > **Note:** Legacy BigQuery roles `OWNER` `WRITER` and `READER` **cannot** be used with any of these IAM resources. Instead use the full role form of: `roles/bigquery.dataOwner` `roles/bigquery.dataEditor` and `roles/bigquery.dataViewer`.
 *
 * > **Note:** `gcp.bigquery.DatasetIamPolicy` **cannot** be used in conjunction with `gcp.bigquery.DatasetIamBinding` and `gcp.bigquery.DatasetIamMember` or they will fight over what your policy should be.
 *
 * > **Note:** `gcp.bigquery.DatasetIamBinding` resources **can be** used in conjunction with `gcp.bigquery.DatasetIamMember` resources **only if** they do not grant privilege to the same role.
 *
 * ## gcp.bigquery.DatasetIamPolicy
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const owner = gcp.organizations.getIAMPolicy({
 *     bindings: [{
 *         role: "roles/bigquery.dataOwner",
 *         members: ["user:jane@example.com"],
 *     }],
 * });
 * const datasetDataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
 * const dataset = new gcp.bigquery.DatasetIamPolicy("dataset", {
 *     datasetId: datasetDataset.datasetId,
 *     policyData: owner.then(owner => owner.policyData),
 * });
 * ```
 *
 * ## gcp.bigquery.DatasetIamBinding
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
 * const reader = new gcp.bigquery.DatasetIamBinding("reader", {
 *     datasetId: dataset.datasetId,
 *     role: "roles/bigquery.dataViewer",
 *     members: ["user:jane@example.com"],
 * });
 * ```
 *
 * ## gcp.bigquery.DatasetIamMember
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
 * const editor = new gcp.bigquery.DatasetIamMember("editor", {
 *     datasetId: dataset.datasetId,
 *     role: "roles/bigquery.dataEditor",
 *     member: "user:jane@example.com",
 * });
 * ```
 *
 * ## gcp.bigquery.DatasetIamPolicy
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const owner = gcp.organizations.getIAMPolicy({
 *     bindings: [{
 *         role: "roles/bigquery.dataOwner",
 *         members: ["user:jane@example.com"],
 *     }],
 * });
 * const datasetDataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
 * const dataset = new gcp.bigquery.DatasetIamPolicy("dataset", {
 *     datasetId: datasetDataset.datasetId,
 *     policyData: owner.then(owner => owner.policyData),
 * });
 * ```
 *
 * ## gcp.bigquery.DatasetIamBinding
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
 * const reader = new gcp.bigquery.DatasetIamBinding("reader", {
 *     datasetId: dataset.datasetId,
 *     role: "roles/bigquery.dataViewer",
 *     members: ["user:jane@example.com"],
 * });
 * ```
 *
 * ## gcp.bigquery.DatasetIamMember
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const dataset = new gcp.bigquery.Dataset("dataset", {datasetId: "example_dataset"});
 * const editor = new gcp.bigquery.DatasetIamMember("editor", {
 *     datasetId: dataset.datasetId,
 *     role: "roles/bigquery.dataEditor",
 *     member: "user:jane@example.com",
 * });
 * ```
 *
 * ## Import
 *
 * ### Importing IAM policies
 *
 * IAM policy imports use the identifier of the BigQuery Dataset resource. For example:
 *
 * * `projects/{{project_id}}/datasets/{{dataset_id}}`
 *
 * An `import` block (Terraform v1.5.0 and later) can be used to import IAM policies:
 *
 * tf
 *
 * import {
 *
 *   id = projects/{{project_id}}/datasets/{{dataset_id}}
 *
 *   to = google_bigquery_dataset_iam_policy.default
 *
 * }
 *
 * The `pulumi import` command can also be used:
 *
 * ```sh
 * $ pulumi import gcp:bigquery/datasetIamMember:DatasetIamMember default projects/{{project_id}}/datasets/{{dataset_id}}
 * ```
 */
export declare class DatasetIamMember extends pulumi.CustomResource {
    /**
     * Get an existing DatasetIamMember 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?: DatasetIamMemberState, opts?: pulumi.CustomResourceOptions): DatasetIamMember;
    /**
     * Returns true if the given object is an instance of DatasetIamMember.  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 DatasetIamMember;
    readonly condition: pulumi.Output<outputs.bigquery.DatasetIamMemberCondition | undefined>;
    /**
     * The dataset ID.
     */
    readonly datasetId: pulumi.Output<string>;
    /**
     * (Computed) The etag of the dataset's IAM policy.
     */
    readonly etag: pulumi.Output<string>;
    /**
     * Identities that will be granted the privilege in `role`.
     * Each entry can have one of the following values:
     * * **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
     * * **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
     * * **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.
     * * **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com.
     * * **iamMember:{principal}**: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
     * * **projectOwners**: A special identifier that represents the Owners of the project of the dataset.
     * * **projectReaders**: A special identifier that represents the Viewers of the project of the dataset.
     * * **projectWriters**: A special identifier that represents the Editors of the project of the dataset.
     * * **serviceAccount:{emailid}**: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
     * * **user:{emailid}**: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
     */
    readonly member: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * The role that should be applied. Only one
     * `gcp.bigquery.DatasetIamBinding` can be used per role. Note that custom roles must be of the format
     * `[projects|organizations]/{parent-name}/roles/{role-name}`.
     */
    readonly role: pulumi.Output<string>;
    /**
     * Create a DatasetIamMember 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: DatasetIamMemberArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DatasetIamMember resources.
 */
export interface DatasetIamMemberState {
    condition?: pulumi.Input<inputs.bigquery.DatasetIamMemberCondition>;
    /**
     * The dataset ID.
     */
    datasetId?: pulumi.Input<string>;
    /**
     * (Computed) The etag of the dataset's IAM policy.
     */
    etag?: pulumi.Input<string>;
    /**
     * Identities that will be granted the privilege in `role`.
     * Each entry can have one of the following values:
     * * **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
     * * **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
     * * **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.
     * * **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com.
     * * **iamMember:{principal}**: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
     * * **projectOwners**: A special identifier that represents the Owners of the project of the dataset.
     * * **projectReaders**: A special identifier that represents the Viewers of the project of the dataset.
     * * **projectWriters**: A special identifier that represents the Editors of the project of the dataset.
     * * **serviceAccount:{emailid}**: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
     * * **user:{emailid}**: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
     */
    member?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The role that should be applied. Only one
     * `gcp.bigquery.DatasetIamBinding` can be used per role. Note that custom roles must be of the format
     * `[projects|organizations]/{parent-name}/roles/{role-name}`.
     */
    role?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a DatasetIamMember resource.
 */
export interface DatasetIamMemberArgs {
    condition?: pulumi.Input<inputs.bigquery.DatasetIamMemberCondition>;
    /**
     * The dataset ID.
     */
    datasetId: pulumi.Input<string>;
    /**
     * Identities that will be granted the privilege in `role`.
     * Each entry can have one of the following values:
     * * **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
     * * **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
     * * **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.
     * * **group:{emailid}**: An email address that represents a Google group. For example, admins@example.com.
     * * **iamMember:{principal}**: Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. This is used for example for workload/workforce federated identities (principal, principalSet).
     * * **projectOwners**: A special identifier that represents the Owners of the project of the dataset.
     * * **projectReaders**: A special identifier that represents the Viewers of the project of the dataset.
     * * **projectWriters**: A special identifier that represents the Editors of the project of the dataset.
     * * **serviceAccount:{emailid}**: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
     * * **user:{emailid}**: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
     */
    member: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
    /**
     * The role that should be applied. Only one
     * `gcp.bigquery.DatasetIamBinding` can be used per role. Note that custom roles must be of the format
     * `[projects|organizations]/{parent-name}/roles/{role-name}`.
     */
    role: pulumi.Input<string>;
}