TagBinding class

A TagBinding represents a connection between a TagValue and a cloud resource (currently project, folder, or organization). Once a TagBinding is created, the TagValue is applied to all the descendants of the cloud resource.

To get more information about TagBinding, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Tag Binding Basic

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

const project = new gcp.organizations.Project("project", {
    projectId: "project_id",
    name: "project_id",
    orgId: "123456789",
    deletionPolicy: "DELETE",
});
const key = new gcp.tags.TagKey("key", {
    parent: "organizations/123456789",
    shortName: "keyname",
    description: "For keyname resources.",
});
const value = new gcp.tags.TagValue("value", {
    parent: key.id,
    shortName: "valuename",
    description: "For valuename resources.",
});
const binding = new gcp.tags.TagBinding("binding", {
    parent: pulumi.interpolate`//cloudresourcemanager.googleapis.com/projects/${project.number}`,
    tagValue: value.id,
});

import pulumi
import pulumi_gcp as gcp

project = gcp.organizations.Project("project",
    project_id="project_id",
    name="project_id",
    org_id="123456789",
    deletion_policy="DELETE")
key = gcp.tags.TagKey("key",
    parent="organizations/123456789",
    short_name="keyname",
    description="For keyname resources.")
value = gcp.tags.TagValue("value",
    parent=key.id,
    short_name="valuename",
    description="For valuename resources.")
binding = gcp.tags.TagBinding("binding",
    parent=project.number.apply(lambda number: f"//cloudresourcemanager.googleapis.com/projects/{number}"),
    tag_value=value.id)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var project = new Gcp.Organizations.Project("project", new()
    {
        ProjectId = "project_id",
        Name = "project_id",
        OrgId = "123456789",
        DeletionPolicy = "DELETE",
    });

    var key = new Gcp.Tags.TagKey("key", new()
    {
        Parent = "organizations/123456789",
        ShortName = "keyname",
        Description = "For keyname resources.",
    });

    var @value = new Gcp.Tags.TagValue("value", new()
    {
        Parent = key.Id,
        ShortName = "valuename",
        Description = "For valuename resources.",
    });

    var binding = new Gcp.Tags.TagBinding("binding", new()
    {
        Parent = project.Number.Apply(number => $"//cloudresourcemanager.googleapis.com/projects/{number}"),
        TagValue = @value.Id,
    });

});

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/tags"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		project, err := organizations.NewProject(ctx, "project", &organizations.ProjectArgs{
			ProjectId:      pulumi.String("project_id"),
			Name:           pulumi.String("project_id"),
			OrgId:          pulumi.String("123456789"),
			DeletionPolicy: pulumi.String("DELETE"),
		})
		if err != nil {
			return err
		}
		key, err := tags.NewTagKey(ctx, "key", &tags.TagKeyArgs{
			Parent:      pulumi.String("organizations/123456789"),
			ShortName:   pulumi.String("keyname"),
			Description: pulumi.String("For keyname resources."),
		})
		if err != nil {
			return err
		}
		value, err := tags.NewTagValue(ctx, "value", &tags.TagValueArgs{
			Parent:      key.ID().ToIDOutput().ToStringOutput(),
			ShortName:   pulumi.String("valuename"),
			Description: pulumi.String("For valuename resources."),
		})
		if err != nil {
			return err
		}
		_, err = tags.NewTagBinding(ctx, "binding", &tags.TagBindingArgs{
			Parent: project.Number.ApplyT(func(number string) (string, error) {
				return fmt.Sprintf("//cloudresourcemanager.googleapis.com/projects/%v", number), nil
			}).(pulumi.StringOutput),
			TagValue: value.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_organizations_project" "project" {
  project_id      = "project_id"
  name            = "project_id"
  org_id          = "123456789"
  deletion_policy = "DELETE"
}
resource "gcp_tags_tagkey" "key" {
  parent      = "organizations/123456789"
  short_name  = "keyname"
  description = "For keyname resources."
}
resource "gcp_tags_tagvalue" "value" {
  parent      = gcp_tags_tagkey.key.id
  short_name  = "valuename"
  description = "For valuename resources."
}
resource "gcp_tags_tagbinding" "binding" {
  parent    ="//cloudresourcemanager.googleapis.com/projects/${gcp_organizations_project.project.number}"
  tag_value = gcp_tags_tagvalue.value.id
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Project;
import com.pulumi.gcp.organizations.ProjectArgs;
import com.pulumi.gcp.tags.TagKey;
import com.pulumi.gcp.tags.TagKeyArgs;
import com.pulumi.gcp.tags.TagValue;
import com.pulumi.gcp.tags.TagValueArgs;
import com.pulumi.gcp.tags.TagBinding;
import com.pulumi.gcp.tags.TagBindingArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var project = new Project("project", ProjectArgs.builder()
            .projectId("project_id")
            .name("project_id")
            .orgId("123456789")
            .deletionPolicy("DELETE")
            .build());

        var key = new TagKey("key", TagKeyArgs.builder()
            .parent("organizations/123456789")
            .shortName("keyname")
            .description("For keyname resources.")
            .build());

        var value = new TagValue("value", TagValueArgs.builder()
            .parent(key.id())
            .shortName("valuename")
            .description("For valuename resources.")
            .build());

        var binding = new TagBinding("binding", TagBindingArgs.builder()
            .parent(project.number().applyValue(_number -> String.format("//cloudresourcemanager.googleapis.com/projects/%s", _number)))
            .tagValue(value.id())
            .build());

    }
}

resources:
  project:
    type: gcp:organizations:Project
    properties:
      projectId: project_id
      name: project_id
      orgId: '123456789'
      deletionPolicy: DELETE
  key:
    type: gcp:tags:TagKey
    properties:
      parent: organizations/123456789
      shortName: keyname
      description: For keyname resources.
  value:
    type: gcp:tags:TagValue
    properties:
      parent: ${key.id}
      shortName: valuename
      description: For valuename resources.
  binding:
    type: gcp:tags:TagBinding
    properties:
      parent: //cloudresourcemanager.googleapis.com/projects/${project.number}
      tagValue: ${value.id}

Tag Binding Using Dynamic Tag Value

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

const project = new gcp.organizations.Project("project", {
    projectId: "project_id",
    name: "project_id",
    orgId: "123456789",
    deletionPolicy: "DELETE",
});
const key = new gcp.tags.TagKey("key", {
    parent: "organizations/123456789",
    shortName: "keyname",
    description: "For keyname resources.",
    allowedValuesRegex: "^[a-z]+$",
});
const binding = new gcp.tags.TagBinding("binding", {
    parent: pulumi.interpolate`//cloudresourcemanager.googleapis.com/projects/${project.number}`,
    tagValue: pulumi.interpolate`${key.namespacedName}/test-value`,
});

import pulumi
import pulumi_gcp as gcp

project = gcp.organizations.Project("project",
    project_id="project_id",
    name="project_id",
    org_id="123456789",
    deletion_policy="DELETE")
key = gcp.tags.TagKey("key",
    parent="organizations/123456789",
    short_name="keyname",
    description="For keyname resources.",
    allowed_values_regex="^[a-z]+$")
binding = gcp.tags.TagBinding("binding",
    parent=project.number.apply(lambda number: f"//cloudresourcemanager.googleapis.com/projects/{number}"),
    tag_value=key.namespaced_name.apply(lambda namespaced_name: f"{namespaced_name}/test-value"))

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var project = new Gcp.Organizations.Project("project", new()
    {
        ProjectId = "project_id",
        Name = "project_id",
        OrgId = "123456789",
        DeletionPolicy = "DELETE",
    });

    var key = new Gcp.Tags.TagKey("key", new()
    {
        Parent = "organizations/123456789",
        ShortName = "keyname",
        Description = "For keyname resources.",
        AllowedValuesRegex = "^[a-z]+$",
    });

    var binding = new Gcp.Tags.TagBinding("binding", new()
    {
        Parent = project.Number.Apply(number => $"//cloudresourcemanager.googleapis.com/projects/{number}"),
        TagValue = key.NamespacedName.Apply(namespacedName => $"{namespacedName}/test-value"),
    });

});

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/tags"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		project, err := organizations.NewProject(ctx, "project", &organizations.ProjectArgs{
			ProjectId:      pulumi.String("project_id"),
			Name:           pulumi.String("project_id"),
			OrgId:          pulumi.String("123456789"),
			DeletionPolicy: pulumi.String("DELETE"),
		})
		if err != nil {
			return err
		}
		key, err := tags.NewTagKey(ctx, "key", &tags.TagKeyArgs{
			Parent:             pulumi.String("organizations/123456789"),
			ShortName:          pulumi.String("keyname"),
			Description:        pulumi.String("For keyname resources."),
			AllowedValuesRegex: pulumi.String("^[a-z]+$"),
		})
		if err != nil {
			return err
		}
		_, err = tags.NewTagBinding(ctx, "binding", &tags.TagBindingArgs{
			Parent: project.Number.ApplyT(func(number string) (string, error) {
				return fmt.Sprintf("//cloudresourcemanager.googleapis.com/projects/%v", number), nil
			}).(pulumi.StringOutput),
			TagValue: key.NamespacedName.ApplyT(func(namespacedName string) (string, error) {
				return fmt.Sprintf("%v/test-value", namespacedName), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_organizations_project" "project" {
  project_id      = "project_id"
  name            = "project_id"
  org_id          = "123456789"
  deletion_policy = "DELETE"
}
resource "gcp_tags_tagkey" "key" {
  parent               = "organizations/123456789"
  short_name           = "keyname"
  description          = "For keyname resources."
  allowed_values_regex = "^[a-z]+$"
}
resource "gcp_tags_tagbinding" "binding" {
  parent    ="//cloudresourcemanager.googleapis.com/projects/${gcp_organizations_project.project.number}"
  tag_value ="${gcp_tags_tagkey.key.namespaced_name}/test-value"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Project;
import com.pulumi.gcp.organizations.ProjectArgs;
import com.pulumi.gcp.tags.TagKey;
import com.pulumi.gcp.tags.TagKeyArgs;
import com.pulumi.gcp.tags.TagBinding;
import com.pulumi.gcp.tags.TagBindingArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var project = new Project("project", ProjectArgs.builder()
            .projectId("project_id")
            .name("project_id")
            .orgId("123456789")
            .deletionPolicy("DELETE")
            .build());

        var key = new TagKey("key", TagKeyArgs.builder()
            .parent("organizations/123456789")
            .shortName("keyname")
            .description("For keyname resources.")
            .allowedValuesRegex("^[a-z]+$")
            .build());

        var binding = new TagBinding("binding", TagBindingArgs.builder()
            .parent(project.number().applyValue(_number -> String.format("//cloudresourcemanager.googleapis.com/projects/%s", _number)))
            .tagValue(key.namespacedName().applyValue(_namespacedName -> String.format("%s/test-value", _namespacedName)))
            .build());

    }
}

resources:
  project:
    type: gcp:organizations:Project
    properties:
      projectId: project_id
      name: project_id
      orgId: '123456789'
      deletionPolicy: DELETE
  key:
    type: gcp:tags:TagKey
    properties:
      parent: organizations/123456789
      shortName: keyname
      description: For keyname resources.
      allowedValuesRegex: ^[a-z]+$
  binding:
    type: gcp:tags:TagBinding
    properties:
      parent: //cloudresourcemanager.googleapis.com/projects/${project.number}
      tagValue: ${key.namespacedName}/test-value

Import

TagBinding can be imported using any of these accepted formats:

• tagBindings/{{name}}
• {{name}}

When using the pulumi import command, TagBinding can be imported using one of the formats above. For example:

$ pulumi import gcp:tags/tagBinding:TagBinding default tagBindings/{{name}}
$ pulumi import gcp:tags/tagBinding:TagBinding default {{name}}

Constructors

TagBinding(String name, {TagBindingArgs? args, CustomResourceOptions? options})

Creates a new TagBinding. name The Pulumi resource name. args Arguments used to configure this TagBinding. The set of arguments for TagBinding. options Resource options controlling this resource's behavior.

TagBinding.reference(String urn)

Creates a typed reference to an existing TagBinding resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

The generated id for the TagBinding. This is a string of the form tagBindings/{full-resource-name}/{tag-value-name} or tagBindings/{full-resource-name}/{tag-key-name}

late, final

parent ↔ Output<String>

The full resource name of the resource the TagValue is bound to. E.g. //cloudresourcemanager.googleapis.com/projects/123

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tagValue ↔ Output<String>

The TagValue of the TagBinding. Must be either in id format tagValues/{tag-value-id}, or namespaced format {parent-id}/{tag-key-short-name}/{tag-value-short-name}.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {TagBindingState? state, CustomResourceOptions? options}) → TagBinding

Gets an existing TagBinding resource's state with the given name and id.