@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
229 lines (228 loc) • 10.4 kB
TypeScript
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 Healthcare dataset. Each of these resources serves a different use case:
*
* * `gcp.healthcare.DatasetIamPolicy`: Authoritative. Sets the IAM policy for the dataset and replaces any existing policy already attached.
* * `gcp.healthcare.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.healthcare.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.
*
* > **Note:** `gcp.healthcare.DatasetIamPolicy` **cannot** be used in conjunction with `gcp.healthcare.DatasetIamBinding` and `gcp.healthcare.DatasetIamMember` or they will fight over what your policy should be.
*
* > **Note:** `gcp.healthcare.DatasetIamBinding` resources **can be** used in conjunction with `gcp.healthcare.DatasetIamMember` resources **only if** they do not grant privilege to the same role.
*
* ## gcp.healthcare.DatasetIamPolicy
*
* ```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 dataset = new gcp.healthcare.DatasetIamPolicy("dataset", {
* datasetId: "your-dataset-id",
* policyData: admin.then(admin => admin.policyData),
* });
* ```
*
* ## gcp.healthcare.DatasetIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.healthcare.DatasetIamBinding("dataset", {
* datasetId: "your-dataset-id",
* role: "roles/editor",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.healthcare.DatasetIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.healthcare.DatasetIamMember("dataset", {
* datasetId: "your-dataset-id",
* role: "roles/editor",
* member: "user:jane@example.com",
* });
* ```
*
* ## gcp.healthcare.DatasetIamBinding
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.healthcare.DatasetIamBinding("dataset", {
* datasetId: "your-dataset-id",
* role: "roles/editor",
* members: ["user:jane@example.com"],
* });
* ```
*
* ## gcp.healthcare.DatasetIamMember
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const dataset = new gcp.healthcare.DatasetIamMember("dataset", {
* datasetId: "your-dataset-id",
* role: "roles/editor",
* member: "user:jane@example.com",
* });
* ```
*
* ## Import
*
* ### Importing IAM policies
*
* IAM policy imports use the identifier of the Healthcase Dataset resource. For example:
*
* * `"{{project_id}}/{{location}}/{{dataset}}"`
*
* An `import` block (Terraform v1.5.0 and later) can be used to import IAM policies:
*
* tf
*
* import {
*
* id = "{{project_id}}/{{location}}/{{dataset}}"
*
* to = google_healthcare_dataset_iam_policy.default
*
* }
*
* The `pulumi import` command can also be used:
*
* ```sh
* $ pulumi import gcp:healthcare/datasetIamMember:DatasetIamMember default {{project_id}}/{{location}}/{{dataset}}
* ```
*/
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.healthcare.DatasetIamMemberCondition | undefined>;
/**
* The dataset ID, in the form
* `{project_id}/{location_name}/{dataset_name}` or
* `{location_name}/{dataset_name}`. In the second form, the provider's
* project setting will be used as a fallback.
*/
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:
* * **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
* * **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* * **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<string>;
/**
* The role that should be applied. Only one
* `gcp.healthcare.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.healthcare.DatasetIamMemberCondition>;
/**
* The dataset ID, in the form
* `{project_id}/{location_name}/{dataset_name}` or
* `{location_name}/{dataset_name}`. In the second form, the provider's
* project setting will be used as a fallback.
*/
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:
* * **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
* * **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* * **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<string>;
/**
* The role that should be applied. Only one
* `gcp.healthcare.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.healthcare.DatasetIamMemberCondition>;
/**
* The dataset ID, in the form
* `{project_id}/{location_name}/{dataset_name}` or
* `{location_name}/{dataset_name}`. In the second form, the provider's
* project setting will be used as a fallback.
*/
datasetId: pulumi.Input<string>;
/**
* Identities that will be granted the privilege in `role`.
* Each entry can have one of the following values:
* * **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
* * **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* * **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<string>;
/**
* The role that should be applied. Only one
* `gcp.healthcare.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>;
}