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.

datacatalog¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.datacatalog.Entry(resource_name, opts=None, description=None, display_name=None, entry_group=None, entry_id=None, gcs_fileset_spec=None, linked_resource=None, schema=None, type=None, user_specified_system=None, user_specified_type=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gcp as gcp

entry_group = gcp.datacatalog.EntryGroup("entryGroup", entry_group_id="my_group")
basic_entry = gcp.datacatalog.Entry("basicEntry",
    entry_group=entry_group.id,
    entry_id="my_entry",
    user_specified_type="my_custom_type",
    user_specified_system="SomethingExternal")

import pulumi
import pulumi_gcp as gcp

entry_group = gcp.datacatalog.EntryGroup("entryGroup", entry_group_id="my_group")
basic_entry = gcp.datacatalog.Entry("basicEntry",
    entry_group=entry_group.id,
    entry_id="my_entry",
    type="FILESET",
    gcs_fileset_spec={
        "filePatterns": ["gs://fake_bucket/dir/*"],
    })

import pulumi
import pulumi_gcp as gcp

entry_group = gcp.datacatalog.EntryGroup("entryGroup", entry_group_id="my_group")
basic_entry = gcp.datacatalog.Entry("basicEntry",
    entry_group=entry_group.id,
    entry_id="my_entry",
    user_specified_type="my_user_specified_type",
    user_specified_system="Something_custom",
    linked_resource="my/linked/resource",
    display_name="my custom type entry",
    description="a custom type entry for a user specified system",
    schema="""{
  "columns": [
    {
      "column": "first_name",
      "description": "First name",
      "mode": "REQUIRED",
      "type": "STRING"
    },
    {
      "column": "last_name",
      "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"
    }
  ]
}
""")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – Entry description, which can consist of several sentences or paragraphs that describe entry contents.
display_name (pulumi.Input[str]) – Display information such as title and description. A short name to identify the entry, for example, “Analytics Data - Jan 2011”.
entry_group (pulumi.Input[str]) – The name of the entry group this entry is in.
entry_id (pulumi.Input[str]) – The id of the entry to create.
gcs_fileset_spec (pulumi.Input[dict]) – Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
linked_resource (pulumi.Input[str]) – 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.
schema (pulumi.Input[str]) – 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.
type (pulumi.Input[str]) – 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.
user_specified_system (pulumi.Input[str]) – 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.
user_specified_type (pulumi.Input[str]) – 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 “my_special_type”. 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.

The gcs_fileset_spec object supports the following:

filePatterns (pulumi.Input[list]) - Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:
- gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
- gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.
- gs://bucket_name/file*: matches files prefixed by file in bucket_name
- gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name
- gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name
- gs://bucket_name/[a-m].txt: matches files that contain a, b, … or m followed by .txt in bucket_name
- gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b
- gs://another_bucket/a.txt: matches gs://another_bucket/a.txt
sampleGcsFileSpecs (pulumi.Input[list]) - - Sample files contained in this fileset, not all files contained in this fileset are represented here. Structure is documented below.
- filePath (pulumi.Input[str]) - - The full file path
- sizeBytes (pulumi.Input[float]) - - The size of the file, in bytes.

bigquery_date_sharded_spec: pulumi.Output[dict] = None¶

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

dataset (str)
shardCount (float)
tablePrefix (str)

bigquery_table_spec: pulumi.Output[dict] = None¶

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

tableSourceType (str)
tableSpec (dict)
- groupedEntry (str)
viewSpec (dict)
- viewQuery (str)

description: pulumi.Output[str] = None¶: Entry description, which can consist of several sentences or paragraphs that describe entry contents.

display_name: pulumi.Output[str] = None¶: Display information such as title and description. A short name to identify the entry, for example, “Analytics Data - Jan 2011”.

entry_group: pulumi.Output[str] = None¶: The name of the entry group this entry is in.

entry_id: pulumi.Output[str] = None¶: The id of the entry to create.

gcs_fileset_spec: pulumi.Output[dict] = None¶

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

filePatterns (list) - Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:
- gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
- gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.
- gs://bucket_name/file*: matches files prefixed by file in bucket_name
- gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name
- gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name
- gs://bucket_name/[a-m].txt: matches files that contain a, b, … or m followed by .txt in bucket_name
- gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b
- gs://another_bucket/a.txt: matches gs://another_bucket/a.txt
sampleGcsFileSpecs (list) - - Sample files contained in this fileset, not all files contained in this fileset are represented here. Structure is documented below.
- filePath (str) - - The full file path
- sizeBytes (float) - - The size of the file, in bytes.

integrated_system: pulumi.Output[str] = None¶: This field indicates the entry’s source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.

linked_resource: pulumi.Output[str] = None¶: 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.

name: pulumi.Output[str] = None¶: 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.

schema: pulumi.Output[str] = None¶: 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.

type: pulumi.Output[str] = None¶: 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.

user_specified_system: pulumi.Output[str] = None¶: 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.

user_specified_type: pulumi.Output[str] = None¶: 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 “my_special_type”. 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.

static get(resource_name, id, opts=None, bigquery_date_sharded_spec=None, bigquery_table_spec=None, description=None, display_name=None, entry_group=None, entry_id=None, gcs_fileset_spec=None, integrated_system=None, linked_resource=None, name=None, schema=None, type=None, user_specified_system=None, user_specified_type=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
bigquery_date_sharded_spec (pulumi.Input[dict]) – Specification for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding.
bigquery_table_spec (pulumi.Input[dict]) – Specification that applies to a BigQuery table. This is only valid on entries of type TABLE.
description (pulumi.Input[str]) – Entry description, which can consist of several sentences or paragraphs that describe entry contents.
display_name (pulumi.Input[str]) – Display information such as title and description. A short name to identify the entry, for example, “Analytics Data - Jan 2011”.
entry_group (pulumi.Input[str]) – The name of the entry group this entry is in.
entry_id (pulumi.Input[str]) – The id of the entry to create.
gcs_fileset_spec (pulumi.Input[dict]) – Specification that applies to a Cloud Storage fileset. This is only valid on entries of type FILESET. Structure is documented below.
integrated_system (pulumi.Input[str]) – This field indicates the entry’s source system that Data Catalog integrates with, such as BigQuery or Pub/Sub.
linked_resource (pulumi.Input[str]) – 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.
name (pulumi.Input[str]) – 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.
schema (pulumi.Input[str]) – 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.
type (pulumi.Input[str]) – 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.
user_specified_system (pulumi.Input[str]) – 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.
user_specified_type (pulumi.Input[str]) – 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 “my_special_type”. 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.

The bigquery_date_sharded_spec object supports the following:

dataset (pulumi.Input[str])
shardCount (pulumi.Input[float])
tablePrefix (pulumi.Input[str])

The bigquery_table_spec object supports the following:

tableSourceType (pulumi.Input[str])
tableSpec (pulumi.Input[dict])
- groupedEntry (pulumi.Input[str])
viewSpec (pulumi.Input[dict])
- viewQuery (pulumi.Input[str])

The gcs_fileset_spec object supports the following:

filePatterns (pulumi.Input[list]) - Patterns to identify a set of files in Google Cloud Storage. See Cloud Storage documentation for more information. Note that bucket wildcards are currently not supported. Examples of valid filePatterns:
- gs://bucket_name/dir/*: matches all files within bucket_name/dir directory.
- gs://bucket_name/dir/**: matches all files in bucket_name/dir spanning all subdirectories.
- gs://bucket_name/file*: matches files prefixed by file in bucket_name
- gs://bucket_name/??.txt: matches files with two characters followed by .txt in bucket_name
- gs://bucket_name/[aeiou].txt: matches files that contain a single vowel character followed by .txt in bucket_name
- gs://bucket_name/[a-m].txt: matches files that contain a, b, … or m followed by .txt in bucket_name
- gs://bucket_name/a//b: matches all files in bucket_name that match a//b pattern, such as a/c/b, a/d/b
- gs://another_bucket/a.txt: matches gs://another_bucket/a.txt
sampleGcsFileSpecs (pulumi.Input[list]) - - Sample files contained in this fileset, not all files contained in this fileset are represented here. Structure is documented below.
- filePath (pulumi.Input[str]) - - The full file path
- sizeBytes (pulumi.Input[float]) - - The size of the file, in bytes.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.datacatalog.EntryGroup(resource_name, opts=None, description=None, display_name=None, entry_group_id=None, project=None, region=None, __props__=None, __name__=None, __opts__=None)¶

An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources.

To get more information about EntryGroup, see:

API documentation
How-to Guides
- Official Documentation

import pulumi
import pulumi_gcp as gcp

basic_entry_group = gcp.datacatalog.EntryGroup("basicEntryGroup", entry_group_id="my_group")

import pulumi
import pulumi_gcp as gcp

basic_entry_group = gcp.datacatalog.EntryGroup("basicEntryGroup",
    description="entry group created by Terraform",
    display_name="terraform entry group",
    entry_group_id="my_group")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
display_name (pulumi.Input[str]) – A short name to identify the entry group, for example, “analytics data - jan 2011”.
entry_group_id (pulumi.Input[str]) – 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.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region (pulumi.Input[str]) – EntryGroup location region.

description: pulumi.Output[str] = None¶: Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.

display_name: pulumi.Output[str] = None¶: A short name to identify the entry group, for example, “analytics data - jan 2011”.

entry_group_id: pulumi.Output[str] = None¶: 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.

name: pulumi.Output[str] = None¶: The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}

project: pulumi.Output[str] = None¶: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region: pulumi.Output[str] = None¶: EntryGroup location region.

static get(resource_name, id, opts=None, description=None, display_name=None, entry_group_id=None, name=None, project=None, region=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
description (pulumi.Input[str]) – Entry group description, which can consist of several sentences or paragraphs that describe entry group contents.
display_name (pulumi.Input[str]) – A short name to identify the entry group, for example, “analytics data - jan 2011”.
entry_group_id (pulumi.Input[str]) – 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.
name (pulumi.Input[str]) – The resource name of the entry group in URL format. Example: projects/{project}/locations/{location}/entryGroups/{entryGroupId}
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region (pulumi.Input[str]) – EntryGroup location region.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.datacatalog.EntryGroupIamBinding(resource_name, opts=None, condition=None, entry_group=None, members=None, project=None, region=None, role=None, __props__=None, __name__=None, __opts__=None)¶

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

datacatalog.EntryGroupIamPolicy: Authoritative. Sets the IAM policy for the entrygroup and replaces any existing policy already attached.
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.
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: datacatalog.EntryGroupIamPolicy cannot be used in conjunction with datacatalog.EntryGroupIamBinding and datacatalog.EntryGroupIamMember or they will fight over what your policy should be.
Note: datacatalog.EntryGroupIamBinding resources can be used in conjunction with datacatalog.EntryGroupIamMember resources only if they do not grant privilege to the same role.

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(binding=[{
    "role": "roles/viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.datacatalog.EntryGroupIamPolicy("policy",
    entry_group=google_data_catalog_entry_group["basic_entry_group"]["name"],
    policy_data=admin.policy_data)

import pulumi
import pulumi_gcp as gcp

binding = gcp.datacatalog.EntryGroupIamBinding("binding",
    entry_group=google_data_catalog_entry_group["basic_entry_group"]["name"],
    role="roles/viewer",
    members=["user:jane@example.com"])

import pulumi
import pulumi_gcp as gcp

member = gcp.datacatalog.EntryGroupIamMember("member",
    entry_group=google_data_catalog_entry_group["basic_entry_group"]["name"],
    role="roles/viewer",
    member="user:jane@example.com")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
entry_group (pulumi.Input[str]) – Used to find the parent resource to bind the IAM policy to
project (pulumi.Input[str]) – 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.
role (pulumi.Input[str]) – The role that should be applied. Only one datacatalog.EntryGroupIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

The condition object supports the following:

description (pulumi.Input[str])
expression (pulumi.Input[str])
title (pulumi.Input[str])

entry_group: pulumi.Output[str] = None¶: Used to find the parent resource to bind the IAM policy to

etag: pulumi.Output[str] = None¶: (Computed) The etag of the IAM policy.

project: pulumi.Output[str] = None¶: 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.

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

static get(resource_name, id, opts=None, condition=None, entry_group=None, etag=None, members=None, project=None, region=None, role=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
entry_group (pulumi.Input[str]) – Used to find the parent resource to bind the IAM policy to
etag (pulumi.Input[str]) – (Computed) The etag of the IAM policy.
project (pulumi.Input[str]) – 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.
role (pulumi.Input[str]) – The role that should be applied. Only one datacatalog.EntryGroupIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

The condition object supports the following:

description (pulumi.Input[str])
expression (pulumi.Input[str])
title (pulumi.Input[str])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.datacatalog.EntryGroupIamMember(resource_name, opts=None, condition=None, entry_group=None, member=None, project=None, region=None, role=None, __props__=None, __name__=None, __opts__=None)¶

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

datacatalog.EntryGroupIamPolicy: Authoritative. Sets the IAM policy for the entrygroup and replaces any existing policy already attached.
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.
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: datacatalog.EntryGroupIamPolicy cannot be used in conjunction with datacatalog.EntryGroupIamBinding and datacatalog.EntryGroupIamMember or they will fight over what your policy should be.
Note: datacatalog.EntryGroupIamBinding resources can be used in conjunction with datacatalog.EntryGroupIamMember resources only if they do not grant privilege to the same role.

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(binding=[{
    "role": "roles/viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.datacatalog.EntryGroupIamPolicy("policy",
    entry_group=google_data_catalog_entry_group["basic_entry_group"]["name"],
    policy_data=admin.policy_data)

import pulumi
import pulumi_gcp as gcp

binding = gcp.datacatalog.EntryGroupIamBinding("binding",
    entry_group=google_data_catalog_entry_group["basic_entry_group"]["name"],
    role="roles/viewer",
    members=["user:jane@example.com"])

import pulumi
import pulumi_gcp as gcp

member = gcp.datacatalog.EntryGroupIamMember("member",
    entry_group=google_data_catalog_entry_group["basic_entry_group"]["name"],
    role="roles/viewer",
    member="user:jane@example.com")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
entry_group (pulumi.Input[str]) – Used to find the parent resource to bind the IAM policy to
project (pulumi.Input[str]) – 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.
role (pulumi.Input[str]) – The role that should be applied. Only one datacatalog.EntryGroupIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

The condition object supports the following:

description (pulumi.Input[str])
expression (pulumi.Input[str])
title (pulumi.Input[str])

entry_group: pulumi.Output[str] = None¶: Used to find the parent resource to bind the IAM policy to

etag: pulumi.Output[str] = None¶: (Computed) The etag of the IAM policy.

project: pulumi.Output[str] = None¶: 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.

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

static get(resource_name, id, opts=None, condition=None, entry_group=None, etag=None, member=None, project=None, region=None, role=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
entry_group (pulumi.Input[str]) – Used to find the parent resource to bind the IAM policy to
etag (pulumi.Input[str]) – (Computed) The etag of the IAM policy.
project (pulumi.Input[str]) – 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.
role (pulumi.Input[str]) – The role that should be applied. Only one datacatalog.EntryGroupIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

The condition object supports the following:

description (pulumi.Input[str])
expression (pulumi.Input[str])
title (pulumi.Input[str])

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.datacatalog.EntryGroupIamPolicy(resource_name, opts=None, entry_group=None, policy_data=None, project=None, region=None, __props__=None, __name__=None, __opts__=None)¶

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

datacatalog.EntryGroupIamPolicy: Authoritative. Sets the IAM policy for the entrygroup and replaces any existing policy already attached.
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.
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: datacatalog.EntryGroupIamPolicy cannot be used in conjunction with datacatalog.EntryGroupIamBinding and datacatalog.EntryGroupIamMember or they will fight over what your policy should be.
Note: datacatalog.EntryGroupIamBinding resources can be used in conjunction with datacatalog.EntryGroupIamMember resources only if they do not grant privilege to the same role.

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(binding=[{
    "role": "roles/viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.datacatalog.EntryGroupIamPolicy("policy",
    entry_group=google_data_catalog_entry_group["basic_entry_group"]["name"],
    policy_data=admin.policy_data)

import pulumi
import pulumi_gcp as gcp

binding = gcp.datacatalog.EntryGroupIamBinding("binding",
    entry_group=google_data_catalog_entry_group["basic_entry_group"]["name"],
    role="roles/viewer",
    members=["user:jane@example.com"])

import pulumi
import pulumi_gcp as gcp

member = gcp.datacatalog.EntryGroupIamMember("member",
    entry_group=google_data_catalog_entry_group["basic_entry_group"]["name"],
    role="roles/viewer",
    member="user:jane@example.com")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
entry_group (pulumi.Input[str]) – Used to find the parent resource to bind the IAM policy to
policy_data (pulumi.Input[str]) – The policy data generated by a organizations.getIAMPolicy data source.
project (pulumi.Input[str]) – 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.

entry_group: pulumi.Output[str] = None¶: Used to find the parent resource to bind the IAM policy to

etag: pulumi.Output[str] = None¶: (Computed) The etag of the IAM policy.

policy_data: pulumi.Output[str] = None¶: The policy data generated by a organizations.getIAMPolicy data source.

project: pulumi.Output[str] = None¶: 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.

static get(resource_name, id, opts=None, entry_group=None, etag=None, policy_data=None, project=None, region=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
entry_group (pulumi.Input[str]) – Used to find the parent resource to bind the IAM policy to
etag (pulumi.Input[str]) – (Computed) The etag of the IAM policy.
policy_data (pulumi.Input[str]) – The policy data generated by a organizations.getIAMPolicy data source.
project (pulumi.Input[str]) – 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.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.datacatalog.Tag(resource_name, opts=None, column=None, fields=None, parent=None, template=None, __props__=None, __name__=None, __opts__=None)¶

Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template.

See Data Catalog IAM for information on the permissions needed to create or view tags.

To get more information about Tag, see:

API documentation
How-to Guides
- Official Documentation

import pulumi
import pulumi_gcp as gcp

entry_group = gcp.datacatalog.EntryGroup("entryGroup", entry_group_id="my_entry_group")
entry = gcp.datacatalog.Entry("entry",
    entry_group=entry_group.id,
    entry_id="my_entry",
    user_specified_type="my_custom_type",
    user_specified_system="SomethingExternal")
tag_template = gcp.datacatalog.TagTemplate("tagTemplate",
    tag_template_id="my_template",
    region="us-central1",
    display_name="Demo Tag Template",
    fields=[
        {
            "fieldId": "source",
            "display_name": "Source of data asset",
            "type": {
                "primitiveType": "STRING",
            },
            "isRequired": True,
        },
        {
            "fieldId": "num_rows",
            "display_name": "Number of rows in the data asset",
            "type": {
                "primitiveType": "DOUBLE",
            },
        },
        {
            "fieldId": "pii_type",
            "display_name": "PII type",
            "type": {
                "enum_type": {
                    "allowed_values": [
                        {
                            "display_name": "EMAIL",
                        },
                        {
                            "display_name": "SOCIAL SECURITY NUMBER",
                        },
                        {
                            "display_name": "NONE",
                        },
                    ],
                },
            },
        },
    ],
    force_delete="false")
basic_tag = gcp.datacatalog.Tag("basicTag",
    parent=entry.id,
    template=tag_template.id,
    fields=[{
        "fieldName": "source",
        "stringValue": "my-string",
    }])

import pulumi
import pulumi_gcp as gcp

entry_group = gcp.datacatalog.EntryGroup("entryGroup", entry_group_id="my_entry_group")
first_entry = gcp.datacatalog.Entry("firstEntry",
    entry_group=entry_group.id,
    entry_id="first_entry",
    user_specified_type="my_custom_type",
    user_specified_system="SomethingExternal")
second_entry = gcp.datacatalog.Entry("secondEntry",
    entry_group=entry_group.id,
    entry_id="second_entry",
    user_specified_type="another_custom_type",
    user_specified_system="SomethingElseExternal")
tag_template = gcp.datacatalog.TagTemplate("tagTemplate",
    tag_template_id="my_template",
    region="us-central1",
    display_name="Demo Tag Template",
    fields=[
        {
            "fieldId": "source",
            "display_name": "Source of data asset",
            "type": {
                "primitiveType": "STRING",
            },
            "isRequired": True,
        },
        {
            "fieldId": "num_rows",
            "display_name": "Number of rows in the data asset",
            "type": {
                "primitiveType": "DOUBLE",
            },
        },
        {
            "fieldId": "pii_type",
            "display_name": "PII type",
            "type": {
                "enum_type": {
                    "allowed_values": [
                        {
                            "display_name": "EMAIL",
                        },
                        {
                            "display_name": "SOCIAL SECURITY NUMBER",
                        },
                        {
                            "display_name": "NONE",
                        },
                    ],
                },
            },
        },
    ],
    force_delete="false")
entry_group_tag = gcp.datacatalog.Tag("entryGroupTag",
    parent=entry_group.id,
    template=tag_template.id,
    fields=[{
        "fieldName": "source",
        "stringValue": "my-string",
    }])

import pulumi
import pulumi_gcp as gcp

entry_group = gcp.datacatalog.EntryGroup("entryGroup", entry_group_id="my_entry_group")
entry = gcp.datacatalog.Entry("entry",
    entry_group=entry_group.id,
    entry_id="my_entry",
    user_specified_type="my_custom_type",
    user_specified_system="SomethingExternal",
    schema="""{
  "columns": [
    {
      "column": "first_name",
      "description": "First name",
      "mode": "REQUIRED",
      "type": "STRING"
    },
    {
      "column": "last_name",
      "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"
    }
  ]
}
""")
tag_template = gcp.datacatalog.TagTemplate("tagTemplate",
    tag_template_id="my_template",
    region="us-central1",
    display_name="Demo Tag Template",
    fields=[
        {
            "fieldId": "source",
            "display_name": "Source of data asset",
            "type": {
                "primitiveType": "STRING",
            },
            "isRequired": True,
        },
        {
            "fieldId": "num_rows",
            "display_name": "Number of rows in the data asset",
            "type": {
                "primitiveType": "DOUBLE",
            },
        },
        {
            "fieldId": "pii_type",
            "display_name": "PII type",
            "type": {
                "enum_type": {
                    "allowed_values": [
                        {
                            "display_name": "EMAIL",
                        },
                        {
                            "display_name": "SOCIAL SECURITY NUMBER",
                        },
                        {
                            "display_name": "NONE",
                        },
                    ],
                },
            },
        },
    ],
    force_delete="false")
basic_tag = gcp.datacatalog.Tag("basicTag",
    parent=entry.id,
    template=tag_template.id,
    fields=[
        {
            "fieldName": "source",
            "stringValue": "my-string",
        },
        {
            "fieldName": "num_rows",
            "doubleValue": 5,
        },
        {
            "fieldName": "pii_type",
            "enumValue": "EMAIL",
        },
    ],
    column="address")
second_tag = gcp.datacatalog.Tag("second-tag",
    parent=entry.id,
    template=tag_template.id,
    fields=[
        {
            "fieldName": "source",
            "stringValue": "my-string",
        },
        {
            "fieldName": "pii_type",
            "enumValue": "NONE",
        },
    ],
    column="first_name")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
column (pulumi.Input[str]) – Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column
fields (pulumi.Input[list]) – This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.
parent (pulumi.Input[str]) – The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.
template (pulumi.Input[str]) – The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.

The fields object supports the following:

boolValue (pulumi.Input[bool]) - Holds the value for a tag field with boolean type.
display_name (pulumi.Input[str]) - - The display name of this field
doubleValue (pulumi.Input[float]) - Holds the value for a tag field with double type.
enumValue (pulumi.Input[str]) - Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum. Structure is documented below.
fieldName (pulumi.Input[str]) - The identifier for this object. Format specified above.
order (pulumi.Input[float]) - - The order of this field with respect to other fields in this tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
stringValue (pulumi.Input[str]) - Holds the value for a tag field with string type.
timestampValue (pulumi.Input[str]) - Holds the value for a tag field with timestamp type.

column: pulumi.Output[str] = None¶: Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column

fields: pulumi.Output[list] = None¶

This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.

boolValue (bool) - Holds the value for a tag field with boolean type.
display_name (str) - - The display name of this field
doubleValue (float) - Holds the value for a tag field with double type.
enumValue (str) - Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum. Structure is documented below.
fieldName (str) - The identifier for this object. Format specified above.
order (float) - - The order of this field with respect to other fields in this tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
stringValue (str) - Holds the value for a tag field with string type.
timestampValue (str) - Holds the value for a tag field with timestamp type.

name: pulumi.Output[str] = None¶: The resource name of the tag in URL format. Example: projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id} or projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.

parent: pulumi.Output[str] = None¶: The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.

template: pulumi.Output[str] = None¶: The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.

template_displayname: pulumi.Output[str] = None¶: The display name of the tag template.

static get(resource_name, id, opts=None, column=None, fields=None, name=None, parent=None, template=None, template_displayname=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
column (pulumi.Input[str]) – Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema. For attaching a tag to a nested column, use . to separate the column names. Example: outer_column.inner_column
fields (pulumi.Input[list]) – This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag’s template. A tag must have at least 1 field and at most 500 fields. Structure is documented below.
name (pulumi.Input[str]) – The resource name of the tag in URL format. Example: projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/entries/{entryId}/tags/{tag_id} or projects/{project_id}/locations/{location}/entrygroups/{entryGroupId}/tags/{tag_id} where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.
parent (pulumi.Input[str]) – The name of the parent this tag is attached to. This can be the name of an entry or an entry group. If an entry group, the tag will be attached to all entries in that group.
template (pulumi.Input[str]) – The resource name of the tag template that this tag uses. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId} This field cannot be modified after creation.
template_displayname (pulumi.Input[str]) – The display name of the tag template.

The fields object supports the following:

boolValue (pulumi.Input[bool]) - Holds the value for a tag field with boolean type.
display_name (pulumi.Input[str]) - - The display name of this field
doubleValue (pulumi.Input[float]) - Holds the value for a tag field with double type.
enumValue (pulumi.Input[str]) - Holds the value for a tag field with enum type. This value must be one of the allowed values in the definition of this enum. Structure is documented below.
fieldName (pulumi.Input[str]) - The identifier for this object. Format specified above.
order (pulumi.Input[float]) - - The order of this field with respect to other fields in this tag. For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
stringValue (pulumi.Input[str]) - Holds the value for a tag field with string type.
timestampValue (pulumi.Input[str]) - Holds the value for a tag field with timestamp type.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_gcp.datacatalog.TagTemplate(resource_name, opts=None, display_name=None, fields=None, force_delete=None, project=None, region=None, tag_template_id=None, __props__=None, __name__=None, __opts__=None)¶

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

import pulumi
import pulumi_gcp as gcp

basic_tag_template = gcp.datacatalog.TagTemplate("basicTagTemplate",
    display_name="Demo Tag Template",
    fields=[
        {
            "display_name": "Source of data asset",
            "fieldId": "source",
            "isRequired": True,
            "type": {
                "primitiveType": "STRING",
            },
        },
        {
            "display_name": "Number of rows in the data asset",
            "fieldId": "num_rows",
            "type": {
                "primitiveType": "DOUBLE",
            },
        },
        {
            "display_name": "PII type",
            "fieldId": "pii_type",
            "type": {
                "enumType": {
                    "allowedValues": [
                        {
                            "display_name": "EMAIL",
                        },
                        {
                            "display_name": "SOCIAL SECURITY NUMBER",
                        },
                        {
                            "display_name": "NONE",
                        },
                    ],
                },
            },
        },
    ],
    force_delete="false",
    region="us-central1",
    tag_template_id="my_template")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
display_name (pulumi.Input[str]) – The display name for this template.
fields (pulumi.Input[list]) – 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.
force_delete (pulumi.Input[bool]) – This confirms the deletion of any possible tags using this template. Must be set to true in order to delete the tag template.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region (pulumi.Input[str]) – Template location region.
tag_template_id (pulumi.Input[str]) – The id of the tag template to create.

The fields object supports the following:

display_name (pulumi.Input[str]) - The display name for this template.
fieldId (pulumi.Input[str]) - The identifier for this object. Format specified above.
isRequired (pulumi.Input[bool]) - Whether this is a required field. Defaults to false.
name (pulumi.Input[str]) - - The resource name of the tag template field in URL format. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId}/fields/{field}
order (pulumi.Input[float]) - The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
type (pulumi.Input[dict]) - The type of value this tag field can contain. Structure is documented below.
- enumType (pulumi.Input[dict]) - Represents an enum type. Exactly one of primitive_type or enum_type must be set Structure is documented below.
  - allowedValues (pulumi.Input[list]) - The set of allowed values for this enum. The display names of the values must be case-insensitively unique within this set. Currently, enum values can only be added to the list of allowed values. Deletion and renaming of enum values are not supported. Can have up to 500 allowed values. Structure is documented below.
    - display_name (pulumi.Input[str]) - The display name for this template.
- primitiveType (pulumi.Input[str]) - Represents primitive types - string, bool etc. Exactly one of primitive_type or enum_type must be set

display_name: pulumi.Output[str] = None¶: The display name for this template.

fields: pulumi.Output[list] = None¶

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.

display_name (str) - The display name for this template.
fieldId (str) - The identifier for this object. Format specified above.
isRequired (bool) - Whether this is a required field. Defaults to false.
name (str) - - The resource name of the tag template field in URL format. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId}/fields/{field}
order (float) - The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
type (dict) - The type of value this tag field can contain. Structure is documented below.
- enumType (dict) - Represents an enum type. Exactly one of primitive_type or enum_type must be set Structure is documented below.
  - allowedValues (list) - The set of allowed values for this enum. The display names of the values must be case-insensitively unique within this set. Currently, enum values can only be added to the list of allowed values. Deletion and renaming of enum values are not supported. Can have up to 500 allowed values. Structure is documented below.
    - display_name (str) - The display name for this template.
- primitiveType (str) - Represents primitive types - string, bool etc. Exactly one of primitive_type or enum_type must be set

force_delete: pulumi.Output[bool] = None¶: This confirms the deletion of any possible tags using this template. Must be set to true in order to delete the tag template.

name: pulumi.Output[str] = None¶

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

project: pulumi.Output[str] = None¶: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region: pulumi.Output[str] = None¶: Template location region.

tag_template_id: pulumi.Output[str] = None¶: The id of the tag template to create.

static get(resource_name, id, opts=None, display_name=None, fields=None, force_delete=None, name=None, project=None, region=None, tag_template_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
display_name (pulumi.Input[str]) – The display name for this template.
fields (pulumi.Input[list]) – 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.
force_delete (pulumi.Input[bool]) – This confirms the deletion of any possible tags using this template. Must be set to true in order to delete the tag template.
name (pulumi.Input[str]) –
The resource name of the tag template field in URL format. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId}/fields/{field}
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
region (pulumi.Input[str]) – Template location region.
tag_template_id (pulumi.Input[str]) – The id of the tag template to create.

The fields object supports the following:

display_name (pulumi.Input[str]) - The display name for this template.
fieldId (pulumi.Input[str]) - The identifier for this object. Format specified above.
isRequired (pulumi.Input[bool]) - Whether this is a required field. Defaults to false.
name (pulumi.Input[str]) - - The resource name of the tag template field in URL format. Example: projects/{project_id}/locations/{location}/tagTemplates/{tagTemplateId}/fields/{field}
order (pulumi.Input[float]) - The order of this field with respect to other fields in this tag template. A higher value indicates a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag do not have to be sequential.
type (pulumi.Input[dict]) - The type of value this tag field can contain. Structure is documented below.
- enumType (pulumi.Input[dict]) - Represents an enum type. Exactly one of primitive_type or enum_type must be set Structure is documented below.
  - allowedValues (pulumi.Input[list]) - The set of allowed values for this enum. The display names of the values must be case-insensitively unique within this set. Currently, enum values can only be added to the list of allowed values. Deletion and renaming of enum values are not supported. Can have up to 500 allowed values. Structure is documented below.
    - display_name (pulumi.Input[str]) - The display name for this template.
- primitiveType (pulumi.Input[str]) - Represents primitive types - string, bool etc. Exactly one of primitive_type or enum_type must be set

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

datacatalog¶

On This Page