Module datacatalog

This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Entry
EntryGroup
EntryGroupIamBinding
EntryGroupIamMember
EntryGroupIamPolicy
TagTemplate

Resources

Resource Entry

class Entry extends CustomResource

Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of Google Cloud Platform. Clients can use the linkedResource field in the Entry resource to refer to the original resource ID of the source system.

An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.

To get more information about Entry, see:

API documentation
How-to Guides
- Official Documentation

Example Usage - Data Catalog Entry Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const entryGroup = new gcp.datacatalog.EntryGroup("entryGroup", {entryGroupId: "myGroup"});
const basicEntry = new gcp.datacatalog.Entry("basicEntry", {
    entryGroup: entryGroup.id,
    entryId: "myEntry",
    userSpecifiedType: "myCustomType",
    userSpecifiedSystem: "SomethingExternal",
});

Example Usage - Data Catalog Entry Fileset

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const entryGroup = new gcp.datacatalog.EntryGroup("entryGroup", {entryGroupId: "myGroup"});
const basicEntry = new gcp.datacatalog.Entry("basicEntry", {
    entryGroup: entryGroup.id,
    entryId: "myEntry",
    type: "FILESET",
    gcs_fileset_spec: {
        filePatterns: ["gs://fake_bucket/dir/*"],
    },
});

Example Usage - Data Catalog Entry Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const entryGroup = new gcp.datacatalog.EntryGroup("entryGroup", {entryGroupId: "myGroup"});
const basicEntry = new gcp.datacatalog.Entry("basicEntry", {
    entryGroup: entryGroup.id,
    entryId: "myEntry",
    userSpecifiedType: "myUserSpecifiedType",
    userSpecifiedSystem: "Something_custom",
    linkedResource: "my/linked/resource",
    displayName: "my custom type entry",
    description: "a custom type entry for a user specified system",
    schema: `{
  "columns": [
    {
      "column": "firstName",
      "description": "First name",
      "mode": "REQUIRED",
      "type": "STRING"
    },
    {
      "column": "lastName",
      "description": "Last name",
      "mode": "REQUIRED",
      "type": "STRING"
    },
    {
      "column": "address",
      "description": "Address",
      "mode": "REPEATED",
      "subcolumns": [
        {
          "column": "city",
          "description": "City",
          "mode": "NULLABLE",
          "type": "STRING"
        },
        {
          "column": "state",
          "description": "State",
          "mode": "NULLABLE",
          "type": "STRING"
        }
      ],
      "type": "RECORD"
    }
  ]
}
`,
});

constructor

new Entry(name: string, args: EntryArgs, opts?: pulumi.CustomResourceOptions)

Create a Entry resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EntryState, opts?: pulumi.CustomResourceOptions): Entry

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Entry

Returns true if the given object is an instance of Entry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property bigqueryDateShardedSpec

public bigqueryDateShardedSpec: pulumi.Output<EntryBigqueryDateShardedSpec>;

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

property bigqueryTableSpec

public bigqueryTableSpec: pulumi.Output<EntryBigqueryTableSpec>;

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

property description

public description: pulumi.Output<string | undefined>;

Entry description, which can consist of several sentences or paragraphs that describe entry contents.

property displayName

public displayName: pulumi.Output<string | undefined>;

Display information such as title and description. A short name to identify the entry, for example, “Analytics Data - Jan 2011”.

property entryGroup

public entryGroup: pulumi.Output<string>;

The name of the entry group this entry is in.

property entryId

public entryId: pulumi.Output<string>;

The id of the entry to create.

property gcsFilesetSpec

public gcsFilesetSpec: pulumi.Output<EntryGcsFilesetSpec | undefined>;

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property integratedSystem

public integratedSystem: pulumi.Output<string>;

This field indicates the entry’s source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

property linkedResource

public linkedResource: pulumi.Output<string>;

The resource this metadata entry refers to. For Google Cloud Platform resources, linkedResource is the full name of the resource. For example, the linkedResource for a table resource from BigQuery is: //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with userSpecifiedType, this field is optional and defaults to an empty string.

property name

public name: pulumi.Output<string>;

The Data Catalog resource name of the entry in URL format. Example: projects/{project_id}/locations/{location}/entryGroups/{entryGroupId}/entries/{entryId}. Note that this Entry and its child resources may not actually be stored in the location in this name.

property schema

public schema: pulumi.Output<string | undefined>;

Schema of the entry (e.g. BigQuery, GoogleSQL, Avro schema), as a json string. An entry might not have any schema attached to it. See https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries#schema for what fields this schema can contain.

property type

public type: pulumi.Output<string | undefined>;

The type of the entry. Only used for Entries with types in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use userSpecifiedType.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userSpecifiedSystem

public userSpecifiedSystem: pulumi.Output<string | undefined>;

This field indicates the entry’s source system that Data Catalog does not integrate with. userSpecifiedSystem strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

property userSpecifiedType

public userSpecifiedType: pulumi.Output<string | undefined>;

Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example “mySpecialType”. userSpecifiedType strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long.

Resource EntryGroup

class EntryGroup extends CustomResource

constructor

new EntryGroup(name: string, args: EntryGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a EntryGroup resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EntryGroupState, opts?: pulumi.CustomResourceOptions): EntryGroup

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EntryGroup

Returns true if the given object is an instance of EntryGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.

property displayName

public displayName: pulumi.Output<string | undefined>;

A short name to identify the entry group, for example, “analytics data - jan 2011”.

property entryGroupId

public entryGroupId: pulumi.Output<string>;

The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property region

public region: pulumi.Output<string>;

EntryGroup location region.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EntryGroupIamBinding

class EntryGroupIamBinding extends CustomResource

Three different resources help you manage your IAM policy for Data catalog EntryGroup. Each of these resources serves a different use case:

gcp.datacatalog.EntryGroupIamPolicy: Authoritative. Sets the IAM policy for the entrygroup and replaces any existing policy already attached.
gcp.datacatalog.EntryGroupIamBinding: 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 entrygroup are preserved.
gcp.datacatalog.EntryGroupIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the entrygroup are preserved.

Note: gcp.datacatalog.EntryGroupIamPolicy cannot be used in conjunction with gcp.datacatalog.EntryGroupIamBinding and gcp.datacatalog.EntryGroupIamMember or they will fight over what your policy should be.
Note: gcp.datacatalog.EntryGroupIamBinding resources can be used in conjunction with gcp.datacatalog.EntryGroupIamMember resources only if they do not grant privilege to the same role.

google_data_catalog_entry_group_iam_policy

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.datacatalog.EntryGroupIamPolicy("policy", {
    entryGroup: google_data_catalog_entry_group.basic_entry_group.name,
    policyData: admin.then(admin => admin.policyData),
});

google_data_catalog_entry_group_iam_binding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const binding = new gcp.datacatalog.EntryGroupIamBinding("binding", {
    entryGroup: google_data_catalog_entry_group.basic_entry_group.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

google_data_catalog_entry_group_iam_member

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const member = new gcp.datacatalog.EntryGroupIamMember("member", {
    entryGroup: google_data_catalog_entry_group.basic_entry_group.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

constructor

new EntryGroupIamBinding(name: string, args: EntryGroupIamBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a EntryGroupIamBinding resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EntryGroupIamBindingState, opts?: pulumi.CustomResourceOptions): EntryGroupIamBinding

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EntryGroupIamBinding

Returns true if the given object is an instance of EntryGroupIamBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property condition

public condition: pulumi.Output<EntryGroupIamBindingCondition | undefined>;

property entryGroup

public entryGroup: pulumi.Output<string>;

Used to find the parent resource to bind the IAM policy to

property etag

public etag: pulumi.Output<string>;

(Computed) The etag of the IAM policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property members

public members: pulumi.Output<string[]>;

property project

public project: pulumi.Output<string>;

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.

property region

public region: pulumi.Output<string>;

property role

public role: pulumi.Output<string>;

The role that should be applied. Only one gcp.datacatalog.EntryGroupIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EntryGroupIamMember

class EntryGroupIamMember extends CustomResource

Three different resources help you manage your IAM policy for Data catalog EntryGroup. Each of these resources serves a different use case:

gcp.datacatalog.EntryGroupIamPolicy: Authoritative. Sets the IAM policy for the entrygroup and replaces any existing policy already attached.
gcp.datacatalog.EntryGroupIamBinding: 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 entrygroup are preserved.
gcp.datacatalog.EntryGroupIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the entrygroup are preserved.

Note: gcp.datacatalog.EntryGroupIamPolicy cannot be used in conjunction with gcp.datacatalog.EntryGroupIamBinding and gcp.datacatalog.EntryGroupIamMember or they will fight over what your policy should be.
Note: gcp.datacatalog.EntryGroupIamBinding resources can be used in conjunction with gcp.datacatalog.EntryGroupIamMember resources only if they do not grant privilege to the same role.

google_data_catalog_entry_group_iam_policy

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.datacatalog.EntryGroupIamPolicy("policy", {
    entryGroup: google_data_catalog_entry_group.basic_entry_group.name,
    policyData: admin.then(admin => admin.policyData),
});

google_data_catalog_entry_group_iam_binding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const binding = new gcp.datacatalog.EntryGroupIamBinding("binding", {
    entryGroup: google_data_catalog_entry_group.basic_entry_group.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

google_data_catalog_entry_group_iam_member

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const member = new gcp.datacatalog.EntryGroupIamMember("member", {
    entryGroup: google_data_catalog_entry_group.basic_entry_group.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

constructor

new EntryGroupIamMember(name: string, args: EntryGroupIamMemberArgs, opts?: pulumi.CustomResourceOptions)

Create a EntryGroupIamMember resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EntryGroupIamMemberState, opts?: pulumi.CustomResourceOptions): EntryGroupIamMember

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EntryGroupIamMember

Returns true if the given object is an instance of EntryGroupIamMember. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property condition

public condition: pulumi.Output<EntryGroupIamMemberCondition | undefined>;

property entryGroup

public entryGroup: pulumi.Output<string>;

Used to find the parent resource to bind the IAM policy to

property etag

public etag: pulumi.Output<string>;

(Computed) The etag of the IAM policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property member

public member: pulumi.Output<string>;

property project

public project: pulumi.Output<string>;

property region

public region: pulumi.Output<string>;

property role

public role: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EntryGroupIamPolicy

class EntryGroupIamPolicy extends CustomResource

Three different resources help you manage your IAM policy for Data catalog EntryGroup. Each of these resources serves a different use case:

gcp.datacatalog.EntryGroupIamPolicy: Authoritative. Sets the IAM policy for the entrygroup and replaces any existing policy already attached.
gcp.datacatalog.EntryGroupIamBinding: 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 entrygroup are preserved.
gcp.datacatalog.EntryGroupIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the entrygroup are preserved.

Note: gcp.datacatalog.EntryGroupIamPolicy cannot be used in conjunction with gcp.datacatalog.EntryGroupIamBinding and gcp.datacatalog.EntryGroupIamMember or they will fight over what your policy should be.
Note: gcp.datacatalog.EntryGroupIamBinding resources can be used in conjunction with gcp.datacatalog.EntryGroupIamMember resources only if they do not grant privilege to the same role.

google_data_catalog_entry_group_iam_policy

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.datacatalog.EntryGroupIamPolicy("policy", {
    entryGroup: google_data_catalog_entry_group.basic_entry_group.name,
    policyData: admin.then(admin => admin.policyData),
});

google_data_catalog_entry_group_iam_binding

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const binding = new gcp.datacatalog.EntryGroupIamBinding("binding", {
    entryGroup: google_data_catalog_entry_group.basic_entry_group.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

google_data_catalog_entry_group_iam_member

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const member = new gcp.datacatalog.EntryGroupIamMember("member", {
    entryGroup: google_data_catalog_entry_group.basic_entry_group.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

constructor

new EntryGroupIamPolicy(name: string, args: EntryGroupIamPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a EntryGroupIamPolicy resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EntryGroupIamPolicyState, opts?: pulumi.CustomResourceOptions): EntryGroupIamPolicy

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EntryGroupIamPolicy

Returns true if the given object is an instance of EntryGroupIamPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property entryGroup

public entryGroup: pulumi.Output<string>;

Used to find the parent resource to bind the IAM policy to

property etag

public etag: pulumi.Output<string>;

(Computed) The etag of the IAM policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property policyData

public policyData: pulumi.Output<string>;

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

property project

public project: pulumi.Output<string>;

property region

public region: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource TagTemplate

class TagTemplate extends CustomResource

A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to GCP resources.

To get more information about TagTemplate, see:

API documentation
How-to Guides
- Official Documentation

Example Usage - Data Catalog Tag Template Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basicTagTemplate = new gcp.datacatalog.TagTemplate("basicTagTemplate", {
    displayName: "Demo Tag Template",
    fields: [
        {
            displayName: "Source of data asset",
            fieldId: "source",
            isRequired: true,
            type: {
                primitiveType: "STRING",
            },
        },
        {
            displayName: "Number of rows in the data asset",
            fieldId: "numRows",
            type: {
                primitiveType: "DOUBLE",
            },
        },
        {
            displayName: "PII type",
            fieldId: "piiType",
            type: {
                enumType: {
                    allowedValues: [
                        {
                            displayName: "EMAIL",
                        },
                        {
                            displayName: "SOCIAL SECURITY NUMBER",
                        },
                        {
                            displayName: "NONE",
                        },
                    ],
                },
            },
        },
    ],
    forceDelete: false,
    region: "us-central1",
    tagTemplateId: "myTemplate",
});

constructor

new TagTemplate(name: string, args: TagTemplateArgs, opts?: pulumi.CustomResourceOptions)

Create a TagTemplate resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TagTemplateState, opts?: pulumi.CustomResourceOptions): TagTemplate

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TagTemplate

Returns true if the given object is an instance of TagTemplate. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property displayName

public displayName: pulumi.Output<string | undefined>;

The display name for this template.

property fields

public fields: pulumi.Output<TagTemplateField[]>;

Set of tag template field IDs and the settings for the field. This set is an exhaustive list of the allowed fields. This set must contain at least one field and at most 500 fields. Structure is documented below.

property forceDelete

public forceDelete: pulumi.Output<boolean | undefined>;

This confirms the deletion of any possible tags using this template. Must be set to true in order to delete the tag template.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

- The resource name of the tag template field in URL format. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId}/fields/{field}

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property region

public region: pulumi.Output<string>;

Template location region.

property tagTemplateId

public tagTemplateId: pulumi.Output<string>;

The id of the tag template to create.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface EntryArgs

interface EntryArgs

The set of arguments for constructing a Entry resource.

property description

description?: pulumi.Input<string>;

Entry description, which can consist of several sentences or paragraphs that describe entry contents.

property displayName

displayName?: pulumi.Input<string>;

Display information such as title and description. A short name to identify the entry, for example, “Analytics Data - Jan 2011”.

property entryGroup

entryGroup: pulumi.Input<string>;

The name of the entry group this entry is in.

property entryId

entryId: pulumi.Input<string>;

The id of the entry to create.

property gcsFilesetSpec

gcsFilesetSpec?: pulumi.Input<EntryGcsFilesetSpec>;

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.

property linkedResource

linkedResource?: pulumi.Input<string>;

property schema

schema?: pulumi.Input<string>;

property type

type?: pulumi.Input<string>;

property userSpecifiedSystem

userSpecifiedSystem?: pulumi.Input<string>;

property userSpecifiedType

userSpecifiedType?: pulumi.Input<string>;

interface EntryGroupArgs

interface EntryGroupArgs

The set of arguments for constructing a EntryGroup resource.

property description

description?: pulumi.Input<string>;

Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.

property displayName

displayName?: pulumi.Input<string>;

A short name to identify the entry group, for example, “analytics data - jan 2011”.

property entryGroupId

entryGroupId: pulumi.Input<string>;

The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property region

region?: pulumi.Input<string>;

EntryGroup location region.

interface EntryGroupIamBindingArgs

interface EntryGroupIamBindingArgs

The set of arguments for constructing a EntryGroupIamBinding resource.

property condition

condition?: pulumi.Input<EntryGroupIamBindingCondition>;

property entryGroup

entryGroup: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property members

members: pulumi.Input<pulumi.Input<string>[]>;

property project

project?: pulumi.Input<string>;

property region

region?: pulumi.Input<string>;

property role

role: pulumi.Input<string>;

interface EntryGroupIamBindingState

interface EntryGroupIamBindingState

Input properties used for looking up and filtering EntryGroupIamBinding resources.

property condition

condition?: pulumi.Input<EntryGroupIamBindingCondition>;

property entryGroup

entryGroup?: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property etag

etag?: pulumi.Input<string>;

(Computed) The etag of the IAM policy.

property members

members?: pulumi.Input<pulumi.Input<string>[]>;

property project

project?: pulumi.Input<string>;

property region

region?: pulumi.Input<string>;

property role

role?: pulumi.Input<string>;

interface EntryGroupIamMemberArgs

interface EntryGroupIamMemberArgs

The set of arguments for constructing a EntryGroupIamMember resource.

property condition

condition?: pulumi.Input<EntryGroupIamMemberCondition>;

property entryGroup

entryGroup: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property member

member: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

property region

region?: pulumi.Input<string>;

property role

role: pulumi.Input<string>;

interface EntryGroupIamMemberState

interface EntryGroupIamMemberState

Input properties used for looking up and filtering EntryGroupIamMember resources.

property condition

condition?: pulumi.Input<EntryGroupIamMemberCondition>;

property entryGroup

entryGroup?: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property etag

etag?: pulumi.Input<string>;

(Computed) The etag of the IAM policy.

property member

member?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

property region

region?: pulumi.Input<string>;

property role

role?: pulumi.Input<string>;

interface EntryGroupIamPolicyArgs

interface EntryGroupIamPolicyArgs

The set of arguments for constructing a EntryGroupIamPolicy resource.

property entryGroup

entryGroup: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property policyData

policyData: pulumi.Input<string>;

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

property project

project?: pulumi.Input<string>;

property region

region?: pulumi.Input<string>;

interface EntryGroupIamPolicyState

interface EntryGroupIamPolicyState

Input properties used for looking up and filtering EntryGroupIamPolicy resources.

property entryGroup

entryGroup?: pulumi.Input<string>;

Used to find the parent resource to bind the IAM policy to

property etag

etag?: pulumi.Input<string>;

(Computed) The etag of the IAM policy.

property policyData

policyData?: pulumi.Input<string>;

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

property project

project?: pulumi.Input<string>;

property region

region?: pulumi.Input<string>;

interface EntryGroupState

interface EntryGroupState

Input properties used for looking up and filtering EntryGroup resources.

property description

description?: pulumi.Input<string>;

Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.

property displayName

displayName?: pulumi.Input<string>;

A short name to identify the entry group, for example, “analytics data - jan 2011”.

property entryGroupId

entryGroupId?: pulumi.Input<string>;

The id of the entry group to create. The id must begin with a letter or underscore, contain only English letters, numbers and underscores, and be at most 64 characters.

property name

name?: pulumi.Input<string>;

The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property region

region?: pulumi.Input<string>;

EntryGroup location region.

interface EntryState

interface EntryState

Input properties used for looking up and filtering Entry resources.

property bigqueryDateShardedSpec

bigqueryDateShardedSpec?: pulumi.Input<EntryBigqueryDateShardedSpec>;

Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.

property bigqueryTableSpec

bigqueryTableSpec?: pulumi.Input<EntryBigqueryTableSpec>;

Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.

property description

description?: pulumi.Input<string>;

Entry description, which can consist of several sentences or paragraphs that describe entry contents.

property displayName

displayName?: pulumi.Input<string>;

Display information such as title and description. A short name to identify the entry, for example, “Analytics Data - Jan 2011”.

property entryGroup

entryGroup?: pulumi.Input<string>;

The name of the entry group this entry is in.

property entryId

entryId?: pulumi.Input<string>;

The id of the entry to create.

property gcsFilesetSpec

gcsFilesetSpec?: pulumi.Input<EntryGcsFilesetSpec>;

Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.

property integratedSystem

integratedSystem?: pulumi.Input<string>;

This field indicates the entry’s source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

property linkedResource

linkedResource?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

property schema

schema?: pulumi.Input<string>;

property type

type?: pulumi.Input<string>;

property userSpecifiedSystem

userSpecifiedSystem?: pulumi.Input<string>;

property userSpecifiedType

userSpecifiedType?: pulumi.Input<string>;

interface TagTemplateArgs

interface TagTemplateArgs

The set of arguments for constructing a TagTemplate resource.

property displayName

displayName?: pulumi.Input<string>;

The display name for this template.

property fields

fields: pulumi.Input<pulumi.Input<TagTemplateField>[]>;

property forceDelete

forceDelete?: pulumi.Input<boolean>;

This confirms the deletion of any possible tags using this template. Must be set to true in order to delete the tag template.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property region

region?: pulumi.Input<string>;

Template location region.

property tagTemplateId

tagTemplateId: pulumi.Input<string>;

The id of the tag template to create.

interface TagTemplateState

interface TagTemplateState

Input properties used for looking up and filtering TagTemplate resources.

property displayName

displayName?: pulumi.Input<string>;

The display name for this template.

property fields

fields?: pulumi.Input<pulumi.Input<TagTemplateField>[]>;

property forceDelete

forceDelete?: pulumi.Input<boolean>;

This confirms the deletion of any possible tags using this template. Must be set to true in order to delete the tag template.

property name

name?: pulumi.Input<string>;

- The resource name of the tag template field in URL format. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId}/fields/{field}

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property region

region?: pulumi.Input<string>;

Template location region.

property tagTemplateId

tagTemplateId?: pulumi.Input<string>;

The id of the tag template to create.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module datacatalog

Resources

Others

Resources

Example Usage - Data Catalog Entry Basic

Example Usage - Data Catalog Entry Fileset

Example Usage - Data Catalog Entry Full

google_data_catalog_entry_group_iam_policy

google_data_catalog_entry_group_iam_binding

google_data_catalog_entry_group_iam_member

google_data_catalog_entry_group_iam_policy

google_data_catalog_entry_group_iam_binding

google_data_catalog_entry_group_iam_member

google_data_catalog_entry_group_iam_policy

google_data_catalog_entry_group_iam_binding

google_data_catalog_entry_group_iam_member

Example Usage - Data Catalog Tag Template Basic

Others