SearchEngineIamMember class

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. Members added outside of Terraform for the same role will be detected as drift and removed on the next pulumi up.
  • 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. Members added outside of Terraform will not be detected as drift.

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)
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 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
	})
}
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
}
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.get("project"))
            .location(basic.get("location"))
            .collectionId(basic.get("collectionId"))
            .engineId(basic.get("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

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"])
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 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
	})
}
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"]
}
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.get("project"))
            .location(basic.get("location"))
            .collectionId(basic.get("collectionId"))
            .engineId(basic.get("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

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")
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 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
	})
}
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"
}
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.get("project"))
            .location(basic.get("location"))
            .collectionId(basic.get("collectionId"))
            .engineId(basic.get("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

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. Members added outside of Terraform for the same role will be detected as drift and removed on the next pulumi up.
  • 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. Members added outside of Terraform will not be detected as drift.

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)
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 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
	})
}
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
}
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.get("project"))
            .location(basic.get("location"))
            .collectionId(basic.get("collectionId"))
            .engineId(basic.get("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

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"])
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 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
	})
}
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"]
}
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.get("project"))
            .location(basic.get("location"))
            .collectionId(basic.get("collectionId"))
            .engineId(basic.get("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

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")
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 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
	})
}
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"
}
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.get("project"))
            .location(basic.get("location"))
            .collectionId(basic.get("collectionId"))
            .engineId(basic.get("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

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/searchEngineIamMember:SearchEngineIamMember 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.

Constructors

SearchEngineIamMember(String name, {SearchEngineIamMemberArgs? args, CustomResourceOptions? options})
Creates a new SearchEngineIamMember. name The Pulumi resource name. args Arguments used to configure this SearchEngineIamMember. The set of arguments for SearchEngineIamMember. options Resource options controlling this resource's behavior.
SearchEngineIamMember.reference(String urn)
Creates a typed reference to an existing SearchEngineIamMember resource.

Properties

childResources → Set<Resource>
finalinherited
collectionId ↔ Output<String>
The collection ID. Used to find the parent resource to bind the IAM policy to
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
condition ↔ Output<SearchEngineIamMemberCondition?>
latefinal
engineId ↔ Output<String>
Used to find the parent resource to bind the IAM policy to
latefinal
etag ↔ Output<String>
(Computed) The etag of the IAM policy.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
location ↔ Output<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.
latefinal
member ↔ Output<String>
Identities that will be granted the privilege in role. Each entry can have one of the following values:
latefinal
project ↔ Output<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.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
role ↔ Output<String>
The role that should be applied. Only one gcp.discoveryengine.SearchEngineIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {SearchEngineIamMemberState? state, CustomResourceOptions? options}) → SearchEngineIamMember
Gets an existing SearchEngineIamMember resource's state with the given name and id.