Skip to content

IAM policy for Cloud Dataplex Asset

Three different resources help you manage your IAM policy for Cloud Dataplex Asset. Each of these resources serves a different use case:

  • googleDataplexAssetIamPolicy: Authoritative. Sets the IAM policy for the asset and replaces any existing policy already attached.
  • googleDataplexAssetIamBinding: 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 asset are preserved.
  • googleDataplexAssetIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the asset are preserved.

\~> Note: googleDataplexAssetIamPolicy cannot be used in conjunction with googleDataplexAssetIamBinding and googleDataplexAssetIamMember or they will fight over what your policy should be.

\~> Note: googleDataplexAssetIamBinding resources can be used in conjunction with googleDataplexAssetIamMember resources only if they do not grant privilege to the same role.

googleDataplexAssetIamPolicy

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const dataGoogleIamPolicyAdmin =
  new google.dataGoogleIamPolicy.DataGoogleIamPolicy(this, "admin", {
    binding: [
      {
        members: ["user:jane@example.com"],
        role: "roles/viewer",
      },
    ],
  });
new google.dataplexAssetIamPolicy.DataplexAssetIamPolicy(this, "policy", {
  asset: "${google_dataplex_asset.example.name}",
  dataplex_zone: "${google_dataplex_asset.example.dataplex_zone}",
  lake: "${google_dataplex_asset.example.lake}",
  location: "${google_dataplex_asset.example.location}",
  policy_data: dataGoogleIamPolicyAdmin.policyData,
  project: "${google_dataplex_asset.example.project}",
});

googleDataplexAssetIamBinding

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.dataplexAssetIamBinding.DataplexAssetIamBinding(this, "binding", {
  asset: "${google_dataplex_asset.example.name}",
  dataplex_zone: "${google_dataplex_asset.example.dataplex_zone}",
  lake: "${google_dataplex_asset.example.lake}",
  location: "${google_dataplex_asset.example.location}",
  members: ["user:jane@example.com"],
  project: "${google_dataplex_asset.example.project}",
  role: "roles/viewer",
});

googleDataplexAssetIamMember

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
new google.dataplexAssetIamMember.DataplexAssetIamMember(this, "member", {
  asset: "${google_dataplex_asset.example.name}",
  dataplex_zone: "${google_dataplex_asset.example.dataplex_zone}",
  lake: "${google_dataplex_asset.example.lake}",
  location: "${google_dataplex_asset.example.location}",
  member: "user:jane@example.com",
  project: "${google_dataplex_asset.example.project}",
  role: "roles/viewer",
});

Argument Reference

The following arguments are supported:

  • asset - (Required) Used to find the parent resource to bind the IAM policy to

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

  • member/members - (Required) 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.
    • projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
    • projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
    • projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

  • role - (Required) The role that should be applied. Only one googleDataplexAssetIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parentName}/roles/{roleName}.

  • policyData - (Required only by googleDataplexAssetIamPolicy) The policy data generated by a googleIamPolicy data source.

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • etag - (Computed) The etag of the IAM policy.

Import

For all import syntaxes, the "resource in question" can take any of the following forms:

  • projects/{{project}}/locations/{{location}}/lakes/{{lake}}/zones/{{dataplex_zone}}/assets/{{name}}
  • {{project}}/{{location}}/{{lake}}/{{dataplex_zone}}/{{name}}
  • {{location}}/{{lake}}/{{dataplex_zone}}/{{name}}
  • {{name}}

Any variables not passed in the import command will be taken from the provider configuration.

Cloud Dataplex asset IAM resources can be imported using the resource identifiers, role, and member.

IAM member imports use space-delimited identifiers: the resource in question, the role, and the member identity, e.g.

$ terraform import google_dataplex_asset_iam_member.editor "projects/{{project}}/locations/{{location}}/lakes/{{lake}}/zones/{{dataplex_zone}}/assets/{{asset}} roles/viewer user:jane@example.com"

IAM binding imports use space-delimited identifiers: the resource in question and the role, e.g.

$ terraform import google_dataplex_asset_iam_binding.editor "projects/{{project}}/locations/{{location}}/lakes/{{lake}}/zones/{{dataplex_zone}}/assets/{{asset}} roles/viewer"

IAM policy imports use the identifier of the resource in question, e.g.

$ terraform import google_dataplex_asset_iam_policy.editor projects/{{project}}/locations/{{location}}/lakes/{{lake}}/zones/{{dataplex_zone}}/assets/{{asset}}

-> 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/myProject|organizations/myOrg]/roles/myCustomRole.

User Project Overrides

This resource supports User Project Overrides.