@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
170 lines • 6.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > **Warning:** These resources are in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* 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
*
* > **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`.
*/
export declare class DatasetIamPolicy extends pulumi.CustomResource {
/**
* Get an existing DatasetIamPolicy 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?: DatasetIamPolicyState, opts?: pulumi.CustomResourceOptions): DatasetIamPolicy;
/**
* Returns true if the given object is an instance of DatasetIamPolicy. 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 DatasetIamPolicy;
/**
* 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>;
/**
* The policy data generated by
* a `gcp.organizations.getIAMPolicy` data source.
*/
readonly policyData: pulumi.Output<string>;
/**
* Create a DatasetIamPolicy 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: DatasetIamPolicyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DatasetIamPolicy resources.
*/
export interface DatasetIamPolicyState {
/**
* 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 | undefined>;
/**
* (Computed) The etag of the dataset's IAM policy.
*/
etag?: pulumi.Input<string | undefined>;
/**
* The policy data generated by
* a `gcp.organizations.getIAMPolicy` data source.
*/
policyData?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a DatasetIamPolicy resource.
*/
export interface DatasetIamPolicyArgs {
/**
* 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>;
/**
* The policy data generated by
* a `gcp.organizations.getIAMPolicy` data source.
*/
policyData: pulumi.Input<string>;
}
//# sourceMappingURL=datasetIamPolicy.d.ts.map