1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. dataplex
  5. TaskIamPolicy
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi

gcp.dataplex.TaskIamPolicy

Explore with Pulumi AI

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

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

    • gcp.dataplex.TaskIamPolicy: Authoritative. Sets the IAM policy for the task and replaces any existing policy already attached.
    • gcp.dataplex.TaskIamBinding: 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 task are preserved.
    • gcp.dataplex.TaskIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the task are preserved.

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

    • gcp.dataplex.TaskIamPolicy: Retrieves the IAM policy for the task

    Note: gcp.dataplex.TaskIamPolicy cannot be used in conjunction with gcp.dataplex.TaskIamBinding and gcp.dataplex.TaskIamMember or they will fight over what your policy should be.

    Note: gcp.dataplex.TaskIamBinding resources can be used in conjunction with gcp.dataplex.TaskIamMember resources only if they do not grant privilege to the same role.

    gcp.dataplex.TaskIamPolicy

    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.dataplex.TaskIamPolicy("policy", {
        project: example.project,
        location: example.location,
        lake: example.lake,
        taskId: example.taskId,
        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.dataplex.TaskIamPolicy("policy",
        project=example["project"],
        location=example["location"],
        lake=example["lake"],
        task_id=example["taskId"],
        policy_data=admin.policy_data)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/dataplex"
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
    	"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 = dataplex.NewTaskIamPolicy(ctx, "policy", &dataplex.TaskIamPolicyArgs{
    			Project:    pulumi.Any(example.Project),
    			Location:   pulumi.Any(example.Location),
    			Lake:       pulumi.Any(example.Lake),
    			TaskId:     pulumi.Any(example.TaskId),
    			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.DataPlex.TaskIamPolicy("policy", new()
        {
            Project = example.Project,
            Location = example.Location,
            Lake = example.Lake,
            TaskId = example.TaskId,
            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.dataplex.TaskIamPolicy;
    import com.pulumi.gcp.dataplex.TaskIamPolicyArgs;
    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 TaskIamPolicy("policy", TaskIamPolicyArgs.builder()
                .project(example.project())
                .location(example.location())
                .lake(example.lake())
                .taskId(example.taskId())
                .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
                .build());
    
        }
    }
    
    resources:
      policy:
        type: gcp:dataplex:TaskIamPolicy
        properties:
          project: ${example.project}
          location: ${example.location}
          lake: ${example.lake}
          taskId: ${example.taskId}
          policyData: ${admin.policyData}
    variables:
      admin:
        fn::invoke:
          Function: gcp:organizations:getIAMPolicy
          Arguments:
            bindings:
              - role: roles/viewer
                members:
                  - user:jane@example.com
    

    gcp.dataplex.TaskIamBinding

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const binding = new gcp.dataplex.TaskIamBinding("binding", {
        project: example.project,
        location: example.location,
        lake: example.lake,
        taskId: example.taskId,
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    binding = gcp.dataplex.TaskIamBinding("binding",
        project=example["project"],
        location=example["location"],
        lake=example["lake"],
        task_id=example["taskId"],
        role="roles/viewer",
        members=["user:jane@example.com"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/dataplex"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dataplex.NewTaskIamBinding(ctx, "binding", &dataplex.TaskIamBindingArgs{
    			Project:  pulumi.Any(example.Project),
    			Location: pulumi.Any(example.Location),
    			Lake:     pulumi.Any(example.Lake),
    			TaskId:   pulumi.Any(example.TaskId),
    			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.DataPlex.TaskIamBinding("binding", new()
        {
            Project = example.Project,
            Location = example.Location,
            Lake = example.Lake,
            TaskId = example.TaskId,
            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.dataplex.TaskIamBinding;
    import com.pulumi.gcp.dataplex.TaskIamBindingArgs;
    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 TaskIamBinding("binding", TaskIamBindingArgs.builder()
                .project(example.project())
                .location(example.location())
                .lake(example.lake())
                .taskId(example.taskId())
                .role("roles/viewer")
                .members("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      binding:
        type: gcp:dataplex:TaskIamBinding
        properties:
          project: ${example.project}
          location: ${example.location}
          lake: ${example.lake}
          taskId: ${example.taskId}
          role: roles/viewer
          members:
            - user:jane@example.com
    

    gcp.dataplex.TaskIamMember

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const member = new gcp.dataplex.TaskIamMember("member", {
        project: example.project,
        location: example.location,
        lake: example.lake,
        taskId: example.taskId,
        role: "roles/viewer",
        member: "user:jane@example.com",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    member = gcp.dataplex.TaskIamMember("member",
        project=example["project"],
        location=example["location"],
        lake=example["lake"],
        task_id=example["taskId"],
        role="roles/viewer",
        member="user:jane@example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/dataplex"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dataplex.NewTaskIamMember(ctx, "member", &dataplex.TaskIamMemberArgs{
    			Project:  pulumi.Any(example.Project),
    			Location: pulumi.Any(example.Location),
    			Lake:     pulumi.Any(example.Lake),
    			TaskId:   pulumi.Any(example.TaskId),
    			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.DataPlex.TaskIamMember("member", new()
        {
            Project = example.Project,
            Location = example.Location,
            Lake = example.Lake,
            TaskId = example.TaskId,
            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.dataplex.TaskIamMember;
    import com.pulumi.gcp.dataplex.TaskIamMemberArgs;
    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 TaskIamMember("member", TaskIamMemberArgs.builder()
                .project(example.project())
                .location(example.location())
                .lake(example.lake())
                .taskId(example.taskId())
                .role("roles/viewer")
                .member("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      member:
        type: gcp:dataplex:TaskIamMember
        properties:
          project: ${example.project}
          location: ${example.location}
          lake: ${example.lake}
          taskId: ${example.taskId}
          role: roles/viewer
          member: user:jane@example.com
    

    This resource supports User Project Overrides.

    IAM policy for Dataplex Task

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

    • gcp.dataplex.TaskIamPolicy: Authoritative. Sets the IAM policy for the task and replaces any existing policy already attached.
    • gcp.dataplex.TaskIamBinding: 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 task are preserved.
    • gcp.dataplex.TaskIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the task are preserved.

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

    • gcp.dataplex.TaskIamPolicy: Retrieves the IAM policy for the task

    Note: gcp.dataplex.TaskIamPolicy cannot be used in conjunction with gcp.dataplex.TaskIamBinding and gcp.dataplex.TaskIamMember or they will fight over what your policy should be.

    Note: gcp.dataplex.TaskIamBinding resources can be used in conjunction with gcp.dataplex.TaskIamMember resources only if they do not grant privilege to the same role.

    gcp.dataplex.TaskIamPolicy

    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.dataplex.TaskIamPolicy("policy", {
        project: example.project,
        location: example.location,
        lake: example.lake,
        taskId: example.taskId,
        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.dataplex.TaskIamPolicy("policy",
        project=example["project"],
        location=example["location"],
        lake=example["lake"],
        task_id=example["taskId"],
        policy_data=admin.policy_data)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/dataplex"
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
    	"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 = dataplex.NewTaskIamPolicy(ctx, "policy", &dataplex.TaskIamPolicyArgs{
    			Project:    pulumi.Any(example.Project),
    			Location:   pulumi.Any(example.Location),
    			Lake:       pulumi.Any(example.Lake),
    			TaskId:     pulumi.Any(example.TaskId),
    			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.DataPlex.TaskIamPolicy("policy", new()
        {
            Project = example.Project,
            Location = example.Location,
            Lake = example.Lake,
            TaskId = example.TaskId,
            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.dataplex.TaskIamPolicy;
    import com.pulumi.gcp.dataplex.TaskIamPolicyArgs;
    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 TaskIamPolicy("policy", TaskIamPolicyArgs.builder()
                .project(example.project())
                .location(example.location())
                .lake(example.lake())
                .taskId(example.taskId())
                .policyData(admin.applyValue(getIAMPolicyResult -> getIAMPolicyResult.policyData()))
                .build());
    
        }
    }
    
    resources:
      policy:
        type: gcp:dataplex:TaskIamPolicy
        properties:
          project: ${example.project}
          location: ${example.location}
          lake: ${example.lake}
          taskId: ${example.taskId}
          policyData: ${admin.policyData}
    variables:
      admin:
        fn::invoke:
          Function: gcp:organizations:getIAMPolicy
          Arguments:
            bindings:
              - role: roles/viewer
                members:
                  - user:jane@example.com
    

    gcp.dataplex.TaskIamBinding

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const binding = new gcp.dataplex.TaskIamBinding("binding", {
        project: example.project,
        location: example.location,
        lake: example.lake,
        taskId: example.taskId,
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    binding = gcp.dataplex.TaskIamBinding("binding",
        project=example["project"],
        location=example["location"],
        lake=example["lake"],
        task_id=example["taskId"],
        role="roles/viewer",
        members=["user:jane@example.com"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/dataplex"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dataplex.NewTaskIamBinding(ctx, "binding", &dataplex.TaskIamBindingArgs{
    			Project:  pulumi.Any(example.Project),
    			Location: pulumi.Any(example.Location),
    			Lake:     pulumi.Any(example.Lake),
    			TaskId:   pulumi.Any(example.TaskId),
    			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.DataPlex.TaskIamBinding("binding", new()
        {
            Project = example.Project,
            Location = example.Location,
            Lake = example.Lake,
            TaskId = example.TaskId,
            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.dataplex.TaskIamBinding;
    import com.pulumi.gcp.dataplex.TaskIamBindingArgs;
    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 TaskIamBinding("binding", TaskIamBindingArgs.builder()
                .project(example.project())
                .location(example.location())
                .lake(example.lake())
                .taskId(example.taskId())
                .role("roles/viewer")
                .members("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      binding:
        type: gcp:dataplex:TaskIamBinding
        properties:
          project: ${example.project}
          location: ${example.location}
          lake: ${example.lake}
          taskId: ${example.taskId}
          role: roles/viewer
          members:
            - user:jane@example.com
    

    gcp.dataplex.TaskIamMember

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const member = new gcp.dataplex.TaskIamMember("member", {
        project: example.project,
        location: example.location,
        lake: example.lake,
        taskId: example.taskId,
        role: "roles/viewer",
        member: "user:jane@example.com",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    member = gcp.dataplex.TaskIamMember("member",
        project=example["project"],
        location=example["location"],
        lake=example["lake"],
        task_id=example["taskId"],
        role="roles/viewer",
        member="user:jane@example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/dataplex"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := dataplex.NewTaskIamMember(ctx, "member", &dataplex.TaskIamMemberArgs{
    			Project:  pulumi.Any(example.Project),
    			Location: pulumi.Any(example.Location),
    			Lake:     pulumi.Any(example.Lake),
    			TaskId:   pulumi.Any(example.TaskId),
    			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.DataPlex.TaskIamMember("member", new()
        {
            Project = example.Project,
            Location = example.Location,
            Lake = example.Lake,
            TaskId = example.TaskId,
            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.dataplex.TaskIamMember;
    import com.pulumi.gcp.dataplex.TaskIamMemberArgs;
    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 TaskIamMember("member", TaskIamMemberArgs.builder()
                .project(example.project())
                .location(example.location())
                .lake(example.lake())
                .taskId(example.taskId())
                .role("roles/viewer")
                .member("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      member:
        type: gcp:dataplex:TaskIamMember
        properties:
          project: ${example.project}
          location: ${example.location}
          lake: ${example.lake}
          taskId: ${example.taskId}
          role: roles/viewer
          member: user:jane@example.com
    

    Create TaskIamPolicy Resource

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

    Constructor syntax

    new TaskIamPolicy(name: string, args: TaskIamPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def TaskIamPolicy(resource_name: str,
                      args: TaskIamPolicyArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def TaskIamPolicy(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      lake: Optional[str] = None,
                      policy_data: Optional[str] = None,
                      task_id: Optional[str] = None,
                      location: Optional[str] = None,
                      project: Optional[str] = None)
    func NewTaskIamPolicy(ctx *Context, name string, args TaskIamPolicyArgs, opts ...ResourceOption) (*TaskIamPolicy, error)
    public TaskIamPolicy(string name, TaskIamPolicyArgs args, CustomResourceOptions? opts = null)
    public TaskIamPolicy(String name, TaskIamPolicyArgs args)
    public TaskIamPolicy(String name, TaskIamPolicyArgs args, CustomResourceOptions options)
    
    type: gcp:dataplex:TaskIamPolicy
    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 TaskIamPolicyArgs
    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 TaskIamPolicyArgs
    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 TaskIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TaskIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TaskIamPolicyArgs
    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 taskIamPolicyResource = new Gcp.DataPlex.TaskIamPolicy("taskIamPolicyResource", new()
    {
        Lake = "string",
        PolicyData = "string",
        TaskId = "string",
        Location = "string",
        Project = "string",
    });
    
    example, err := dataplex.NewTaskIamPolicy(ctx, "taskIamPolicyResource", &dataplex.TaskIamPolicyArgs{
    	Lake:       pulumi.String("string"),
    	PolicyData: pulumi.String("string"),
    	TaskId:     pulumi.String("string"),
    	Location:   pulumi.String("string"),
    	Project:    pulumi.String("string"),
    })
    
    var taskIamPolicyResource = new TaskIamPolicy("taskIamPolicyResource", TaskIamPolicyArgs.builder()
        .lake("string")
        .policyData("string")
        .taskId("string")
        .location("string")
        .project("string")
        .build());
    
    task_iam_policy_resource = gcp.dataplex.TaskIamPolicy("taskIamPolicyResource",
        lake="string",
        policy_data="string",
        task_id="string",
        location="string",
        project="string")
    
    const taskIamPolicyResource = new gcp.dataplex.TaskIamPolicy("taskIamPolicyResource", {
        lake: "string",
        policyData: "string",
        taskId: "string",
        location: "string",
        project: "string",
    });
    
    type: gcp:dataplex:TaskIamPolicy
    properties:
        lake: string
        location: string
        policyData: string
        project: string
        taskId: string
    

    TaskIamPolicy 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 TaskIamPolicy resource accepts the following input properties:

    Lake string
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    TaskId string
    Location string
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    Lake string
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    TaskId string
    Location string
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    lake String
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    taskId String
    location String
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    lake string
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    taskId string
    location string
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    lake str
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    task_id str
    location str
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    project 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.
    lake String
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    taskId String
    location String
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TaskIamPolicy 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 TaskIamPolicy Resource

    Get an existing TaskIamPolicy 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?: TaskIamPolicyState, opts?: CustomResourceOptions): TaskIamPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            etag: Optional[str] = None,
            lake: Optional[str] = None,
            location: Optional[str] = None,
            policy_data: Optional[str] = None,
            project: Optional[str] = None,
            task_id: Optional[str] = None) -> TaskIamPolicy
    func GetTaskIamPolicy(ctx *Context, name string, id IDInput, state *TaskIamPolicyState, opts ...ResourceOption) (*TaskIamPolicy, error)
    public static TaskIamPolicy Get(string name, Input<string> id, TaskIamPolicyState? state, CustomResourceOptions? opts = null)
    public static TaskIamPolicy get(String name, Output<String> id, TaskIamPolicyState 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:
    Etag string
    (Computed) The etag of the IAM policy.
    Lake string
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    Location string
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    TaskId string
    Etag string
    (Computed) The etag of the IAM policy.
    Lake string
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    Location string
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    PolicyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    TaskId string
    etag String
    (Computed) The etag of the IAM policy.
    lake String
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    location String
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    taskId String
    etag string
    (Computed) The etag of the IAM policy.
    lake string
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    location string
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    policyData string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    taskId string
    etag str
    (Computed) The etag of the IAM policy.
    lake str
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    location str
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    policy_data str
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project 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.
    task_id str
    etag String
    (Computed) The etag of the IAM policy.
    lake String
    The lake in which the task will be created in. Used to find the parent resource to bind the IAM policy to
    location String
    The location in which the task will be created in. Used to find the parent resource to bind the IAM policy to. If not specified, the value will be parsed from the identifier of the parent resource. If no location is provided in the parent identifier and no location is specified, it is taken from the provider configuration.
    policyData String
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the project will be parsed from the identifier of the parent resource. If no project is provided in the parent identifier and no project is specified, the provider project is used.
    taskId String

    Import

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

    • projects/{{project}}/locations/{{location}}/lakes/{{lake}}/tasks/{{task_id}}

    • {{project}}/{{location}}/{{lake}}/{{task_id}}

    • {{location}}/{{lake}}/{{task_id}}

    • {{task_id}}

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

    Dataplex task 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:dataplex/taskIamPolicy:TaskIamPolicy editor "projects/{{project}}/locations/{{location}}/lakes/{{lake}}/tasks/{{task_id}} 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:dataplex/taskIamPolicy:TaskIamPolicy editor "projects/{{project}}/locations/{{location}}/lakes/{{lake}}/tasks/{{task_id}} roles/viewer"
    

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

    $ pulumi import gcp:dataplex/taskIamPolicy:TaskIamPolicy editor projects/{{project}}/locations/{{location}}/lakes/{{lake}}/tasks/{{task_id}}
    

    -> 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.
    gcp logo
    Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi