Google Cloud Classic v8.9.3, Nov 18 24

Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

gcp.tags.TagKeyIamBinding

Explore with Pulumi AI

Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-gcp

gcp.tags.TagKeyIamPolicy: Authoritative. Sets the IAM policy for the tagkey and replaces any existing policy already attached.
gcp.tags.TagKeyIamBinding: 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 tagkey are preserved.
gcp.tags.TagKeyIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the tagkey are preserved.

A data source can be used to retrieve policy data in advent you do not need creation

gcp.tags.TagKeyIamPolicy: Retrieves the IAM policy for the tagkey

Note: gcp.tags.TagKeyIamPolicy cannot be used in conjunction with gcp.tags.TagKeyIamBinding and gcp.tags.TagKeyIamMember or they will fight over what your policy should be.

Note: gcp.tags.TagKeyIamBinding resources can be used in conjunction with gcp.tags.TagKeyIamMember resources only if they do not grant privilege to the same role.

gcp.tags.TagKeyIamPolicy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.tags.TagKeyIamPolicy("policy", {
    tagKey: key.name,
    policyData: admin.then(admin => admin.policyData),
});

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.tags.TagKeyIamPolicy("policy",
    tag_key=key["name"],
    policy_data=admin.policy_data)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/tags"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Bindings: []organizations.GetIAMPolicyBinding{
				{
					Role: "roles/viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = tags.NewTagKeyIamPolicy(ctx, "policy", &tags.TagKeyIamPolicyArgs{
			TagKey:     pulumi.Any(key.Name),
			PolicyData: pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
    {
        Bindings = new[]
        {
            new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
            {
                Role = "roles/viewer",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.Tags.TagKeyIamPolicy("policy", new()
    {
        TagKey = key.Name,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.tags.TagKeyIamPolicy;
import com.pulumi.gcp.tags.TagKeyIamPolicyArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
            .bindings(GetIAMPolicyBindingArgs.builder()
                .role("roles/viewer")
                .members("user:jane@example.com")
                .build())
            .build());

        var policy = new TagKeyIamPolicy("policy", TagKeyIamPolicyArgs.builder()
            .tagKey(key.name())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}

resources:
  policy:
    type: gcp:tags:TagKeyIamPolicy
    properties:
      tagKey: ${key.name}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/viewer
            members:
              - user:jane@example.com

gcp.tags.TagKeyIamBinding

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

const binding = new gcp.tags.TagKeyIamBinding("binding", {
    tagKey: key.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

import pulumi
import pulumi_gcp as gcp

binding = gcp.tags.TagKeyIamBinding("binding",
    tag_key=key["name"],
    role="roles/viewer",
    members=["user:jane@example.com"])

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/tags"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tags.NewTagKeyIamBinding(ctx, "binding", &tags.TagKeyIamBindingArgs{
			TagKey: pulumi.Any(key.Name),
			Role:   pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.Tags.TagKeyIamBinding("binding", new()
    {
        TagKey = key.Name,
        Role = "roles/viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.tags.TagKeyIamBinding;
import com.pulumi.gcp.tags.TagKeyIamBindingArgs;
import java.util.List;
import java.util.ArrayList;
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 binding = new TagKeyIamBinding("binding", TagKeyIamBindingArgs.builder()
            .tagKey(key.name())
            .role("roles/viewer")
            .members("user:jane@example.com")
            .build());

    }
}

resources:
  binding:
    type: gcp:tags:TagKeyIamBinding
    properties:
      tagKey: ${key.name}
      role: roles/viewer
      members:
        - user:jane@example.com

gcp.tags.TagKeyIamMember

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

const member = new gcp.tags.TagKeyIamMember("member", {
    tagKey: key.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

import pulumi
import pulumi_gcp as gcp

member = gcp.tags.TagKeyIamMember("member",
    tag_key=key["name"],
    role="roles/viewer",
    member="user:jane@example.com")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/tags"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tags.NewTagKeyIamMember(ctx, "member", &tags.TagKeyIamMemberArgs{
			TagKey: pulumi.Any(key.Name),
			Role:   pulumi.String("roles/viewer"),
			Member: pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.Tags.TagKeyIamMember("member", new()
    {
        TagKey = key.Name,
        Role = "roles/viewer",
        Member = "user:jane@example.com",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.tags.TagKeyIamMember;
import com.pulumi.gcp.tags.TagKeyIamMemberArgs;
import java.util.List;
import java.util.ArrayList;
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 member = new TagKeyIamMember("member", TagKeyIamMemberArgs.builder()
            .tagKey(key.name())
            .role("roles/viewer")
            .member("user:jane@example.com")
            .build());

    }
}

resources:
  member:
    type: gcp:tags:TagKeyIamMember
    properties:
      tagKey: ${key.name}
      role: roles/viewer
      member: user:jane@example.com

> Custom Roles If you’re importing a IAM resource with a custom role, make sure to use the

full name of the custom role, e.g. `[projects/my-project|organizations/my-org]/roles/my-custom-role`.

IAM policy for Tags TagKey

Three different resources help you manage your IAM policy for Tags TagKey. Each of these resources serves a different use case:

gcp.tags.TagKeyIamPolicy: Authoritative. Sets the IAM policy for the tagkey and replaces any existing policy already attached.
gcp.tags.TagKeyIamBinding: 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 tagkey are preserved.
gcp.tags.TagKeyIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the tagkey are preserved.

A data source can be used to retrieve policy data in advent you do not need creation

gcp.tags.TagKeyIamPolicy: Retrieves the IAM policy for the tagkey

Note: gcp.tags.TagKeyIamPolicy cannot be used in conjunction with gcp.tags.TagKeyIamBinding and gcp.tags.TagKeyIamMember or they will fight over what your policy should be.

Note: gcp.tags.TagKeyIamBinding resources can be used in conjunction with gcp.tags.TagKeyIamMember resources only if they do not grant privilege to the same role.

gcp.tags.TagKeyIamPolicy

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

const admin = gcp.organizations.getIAMPolicy({
    bindings: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.tags.TagKeyIamPolicy("policy", {
    tagKey: key.name,
    policyData: admin.then(admin => admin.policyData),
});

import pulumi
import pulumi_gcp as gcp

admin = gcp.organizations.get_iam_policy(bindings=[{
    "role": "roles/viewer",
    "members": ["user:jane@example.com"],
}])
policy = gcp.tags.TagKeyIamPolicy("policy",
    tag_key=key["name"],
    policy_data=admin.policy_data)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/tags"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		admin, err := organizations.LookupIAMPolicy(ctx, &organizations.LookupIAMPolicyArgs{
			Bindings: []organizations.GetIAMPolicyBinding{
				{
					Role: "roles/viewer",
					Members: []string{
						"user:jane@example.com",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = tags.NewTagKeyIamPolicy(ctx, "policy", &tags.TagKeyIamPolicyArgs{
			TagKey:     pulumi.Any(key.Name),
			PolicyData: pulumi.String(admin.PolicyData),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var admin = Gcp.Organizations.GetIAMPolicy.Invoke(new()
    {
        Bindings = new[]
        {
            new Gcp.Organizations.Inputs.GetIAMPolicyBindingInputArgs
            {
                Role = "roles/viewer",
                Members = new[]
                {
                    "user:jane@example.com",
                },
            },
        },
    });

    var policy = new Gcp.Tags.TagKeyIamPolicy("policy", new()
    {
        TagKey = key.Name,
        PolicyData = admin.Apply(getIAMPolicyResult => getIAMPolicyResult.PolicyData),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetIAMPolicyArgs;
import com.pulumi.gcp.tags.TagKeyIamPolicy;
import com.pulumi.gcp.tags.TagKeyIamPolicyArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
            .bindings(GetIAMPolicyBindingArgs.builder()
                .role("roles/viewer")
                .members("user:jane@example.com")
                .build())
            .build());

        var policy = new TagKeyIamPolicy("policy", TagKeyIamPolicyArgs.builder()
            .tagKey(key.name())
            .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
            .build());

    }
}

resources:
  policy:
    type: gcp:tags:TagKeyIamPolicy
    properties:
      tagKey: ${key.name}
      policyData: ${admin.policyData}
variables:
  admin:
    fn::invoke:
      Function: gcp:organizations:getIAMPolicy
      Arguments:
        bindings:
          - role: roles/viewer
            members:
              - user:jane@example.com

gcp.tags.TagKeyIamBinding

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

const binding = new gcp.tags.TagKeyIamBinding("binding", {
    tagKey: key.name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

import pulumi
import pulumi_gcp as gcp

binding = gcp.tags.TagKeyIamBinding("binding",
    tag_key=key["name"],
    role="roles/viewer",
    members=["user:jane@example.com"])

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/tags"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tags.NewTagKeyIamBinding(ctx, "binding", &tags.TagKeyIamBindingArgs{
			TagKey: pulumi.Any(key.Name),
			Role:   pulumi.String("roles/viewer"),
			Members: pulumi.StringArray{
				pulumi.String("user:jane@example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var binding = new Gcp.Tags.TagKeyIamBinding("binding", new()
    {
        TagKey = key.Name,
        Role = "roles/viewer",
        Members = new[]
        {
            "user:jane@example.com",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.tags.TagKeyIamBinding;
import com.pulumi.gcp.tags.TagKeyIamBindingArgs;
import java.util.List;
import java.util.ArrayList;
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 binding = new TagKeyIamBinding("binding", TagKeyIamBindingArgs.builder()
            .tagKey(key.name())
            .role("roles/viewer")
            .members("user:jane@example.com")
            .build());

    }
}

resources:
  binding:
    type: gcp:tags:TagKeyIamBinding
    properties:
      tagKey: ${key.name}
      role: roles/viewer
      members:
        - user:jane@example.com

gcp.tags.TagKeyIamMember

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

const member = new gcp.tags.TagKeyIamMember("member", {
    tagKey: key.name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

import pulumi
import pulumi_gcp as gcp

member = gcp.tags.TagKeyIamMember("member",
    tag_key=key["name"],
    role="roles/viewer",
    member="user:jane@example.com")

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/tags"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tags.NewTagKeyIamMember(ctx, "member", &tags.TagKeyIamMemberArgs{
			TagKey: pulumi.Any(key.Name),
			Role:   pulumi.String("roles/viewer"),
			Member: pulumi.String("user:jane@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var member = new Gcp.Tags.TagKeyIamMember("member", new()
    {
        TagKey = key.Name,
        Role = "roles/viewer",
        Member = "user:jane@example.com",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.tags.TagKeyIamMember;
import com.pulumi.gcp.tags.TagKeyIamMemberArgs;
import java.util.List;
import java.util.ArrayList;
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 member = new TagKeyIamMember("member", TagKeyIamMemberArgs.builder()
            .tagKey(key.name())
            .role("roles/viewer")
            .member("user:jane@example.com")
            .build());

    }
}

resources:
  member:
    type: gcp:tags:TagKeyIamMember
    properties:
      tagKey: ${key.name}
      role: roles/viewer
      member: user:jane@example.com

Create TagKeyIamBinding Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new TagKeyIamBinding(name: string, args: TagKeyIamBindingArgs, opts?: CustomResourceOptions);

@overload
def TagKeyIamBinding(resource_name: str,
                     args: TagKeyIamBindingArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def TagKeyIamBinding(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     members: Optional[Sequence[str]] = None,
                     role: Optional[str] = None,
                     tag_key: Optional[str] = None,
                     condition: Optional[TagKeyIamBindingConditionArgs] = None)

func NewTagKeyIamBinding(ctx *Context, name string, args TagKeyIamBindingArgs, opts ...ResourceOption) (*TagKeyIamBinding, error)

public TagKeyIamBinding(string name, TagKeyIamBindingArgs args, CustomResourceOptions? opts = null)

public TagKeyIamBinding(String name, TagKeyIamBindingArgs args)
public TagKeyIamBinding(String name, TagKeyIamBindingArgs args, CustomResourceOptions options)

type: gcp:tags:TagKeyIamBinding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args TagKeyIamBindingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args TagKeyIamBindingArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TagKeyIamBindingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TagKeyIamBindingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TagKeyIamBindingArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var tagKeyIamBindingResource = new Gcp.Tags.TagKeyIamBinding("tagKeyIamBindingResource", new()
{
    Members = new[]
    {
        "string",
    },
    Role = "string",
    TagKey = "string",
    Condition = new Gcp.Tags.Inputs.TagKeyIamBindingConditionArgs
    {
        Expression = "string",
        Title = "string",
        Description = "string",
    },
});

example, err := tags.NewTagKeyIamBinding(ctx, "tagKeyIamBindingResource", &tags.TagKeyIamBindingArgs{
	Members: pulumi.StringArray{
		pulumi.String("string"),
	},
	Role:   pulumi.String("string"),
	TagKey: pulumi.String("string"),
	Condition: &tags.TagKeyIamBindingConditionArgs{
		Expression:  pulumi.String("string"),
		Title:       pulumi.String("string"),
		Description: pulumi.String("string"),
	},
})

var tagKeyIamBindingResource = new TagKeyIamBinding("tagKeyIamBindingResource", TagKeyIamBindingArgs.builder()
    .members("string")
    .role("string")
    .tagKey("string")
    .condition(TagKeyIamBindingConditionArgs.builder()
        .expression("string")
        .title("string")
        .description("string")
        .build())
    .build());

tag_key_iam_binding_resource = gcp.tags.TagKeyIamBinding("tagKeyIamBindingResource",
    members=["string"],
    role="string",
    tag_key="string",
    condition={
        "expression": "string",
        "title": "string",
        "description": "string",
    })

const tagKeyIamBindingResource = new gcp.tags.TagKeyIamBinding("tagKeyIamBindingResource", {
    members: ["string"],
    role: "string",
    tagKey: "string",
    condition: {
        expression: "string",
        title: "string",
        description: "string",
    },
});

type: gcp:tags:TagKeyIamBinding
properties:
    condition:
        description: string
        expression: string
        title: string
    members:
        - string
    role: string
    tagKey: string

TagKeyIamBinding Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The TagKeyIamBinding resource accepts the following input properties:

Members List<string>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

Role string

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

TagKey string

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

Condition TagKeyIamBindingCondition

Members []string

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

Role string

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

TagKey string

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

Condition TagKeyIamBindingConditionArgs

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role String

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

tagKey String

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

condition TagKeyIamBindingCondition

members string[]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role string

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

tagKey string

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

condition TagKeyIamBindingCondition

members Sequence[str]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role str

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

tag_key str

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

condition TagKeyIamBindingConditionArgs

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role String

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

tagKey String

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

condition Property Map

Outputs

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

Etag string: (Computed) The etag of the IAM policy.
Id string: The provider-assigned unique ID for this managed resource.

Etag string: (Computed) The etag of the IAM policy.
Id string: The provider-assigned unique ID for this managed resource.

etag String: (Computed) The etag of the IAM policy.
id String: The provider-assigned unique ID for this managed resource.

etag string: (Computed) The etag of the IAM policy.
id string: The provider-assigned unique ID for this managed resource.

etag str: (Computed) The etag of the IAM policy.
id str: The provider-assigned unique ID for this managed resource.

etag String: (Computed) The etag of the IAM policy.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing TagKeyIamBinding Resource

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

public static get(name: string, id: Input<ID>, state?: TagKeyIamBindingState, opts?: CustomResourceOptions): TagKeyIamBinding

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[TagKeyIamBindingConditionArgs] = None,
        etag: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        role: Optional[str] = None,
        tag_key: Optional[str] = None) -> TagKeyIamBinding

func GetTagKeyIamBinding(ctx *Context, name string, id IDInput, state *TagKeyIamBindingState, opts ...ResourceOption) (*TagKeyIamBinding, error)

public static TagKeyIamBinding Get(string name, Input<string> id, TagKeyIamBindingState? state, CustomResourceOptions? opts = null)

public static TagKeyIamBinding get(String name, Output<String> id, TagKeyIamBindingState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Condition TagKeyIamBindingCondition

Etag string

(Computed) The etag of the IAM policy.

Members List<string>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

Role string

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

TagKey string

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

Condition TagKeyIamBindingConditionArgs

Etag string

(Computed) The etag of the IAM policy.

Members []string

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

Role string

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

TagKey string

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

condition TagKeyIamBindingCondition

etag String

(Computed) The etag of the IAM policy.

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role String

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

tagKey String

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

condition TagKeyIamBindingCondition

etag string

(Computed) The etag of the IAM policy.

members string[]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role string

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

tagKey string

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

condition TagKeyIamBindingConditionArgs

etag str

(Computed) The etag of the IAM policy.

members Sequence[str]

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role str

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

tag_key str

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

condition Property Map

etag String

(Computed) The etag of the IAM policy.

members List<String>

Identities that will be granted the privilege in role. Each entry can have one of the following values:

allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.
serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
domain:{domain}: A G Suite domain (primary, instead of alias) name that represents all the users of that domain. For example, google.com or example.com.
projectOwner:projectid: Owners of the given project. For example, "projectOwner:my-example-project"
projectEditor:projectid: Editors of the given project. For example, "projectEditor:my-example-project"
projectViewer:projectid: Viewers of the given project. For example, "projectViewer:my-example-project"

role String

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

tagKey String

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

Supporting Types

TagKeyIamBindingCondition, TagKeyIamBindingConditionArgs

Expression string
Title string
Description string

Expression string
Title string
Description string

expression String
title String
description String

expression string
title string
description string

expression str
title str
description str

expression String
title String
description String

Import

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

tagKeys/{{name}}
{{name}}

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

Tags tagkey IAM resources can be imported using the resource identifiers, role, and member.

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

$ pulumi import gcp:tags/tagKeyIamBinding:TagKeyIamBinding editor "tagKeys/{{tag_key}} roles/viewer user:jane@example.com"

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

$ pulumi import gcp:tags/tagKeyIamBinding:TagKeyIamBinding editor "tagKeys/{{tag_key}} roles/viewer"

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

$ pulumi import gcp:tags/tagKeyIamBinding:TagKeyIamBinding editor tagKeys/{{tag_key}}

-> Custom Roles If you’re importing a IAM resource with a custom role, make sure to use the

full name of the custom role, e.g. [projects/my-project|organizations/my-org]/roles/my-custom-role.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

pulumi/pulumi-gcp

gcp.tags.TagKeyIamBinding

On this page

On this page

gcp.tags.TagKeyIamPolicy

gcp.tags.TagKeyIamBinding

gcp.tags.TagKeyIamMember

> Custom Roles If you’re importing a IAM resource with a custom role, make sure to use the

full name of the custom role, e.g. `[projects/my-project|organizations/my-org]/roles/my-custom-role`.

IAM policy for Tags TagKey

gcp.tags.TagKeyIamPolicy

gcp.tags.TagKeyIamBinding

gcp.tags.TagKeyIamMember

Create TagKeyIamBinding Resource

Constructor syntax

Parameters

Constructor example

TagKeyIamBinding Resource Properties

Inputs

Outputs

Look up Existing TagKeyIamBinding Resource

Supporting Types

TagKeyIamBindingCondition, TagKeyIamBindingConditionArgs

Import

Package Details

On this page

On this page

gcp.tags.TagKeyIamBinding

On this page

On this page

gcp.tags.TagKeyIamPolicy

gcp.tags.TagKeyIamBinding

gcp.tags.TagKeyIamMember

> Custom Roles If you’re importing a IAM resource with a custom role, make sure to use the

full name of the custom role, e.g. [projects/my-project|organizations/my-org]/roles/my-custom-role.

IAM policy for Tags TagKey

gcp.tags.TagKeyIamPolicy

gcp.tags.TagKeyIamBinding

gcp.tags.TagKeyIamMember

Create TagKeyIamBinding Resource

Constructor syntax

Parameters

Constructor example

TagKeyIamBinding Resource Properties

Inputs

Outputs

Look up Existing TagKeyIamBinding Resource

Supporting Types

TagKeyIamBindingCondition, TagKeyIamBindingConditionArgs

Import

Package Details

On this page

On this page

full name of the custom role, e.g. `[projects/my-project|organizations/my-org]/roles/my-custom-role`.