1. Packages
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. discoveryengine
  6. SearchEngineIamPolicy
Viewing docs for Google Cloud v9.30.0
published on Monday, Jul 13, 2026 by Pulumi
gcp logo
Viewing docs for Google Cloud v9.30.0
published on Monday, Jul 13, 2026 by Pulumi

    Three different resources help you manage your IAM policy for Discovery Engine SearchEngine. Each of these resources serves a different use case:

    • gcp.discoveryengine.SearchEngineIamPolicy: Authoritative. Sets the IAM policy for the searchengine and replaces any existing policy already attached.
    • gcp.discoveryengine.SearchEngineIamBinding: 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 searchengine are preserved.
    • gcp.discoveryengine.SearchEngineIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the searchengine are preserved.

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

    • gcp.discoveryengine.SearchEngineIamPolicy: Retrieves the IAM policy for the searchengine

    Note: gcp.discoveryengine.SearchEngineIamPolicy cannot be used in conjunction with gcp.discoveryengine.SearchEngineIamBinding and gcp.discoveryengine.SearchEngineIamMember or they will fight over what your policy should be.

    Note: gcp.discoveryengine.SearchEngineIamBinding resources can be used in conjunction with gcp.discoveryengine.SearchEngineIamMember resources only if they do not grant privilege to the same role.

    gcp.discoveryengine.SearchEngineIamPolicy

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const admin = gcp.organizations.getIAMPolicy({
        bindings: [{
            role: "roles/discoveryengine.agentspaceUser",
            members: ["user:jane@example.com"],
        }],
    });
    const policy = new gcp.discoveryengine.SearchEngineIamPolicy("policy", {
        project: basic.project,
        location: basic.location,
        collectionId: basic.collectionId,
        engineId: basic.engineId,
        policyData: admin.then(admin => admin.policyData),
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    admin = gcp.organizations.get_iam_policy(bindings=[{
        "role": "roles/discoveryengine.agentspaceUser",
        "members": ["user:jane@example.com"],
    }])
    policy = gcp.discoveryengine.SearchEngineIamPolicy("policy",
        project=basic["project"],
        location=basic["location"],
        collection_id=basic["collectionId"],
        engine_id=basic["engineId"],
        policy_data=admin.policy_data)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
    	"github.com/pulumi/pulumi-gcp/sdk/v9/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/discoveryengine.agentspaceUser",
    					Members: []string{
    						"user:jane@example.com",
    					},
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = discoveryengine.NewSearchEngineIamPolicy(ctx, "policy", &discoveryengine.SearchEngineIamPolicyArgs{
    			Project:      pulumi.Any(basic.Project),
    			Location:     pulumi.Any(basic.Location),
    			CollectionId: pulumi.Any(basic.CollectionId),
    			EngineId:     pulumi.Any(basic.EngineId),
    			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/discoveryengine.agentspaceUser",
                    Members = new[]
                    {
                        "user:jane@example.com",
                    },
                },
            },
        });
    
        var policy = new Gcp.DiscoveryEngine.SearchEngineIamPolicy("policy", new()
        {
            Project = basic.Project,
            Location = basic.Location,
            CollectionId = basic.CollectionId,
            EngineId = basic.EngineId,
            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.organizations.inputs.GetIAMPolicyBindingArgs;
    import com.pulumi.gcp.discoveryengine.SearchEngineIamPolicy;
    import com.pulumi.gcp.discoveryengine.SearchEngineIamPolicyArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
                .bindings(GetIAMPolicyBindingArgs.builder()
                    .role("roles/discoveryengine.agentspaceUser")
                    .members("user:jane@example.com")
                    .build())
                .build());
    
            var policy = new SearchEngineIamPolicy("policy", SearchEngineIamPolicyArgs.builder()
                .project(basic.project())
                .location(basic.location())
                .collectionId(basic.collectionId())
                .engineId(basic.engineId())
                .policyData(admin.policyData())
                .build());
    
        }
    }
    
    resources:
      policy:
        type: gcp:discoveryengine:SearchEngineIamPolicy
        properties:
          project: ${basic.project}
          location: ${basic.location}
          collectionId: ${basic.collectionId}
          engineId: ${basic.engineId}
          policyData: ${admin.policyData}
    variables:
      admin:
        fn::invoke:
          function: gcp:organizations:getIAMPolicy
          arguments:
            bindings:
              - role: roles/discoveryengine.agentspaceUser
                members:
                  - user:jane@example.com
    
    pulumi {
      required_providers {
        gcp = {
          source = "pulumi/gcp"
        }
      }
    }
    
    data "gcp_organizations_getiampolicy" "admin" {
      bindings {
        role    = "roles/discoveryengine.agentspaceUser"
        members = ["user:jane@example.com"]
      }
    }
    
    resource "gcp_discoveryengine_searchengineiampolicy" "policy" {
      project       = basic.project
      location      = basic.location
      collection_id = basic.collectionId
      engine_id     = basic.engineId
      policy_data   = data.gcp_organizations_getiampolicy.admin.policy_data
    }
    

    gcp.discoveryengine.SearchEngineIamBinding

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const binding = new gcp.discoveryengine.SearchEngineIamBinding("binding", {
        project: basic.project,
        location: basic.location,
        collectionId: basic.collectionId,
        engineId: basic.engineId,
        role: "roles/discoveryengine.agentspaceUser",
        members: ["user:jane@example.com"],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    binding = gcp.discoveryengine.SearchEngineIamBinding("binding",
        project=basic["project"],
        location=basic["location"],
        collection_id=basic["collectionId"],
        engine_id=basic["engineId"],
        role="roles/discoveryengine.agentspaceUser",
        members=["user:jane@example.com"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := discoveryengine.NewSearchEngineIamBinding(ctx, "binding", &discoveryengine.SearchEngineIamBindingArgs{
    			Project:      pulumi.Any(basic.Project),
    			Location:     pulumi.Any(basic.Location),
    			CollectionId: pulumi.Any(basic.CollectionId),
    			EngineId:     pulumi.Any(basic.EngineId),
    			Role:         pulumi.String("roles/discoveryengine.agentspaceUser"),
    			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.DiscoveryEngine.SearchEngineIamBinding("binding", new()
        {
            Project = basic.Project,
            Location = basic.Location,
            CollectionId = basic.CollectionId,
            EngineId = basic.EngineId,
            Role = "roles/discoveryengine.agentspaceUser",
            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.discoveryengine.SearchEngineIamBinding;
    import com.pulumi.gcp.discoveryengine.SearchEngineIamBindingArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var binding = new SearchEngineIamBinding("binding", SearchEngineIamBindingArgs.builder()
                .project(basic.project())
                .location(basic.location())
                .collectionId(basic.collectionId())
                .engineId(basic.engineId())
                .role("roles/discoveryengine.agentspaceUser")
                .members("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      binding:
        type: gcp:discoveryengine:SearchEngineIamBinding
        properties:
          project: ${basic.project}
          location: ${basic.location}
          collectionId: ${basic.collectionId}
          engineId: ${basic.engineId}
          role: roles/discoveryengine.agentspaceUser
          members:
            - user:jane@example.com
    
    pulumi {
      required_providers {
        gcp = {
          source = "pulumi/gcp"
        }
      }
    }
    
    resource "gcp_discoveryengine_searchengineiambinding" "binding" {
      project       = basic.project
      location      = basic.location
      collection_id = basic.collectionId
      engine_id     = basic.engineId
      role          = "roles/discoveryengine.agentspaceUser"
      members       = ["user:jane@example.com"]
    }
    

    gcp.discoveryengine.SearchEngineIamMember

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const member = new gcp.discoveryengine.SearchEngineIamMember("member", {
        project: basic.project,
        location: basic.location,
        collectionId: basic.collectionId,
        engineId: basic.engineId,
        role: "roles/discoveryengine.agentspaceUser",
        member: "user:jane@example.com",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    member = gcp.discoveryengine.SearchEngineIamMember("member",
        project=basic["project"],
        location=basic["location"],
        collection_id=basic["collectionId"],
        engine_id=basic["engineId"],
        role="roles/discoveryengine.agentspaceUser",
        member="user:jane@example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := discoveryengine.NewSearchEngineIamMember(ctx, "member", &discoveryengine.SearchEngineIamMemberArgs{
    			Project:      pulumi.Any(basic.Project),
    			Location:     pulumi.Any(basic.Location),
    			CollectionId: pulumi.Any(basic.CollectionId),
    			EngineId:     pulumi.Any(basic.EngineId),
    			Role:         pulumi.String("roles/discoveryengine.agentspaceUser"),
    			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.DiscoveryEngine.SearchEngineIamMember("member", new()
        {
            Project = basic.Project,
            Location = basic.Location,
            CollectionId = basic.CollectionId,
            EngineId = basic.EngineId,
            Role = "roles/discoveryengine.agentspaceUser",
            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.discoveryengine.SearchEngineIamMember;
    import com.pulumi.gcp.discoveryengine.SearchEngineIamMemberArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var member = new SearchEngineIamMember("member", SearchEngineIamMemberArgs.builder()
                .project(basic.project())
                .location(basic.location())
                .collectionId(basic.collectionId())
                .engineId(basic.engineId())
                .role("roles/discoveryengine.agentspaceUser")
                .member("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      member:
        type: gcp:discoveryengine:SearchEngineIamMember
        properties:
          project: ${basic.project}
          location: ${basic.location}
          collectionId: ${basic.collectionId}
          engineId: ${basic.engineId}
          role: roles/discoveryengine.agentspaceUser
          member: user:jane@example.com
    
    pulumi {
      required_providers {
        gcp = {
          source = "pulumi/gcp"
        }
      }
    }
    
    resource "gcp_discoveryengine_searchengineiammember" "member" {
      project       = basic.project
      location      = basic.location
      collection_id = basic.collectionId
      engine_id     = basic.engineId
      role          = "roles/discoveryengine.agentspaceUser"
      member        = "user:jane@example.com"
    }
    

    This resource supports User Project Overrides.

    IAM policy for Discovery Engine SearchEngine

    Three different resources help you manage your IAM policy for Discovery Engine SearchEngine. Each of these resources serves a different use case:

    • gcp.discoveryengine.SearchEngineIamPolicy: Authoritative. Sets the IAM policy for the searchengine and replaces any existing policy already attached.
    • gcp.discoveryengine.SearchEngineIamBinding: 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 searchengine are preserved.
    • gcp.discoveryengine.SearchEngineIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the searchengine are preserved.

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

    • gcp.discoveryengine.SearchEngineIamPolicy: Retrieves the IAM policy for the searchengine

    Note: gcp.discoveryengine.SearchEngineIamPolicy cannot be used in conjunction with gcp.discoveryengine.SearchEngineIamBinding and gcp.discoveryengine.SearchEngineIamMember or they will fight over what your policy should be.

    Note: gcp.discoveryengine.SearchEngineIamBinding resources can be used in conjunction with gcp.discoveryengine.SearchEngineIamMember resources only if they do not grant privilege to the same role.

    gcp.discoveryengine.SearchEngineIamPolicy

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const admin = gcp.organizations.getIAMPolicy({
        bindings: [{
            role: "roles/discoveryengine.agentspaceUser",
            members: ["user:jane@example.com"],
        }],
    });
    const policy = new gcp.discoveryengine.SearchEngineIamPolicy("policy", {
        project: basic.project,
        location: basic.location,
        collectionId: basic.collectionId,
        engineId: basic.engineId,
        policyData: admin.then(admin => admin.policyData),
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    admin = gcp.organizations.get_iam_policy(bindings=[{
        "role": "roles/discoveryengine.agentspaceUser",
        "members": ["user:jane@example.com"],
    }])
    policy = gcp.discoveryengine.SearchEngineIamPolicy("policy",
        project=basic["project"],
        location=basic["location"],
        collection_id=basic["collectionId"],
        engine_id=basic["engineId"],
        policy_data=admin.policy_data)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
    	"github.com/pulumi/pulumi-gcp/sdk/v9/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/discoveryengine.agentspaceUser",
    					Members: []string{
    						"user:jane@example.com",
    					},
    				},
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = discoveryengine.NewSearchEngineIamPolicy(ctx, "policy", &discoveryengine.SearchEngineIamPolicyArgs{
    			Project:      pulumi.Any(basic.Project),
    			Location:     pulumi.Any(basic.Location),
    			CollectionId: pulumi.Any(basic.CollectionId),
    			EngineId:     pulumi.Any(basic.EngineId),
    			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/discoveryengine.agentspaceUser",
                    Members = new[]
                    {
                        "user:jane@example.com",
                    },
                },
            },
        });
    
        var policy = new Gcp.DiscoveryEngine.SearchEngineIamPolicy("policy", new()
        {
            Project = basic.Project,
            Location = basic.Location,
            CollectionId = basic.CollectionId,
            EngineId = basic.EngineId,
            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.organizations.inputs.GetIAMPolicyBindingArgs;
    import com.pulumi.gcp.discoveryengine.SearchEngineIamPolicy;
    import com.pulumi.gcp.discoveryengine.SearchEngineIamPolicyArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var admin = OrganizationsFunctions.getIAMPolicy(GetIAMPolicyArgs.builder()
                .bindings(GetIAMPolicyBindingArgs.builder()
                    .role("roles/discoveryengine.agentspaceUser")
                    .members("user:jane@example.com")
                    .build())
                .build());
    
            var policy = new SearchEngineIamPolicy("policy", SearchEngineIamPolicyArgs.builder()
                .project(basic.project())
                .location(basic.location())
                .collectionId(basic.collectionId())
                .engineId(basic.engineId())
                .policyData(admin.policyData())
                .build());
    
        }
    }
    
    resources:
      policy:
        type: gcp:discoveryengine:SearchEngineIamPolicy
        properties:
          project: ${basic.project}
          location: ${basic.location}
          collectionId: ${basic.collectionId}
          engineId: ${basic.engineId}
          policyData: ${admin.policyData}
    variables:
      admin:
        fn::invoke:
          function: gcp:organizations:getIAMPolicy
          arguments:
            bindings:
              - role: roles/discoveryengine.agentspaceUser
                members:
                  - user:jane@example.com
    
    pulumi {
      required_providers {
        gcp = {
          source = "pulumi/gcp"
        }
      }
    }
    
    data "gcp_organizations_getiampolicy" "admin" {
      bindings {
        role    = "roles/discoveryengine.agentspaceUser"
        members = ["user:jane@example.com"]
      }
    }
    
    resource "gcp_discoveryengine_searchengineiampolicy" "policy" {
      project       = basic.project
      location      = basic.location
      collection_id = basic.collectionId
      engine_id     = basic.engineId
      policy_data   = data.gcp_organizations_getiampolicy.admin.policy_data
    }
    

    gcp.discoveryengine.SearchEngineIamBinding

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const binding = new gcp.discoveryengine.SearchEngineIamBinding("binding", {
        project: basic.project,
        location: basic.location,
        collectionId: basic.collectionId,
        engineId: basic.engineId,
        role: "roles/discoveryengine.agentspaceUser",
        members: ["user:jane@example.com"],
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    binding = gcp.discoveryengine.SearchEngineIamBinding("binding",
        project=basic["project"],
        location=basic["location"],
        collection_id=basic["collectionId"],
        engine_id=basic["engineId"],
        role="roles/discoveryengine.agentspaceUser",
        members=["user:jane@example.com"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := discoveryengine.NewSearchEngineIamBinding(ctx, "binding", &discoveryengine.SearchEngineIamBindingArgs{
    			Project:      pulumi.Any(basic.Project),
    			Location:     pulumi.Any(basic.Location),
    			CollectionId: pulumi.Any(basic.CollectionId),
    			EngineId:     pulumi.Any(basic.EngineId),
    			Role:         pulumi.String("roles/discoveryengine.agentspaceUser"),
    			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.DiscoveryEngine.SearchEngineIamBinding("binding", new()
        {
            Project = basic.Project,
            Location = basic.Location,
            CollectionId = basic.CollectionId,
            EngineId = basic.EngineId,
            Role = "roles/discoveryengine.agentspaceUser",
            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.discoveryengine.SearchEngineIamBinding;
    import com.pulumi.gcp.discoveryengine.SearchEngineIamBindingArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var binding = new SearchEngineIamBinding("binding", SearchEngineIamBindingArgs.builder()
                .project(basic.project())
                .location(basic.location())
                .collectionId(basic.collectionId())
                .engineId(basic.engineId())
                .role("roles/discoveryengine.agentspaceUser")
                .members("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      binding:
        type: gcp:discoveryengine:SearchEngineIamBinding
        properties:
          project: ${basic.project}
          location: ${basic.location}
          collectionId: ${basic.collectionId}
          engineId: ${basic.engineId}
          role: roles/discoveryengine.agentspaceUser
          members:
            - user:jane@example.com
    
    pulumi {
      required_providers {
        gcp = {
          source = "pulumi/gcp"
        }
      }
    }
    
    resource "gcp_discoveryengine_searchengineiambinding" "binding" {
      project       = basic.project
      location      = basic.location
      collection_id = basic.collectionId
      engine_id     = basic.engineId
      role          = "roles/discoveryengine.agentspaceUser"
      members       = ["user:jane@example.com"]
    }
    

    gcp.discoveryengine.SearchEngineIamMember

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const member = new gcp.discoveryengine.SearchEngineIamMember("member", {
        project: basic.project,
        location: basic.location,
        collectionId: basic.collectionId,
        engineId: basic.engineId,
        role: "roles/discoveryengine.agentspaceUser",
        member: "user:jane@example.com",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    member = gcp.discoveryengine.SearchEngineIamMember("member",
        project=basic["project"],
        location=basic["location"],
        collection_id=basic["collectionId"],
        engine_id=basic["engineId"],
        role="roles/discoveryengine.agentspaceUser",
        member="user:jane@example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/discoveryengine"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := discoveryengine.NewSearchEngineIamMember(ctx, "member", &discoveryengine.SearchEngineIamMemberArgs{
    			Project:      pulumi.Any(basic.Project),
    			Location:     pulumi.Any(basic.Location),
    			CollectionId: pulumi.Any(basic.CollectionId),
    			EngineId:     pulumi.Any(basic.EngineId),
    			Role:         pulumi.String("roles/discoveryengine.agentspaceUser"),
    			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.DiscoveryEngine.SearchEngineIamMember("member", new()
        {
            Project = basic.Project,
            Location = basic.Location,
            CollectionId = basic.CollectionId,
            EngineId = basic.EngineId,
            Role = "roles/discoveryengine.agentspaceUser",
            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.discoveryengine.SearchEngineIamMember;
    import com.pulumi.gcp.discoveryengine.SearchEngineIamMemberArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var member = new SearchEngineIamMember("member", SearchEngineIamMemberArgs.builder()
                .project(basic.project())
                .location(basic.location())
                .collectionId(basic.collectionId())
                .engineId(basic.engineId())
                .role("roles/discoveryengine.agentspaceUser")
                .member("user:jane@example.com")
                .build());
    
        }
    }
    
    resources:
      member:
        type: gcp:discoveryengine:SearchEngineIamMember
        properties:
          project: ${basic.project}
          location: ${basic.location}
          collectionId: ${basic.collectionId}
          engineId: ${basic.engineId}
          role: roles/discoveryengine.agentspaceUser
          member: user:jane@example.com
    
    pulumi {
      required_providers {
        gcp = {
          source = "pulumi/gcp"
        }
      }
    }
    
    resource "gcp_discoveryengine_searchengineiammember" "member" {
      project       = basic.project
      location      = basic.location
      collection_id = basic.collectionId
      engine_id     = basic.engineId
      role          = "roles/discoveryengine.agentspaceUser"
      member        = "user:jane@example.com"
    }
    

    Create SearchEngineIamPolicy Resource

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

    Constructor syntax

    new SearchEngineIamPolicy(name: string, args: SearchEngineIamPolicyArgs, opts?: CustomResourceOptions);
    @overload
    def SearchEngineIamPolicy(resource_name: str,
                              args: SearchEngineIamPolicyArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def SearchEngineIamPolicy(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              collection_id: Optional[str] = None,
                              engine_id: Optional[str] = None,
                              policy_data: Optional[str] = None,
                              location: Optional[str] = None,
                              project: Optional[str] = None)
    func NewSearchEngineIamPolicy(ctx *Context, name string, args SearchEngineIamPolicyArgs, opts ...ResourceOption) (*SearchEngineIamPolicy, error)
    public SearchEngineIamPolicy(string name, SearchEngineIamPolicyArgs args, CustomResourceOptions? opts = null)
    public SearchEngineIamPolicy(String name, SearchEngineIamPolicyArgs args)
    public SearchEngineIamPolicy(String name, SearchEngineIamPolicyArgs args, CustomResourceOptions options)
    
    type: gcp:discoveryengine:SearchEngineIamPolicy
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "gcp_discoveryengine_searchengineiampolicy" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args SearchEngineIamPolicyArgs
    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 SearchEngineIamPolicyArgs
    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 SearchEngineIamPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SearchEngineIamPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SearchEngineIamPolicyArgs
    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 searchEngineIamPolicyResource = new Gcp.DiscoveryEngine.SearchEngineIamPolicy("searchEngineIamPolicyResource", new()
    {
        CollectionId = "string",
        EngineId = "string",
        PolicyData = "string",
        Location = "string",
        Project = "string",
    });
    
    example, err := discoveryengine.NewSearchEngineIamPolicy(ctx, "searchEngineIamPolicyResource", &discoveryengine.SearchEngineIamPolicyArgs{
    	CollectionId: pulumi.String("string"),
    	EngineId:     pulumi.String("string"),
    	PolicyData:   pulumi.String("string"),
    	Location:     pulumi.String("string"),
    	Project:      pulumi.String("string"),
    })
    
    resource "gcp_discoveryengine_searchengineiampolicy" "searchEngineIamPolicyResource" {
      collection_id = "string"
      engine_id     = "string"
      policy_data   = "string"
      location      = "string"
      project       = "string"
    }
    
    var searchEngineIamPolicyResource = new SearchEngineIamPolicy("searchEngineIamPolicyResource", SearchEngineIamPolicyArgs.builder()
        .collectionId("string")
        .engineId("string")
        .policyData("string")
        .location("string")
        .project("string")
        .build());
    
    search_engine_iam_policy_resource = gcp.discoveryengine.SearchEngineIamPolicy("searchEngineIamPolicyResource",
        collection_id="string",
        engine_id="string",
        policy_data="string",
        location="string",
        project="string")
    
    const searchEngineIamPolicyResource = new gcp.discoveryengine.SearchEngineIamPolicy("searchEngineIamPolicyResource", {
        collectionId: "string",
        engineId: "string",
        policyData: "string",
        location: "string",
        project: "string",
    });
    
    type: gcp:discoveryengine:SearchEngineIamPolicy
    properties:
        collectionId: string
        engineId: string
        location: string
        policyData: string
        project: string
    

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

    CollectionId string
    The collection ID. Used to find the parent resource to bind the IAM policy to
    EngineId string
    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.
    Location string
    Location. 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.
    CollectionId string
    The collection ID. Used to find the parent resource to bind the IAM policy to
    EngineId string
    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.
    Location string
    Location. 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.
    collection_id string
    The collection ID. Used to find the parent resource to bind the IAM policy to
    engine_id string
    Used to find the parent resource to bind the IAM policy to
    policy_data string
    The policy data generated by a gcp.organizations.getIAMPolicy data source.
    location string
    Location. 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.
    collectionId String
    The collection ID. Used to find the parent resource to bind the IAM policy to
    engineId String
    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.
    location String
    Location. 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.
    collectionId string
    The collection ID. Used to find the parent resource to bind the IAM policy to
    engineId string
    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.
    location string
    Location. 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.
    collection_id str
    The collection ID. Used to find the parent resource to bind the IAM policy to
    engine_id str
    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.
    location str
    Location. 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.
    collectionId String
    The collection ID. Used to find the parent resource to bind the IAM policy to
    engineId String
    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.
    location String
    Location. 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 SearchEngineIamPolicy 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 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 SearchEngineIamPolicy Resource

    Get an existing SearchEngineIamPolicy 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?: SearchEngineIamPolicyState, opts?: CustomResourceOptions): SearchEngineIamPolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            collection_id: Optional[str] = None,
            engine_id: Optional[str] = None,
            etag: Optional[str] = None,
            location: Optional[str] = None,
            policy_data: Optional[str] = None,
            project: Optional[str] = None) -> SearchEngineIamPolicy
    func GetSearchEngineIamPolicy(ctx *Context, name string, id IDInput, state *SearchEngineIamPolicyState, opts ...ResourceOption) (*SearchEngineIamPolicy, error)
    public static SearchEngineIamPolicy Get(string name, Input<string> id, SearchEngineIamPolicyState? state, CustomResourceOptions? opts = null)
    public static SearchEngineIamPolicy get(String name, Output<String> id, SearchEngineIamPolicyState state, CustomResourceOptions options)
    resources:  _:    type: gcp:discoveryengine:SearchEngineIamPolicy    get:      id: ${id}
    import {
      to = gcp_discoveryengine_searchengineiampolicy.example
      id = "${id}"
    }
    
    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:
    CollectionId string
    The collection ID. Used to find the parent resource to bind the IAM policy to
    EngineId string
    Used to find the parent resource to bind the IAM policy to
    Etag string
    (Computed) The etag of the IAM policy.
    Location string
    Location. 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.
    CollectionId string
    The collection ID. Used to find the parent resource to bind the IAM policy to
    EngineId string
    Used to find the parent resource to bind the IAM policy to
    Etag string
    (Computed) The etag of the IAM policy.
    Location string
    Location. 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.
    collection_id string
    The collection ID. Used to find the parent resource to bind the IAM policy to
    engine_id string
    Used to find the parent resource to bind the IAM policy to
    etag string
    (Computed) The etag of the IAM policy.
    location string
    Location. 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 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.
    collectionId String
    The collection ID. Used to find the parent resource to bind the IAM policy to
    engineId String
    Used to find the parent resource to bind the IAM policy to
    etag String
    (Computed) The etag of the IAM policy.
    location String
    Location. 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.
    collectionId string
    The collection ID. Used to find the parent resource to bind the IAM policy to
    engineId string
    Used to find the parent resource to bind the IAM policy to
    etag string
    (Computed) The etag of the IAM policy.
    location string
    Location. 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.
    collection_id str
    The collection ID. Used to find the parent resource to bind the IAM policy to
    engine_id str
    Used to find the parent resource to bind the IAM policy to
    etag str
    (Computed) The etag of the IAM policy.
    location str
    Location. 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.
    collectionId String
    The collection ID. Used to find the parent resource to bind the IAM policy to
    engineId String
    Used to find the parent resource to bind the IAM policy to
    etag String
    (Computed) The etag of the IAM policy.
    location String
    Location. 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.

    Import

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

    • projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}}
    • {{project}}/{{location}}/{{collection_id}}/{{engine_id}}
    • {{location}}/{{collection_id}}/{{engine_id}}
    • {{engine_id}}

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

    Discovery Engine searchengine 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.

    $ terraform import google_discovery_engine_search_engine_iam_member.editor "projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}} roles/discoveryengine.agentspaceUser user:jane@example.com"
    

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

    $ terraform import google_discovery_engine_search_engine_iam_binding.editor "projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_id}} roles/discoveryengine.agentspaceUser"
    

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

    $ pulumi import gcp:discoveryengine/searchEngineIamPolicy:SearchEngineIamPolicy editor projects/{{project}}/locations/{{location}}/collections/{{collection_id}}/engines/{{engine_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
    Viewing docs for Google Cloud v9.30.0
    published on Monday, Jul 13, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial