1. Docs
  2. Reference
  3. API
  4. GCP
  5. bigquery
  6. DatasetIamPolicy

DatasetIamPolicy

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, 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.

Create a DatasetIamPolicy Resource

new DatasetIamPolicy(name: string, args: DatasetIamPolicyArgs, opts?: CustomResourceOptions);
def DatasetIamPolicy(resource_name, opts=None, dataset_id=None, policy_data=None, project=None, __props__=None);
func NewDatasetIamPolicy(ctx *Context, name string, args DatasetIamPolicyArgs, opts ...ResourceOption) (*DatasetIamPolicy, error)
public DatasetIamPolicy(string name, DatasetIamPolicyArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args DatasetIamPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args DatasetIamPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DatasetIamPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

DatasetIamPolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The DatasetIamPolicy resource accepts the following input properties:

DatasetId string

The dataset ID, in the form projects/{project}/datasets/{dataset_id}

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

Project string
DatasetId string

The dataset ID, in the form projects/{project}/datasets/{dataset_id}

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

Project string
datasetId string

The dataset ID, in the form projects/{project}/datasets/{dataset_id}

policyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

project string
dataset_id str

The dataset ID, in the form projects/{project}/datasets/{dataset_id}

policy_data str

The policy data generated by a gcp.organizations.getIAMPolicy data source.

project str

Outputs

All input properties are implicitly available as output properties. Additionally, the DatasetIamPolicy resource produces the following output properties:

Etag string

(Computed) The etag of the dataset’s IAM policy.

Id string
The provider-assigned unique ID for this managed resource.
Etag string

(Computed) The etag of the dataset’s IAM policy.

Id string
The provider-assigned unique ID for this managed resource.
etag string

(Computed) The etag of the dataset’s IAM policy.

id string
The provider-assigned unique ID for this managed resource.
etag str

(Computed) The etag of the dataset’s IAM policy.

id str
The provider-assigned unique ID for this managed resource.

Look up an Existing DatasetIamPolicy Resource

Get an existing DatasetIamPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DatasetIamPolicyState, opts?: CustomResourceOptions): DatasetIamPolicy
static get(resource_name, id, opts=None, dataset_id=None, etag=None, policy_data=None, project=None, __props__=None);
func GetDatasetIamPolicy(ctx *Context, name string, id IDInput, state *DatasetIamPolicyState, opts ...ResourceOption) (*DatasetIamPolicy, error)
public static DatasetIamPolicy Get(string name, Input<string> id, DatasetIamPolicyState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

DatasetId string

The dataset ID, in the form projects/{project}/datasets/{dataset_id}

Etag string

(Computed) The etag of the dataset’s IAM policy.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

Project string
DatasetId string

The dataset ID, in the form projects/{project}/datasets/{dataset_id}

Etag string

(Computed) The etag of the dataset’s IAM policy.

PolicyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

Project string
datasetId string

The dataset ID, in the form projects/{project}/datasets/{dataset_id}

etag string

(Computed) The etag of the dataset’s IAM policy.

policyData string

The policy data generated by a gcp.organizations.getIAMPolicy data source.

project string
dataset_id str

The dataset ID, in the form projects/{project}/datasets/{dataset_id}

etag str

(Computed) The etag of the dataset’s IAM policy.

policy_data str

The policy data generated by a gcp.organizations.getIAMPolicy data source.

project str

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.