1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. discoveryengine
  5. UserStore
Google Cloud v9.6.0 published on Wednesday, Nov 26, 2025 by Pulumi
gcp logo
Google Cloud v9.6.0 published on Wednesday, Nov 26, 2025 by Pulumi

    Represents a user store.

    To get more information about UserStore, see:

    Example Usage

    Discoveryengine Userstore Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const basic = new gcp.discoveryengine.LicenseConfig("basic", {
        location: "us",
        licenseConfigId: "license-config-id",
        licenseCount: 50,
        subscriptionTier: "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT",
        startDate: {
            year: 2099,
            month: 1,
            day: 1,
        },
        endDate: {
            year: 2100,
            month: 1,
            day: 1,
        },
        subscriptionTerm: "SUBSCRIPTION_TERM_ONE_YEAR",
    });
    const project = gcp.organizations.getProject({});
    const basicUserStore = new gcp.discoveryengine.UserStore("basic", {
        location: basic.location,
        defaultLicenseConfig: pulumi.all([project, basic.location, basic.licenseConfigId]).apply(([project, location, licenseConfigId]) => `projects/${project.number}/locations/${location}/licenseConfigs/${licenseConfigId}`),
        enableLicenseAutoRegister: true,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    basic = gcp.discoveryengine.LicenseConfig("basic",
        location="us",
        license_config_id="license-config-id",
        license_count=50,
        subscription_tier="SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT",
        start_date={
            "year": 2099,
            "month": 1,
            "day": 1,
        },
        end_date={
            "year": 2100,
            "month": 1,
            "day": 1,
        },
        subscription_term="SUBSCRIPTION_TERM_ONE_YEAR")
    project = gcp.organizations.get_project()
    basic_user_store = gcp.discoveryengine.UserStore("basic",
        location=basic.location,
        default_license_config=pulumi.Output.all(
            location=basic.location,
            license_config_id=basic.license_config_id
    ).apply(lambda resolved_outputs: f"projects/{project.number}/locations/{resolved_outputs['location']}/licenseConfigs/{resolved_outputs['license_config_id']}")
    ,
        enable_license_auto_register=True)
    
    package main
    
    import (
    	"fmt"
    
    	"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 {
    		basic, err := discoveryengine.NewLicenseConfig(ctx, "basic", &discoveryengine.LicenseConfigArgs{
    			Location:         pulumi.String("us"),
    			LicenseConfigId:  pulumi.String("license-config-id"),
    			LicenseCount:     pulumi.Int(50),
    			SubscriptionTier: pulumi.String("SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT"),
    			StartDate: &discoveryengine.LicenseConfigStartDateArgs{
    				Year:  pulumi.Int(2099),
    				Month: pulumi.Int(1),
    				Day:   pulumi.Int(1),
    			},
    			EndDate: &discoveryengine.LicenseConfigEndDateArgs{
    				Year:  pulumi.Int(2100),
    				Month: pulumi.Int(1),
    				Day:   pulumi.Int(1),
    			},
    			SubscriptionTerm: pulumi.String("SUBSCRIPTION_TERM_ONE_YEAR"),
    		})
    		if err != nil {
    			return err
    		}
    		project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = discoveryengine.NewUserStore(ctx, "basic", &discoveryengine.UserStoreArgs{
    			Location: basic.Location,
    			DefaultLicenseConfig: pulumi.All(basic.Location, basic.LicenseConfigId).ApplyT(func(_args []interface{}) (string, error) {
    				location := _args[0].(string)
    				licenseConfigId := _args[1].(string)
    				return fmt.Sprintf("projects/%v/locations/%v/licenseConfigs/%v", project.Number, location, licenseConfigId), nil
    			}).(pulumi.StringOutput),
    			EnableLicenseAutoRegister: pulumi.Bool(true),
    		})
    		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 basic = new Gcp.DiscoveryEngine.LicenseConfig("basic", new()
        {
            Location = "us",
            LicenseConfigId = "license-config-id",
            LicenseCount = 50,
            SubscriptionTier = "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT",
            StartDate = new Gcp.DiscoveryEngine.Inputs.LicenseConfigStartDateArgs
            {
                Year = 2099,
                Month = 1,
                Day = 1,
            },
            EndDate = new Gcp.DiscoveryEngine.Inputs.LicenseConfigEndDateArgs
            {
                Year = 2100,
                Month = 1,
                Day = 1,
            },
            SubscriptionTerm = "SUBSCRIPTION_TERM_ONE_YEAR",
        });
    
        var project = Gcp.Organizations.GetProject.Invoke();
    
        var basicUserStore = new Gcp.DiscoveryEngine.UserStore("basic", new()
        {
            Location = basic.Location,
            DefaultLicenseConfig = Output.Tuple(project, basic.Location, basic.LicenseConfigId).Apply(values =>
            {
                var project = values.Item1;
                var location = values.Item2;
                var licenseConfigId = values.Item3;
                return $"projects/{project.Apply(getProjectResult => getProjectResult.Number)}/locations/{location}/licenseConfigs/{licenseConfigId}";
            }),
            EnableLicenseAutoRegister = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.discoveryengine.LicenseConfig;
    import com.pulumi.gcp.discoveryengine.LicenseConfigArgs;
    import com.pulumi.gcp.discoveryengine.inputs.LicenseConfigStartDateArgs;
    import com.pulumi.gcp.discoveryengine.inputs.LicenseConfigEndDateArgs;
    import com.pulumi.gcp.organizations.OrganizationsFunctions;
    import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
    import com.pulumi.gcp.discoveryengine.UserStore;
    import com.pulumi.gcp.discoveryengine.UserStoreArgs;
    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 basic = new LicenseConfig("basic", LicenseConfigArgs.builder()
                .location("us")
                .licenseConfigId("license-config-id")
                .licenseCount(50)
                .subscriptionTier("SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT")
                .startDate(LicenseConfigStartDateArgs.builder()
                    .year(2099)
                    .month(1)
                    .day(1)
                    .build())
                .endDate(LicenseConfigEndDateArgs.builder()
                    .year(2100)
                    .month(1)
                    .day(1)
                    .build())
                .subscriptionTerm("SUBSCRIPTION_TERM_ONE_YEAR")
                .build());
    
            final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
                .build());
    
            var basicUserStore = new UserStore("basicUserStore", UserStoreArgs.builder()
                .location(basic.location())
                .defaultLicenseConfig(Output.tuple(basic.location(), basic.licenseConfigId()).applyValue(values -> {
                    var location = values.t1;
                    var licenseConfigId = values.t2;
                    return String.format("projects/%s/locations/%s/licenseConfigs/%s", project.number(),location,licenseConfigId);
                }))
                .enableLicenseAutoRegister(true)
                .build());
    
        }
    }
    
    resources:
      basic:
        type: gcp:discoveryengine:LicenseConfig
        properties:
          location: us
          licenseConfigId: license-config-id
          licenseCount: 50
          subscriptionTier: SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT
          startDate:
            year: 2099
            month: 1
            day: 1
          endDate:
            year: 2100
            month: 1
            day: 1
          subscriptionTerm: SUBSCRIPTION_TERM_ONE_YEAR
      basicUserStore:
        type: gcp:discoveryengine:UserStore
        name: basic
        properties:
          location: ${basic.location}
          defaultLicenseConfig: projects/${project.number}/locations/${basic.location}/licenseConfigs/${basic.licenseConfigId}
          enableLicenseAutoRegister: true
    variables:
      project:
        fn::invoke:
          function: gcp:organizations:getProject
          arguments: {}
    

    Create UserStore Resource

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

    Constructor syntax

    new UserStore(name: string, args: UserStoreArgs, opts?: CustomResourceOptions);
    @overload
    def UserStore(resource_name: str,
                  args: UserStoreArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserStore(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  location: Optional[str] = None,
                  default_license_config: Optional[str] = None,
                  enable_expired_license_auto_update: Optional[bool] = None,
                  enable_license_auto_register: Optional[bool] = None,
                  project: Optional[str] = None,
                  user_store_id: Optional[str] = None)
    func NewUserStore(ctx *Context, name string, args UserStoreArgs, opts ...ResourceOption) (*UserStore, error)
    public UserStore(string name, UserStoreArgs args, CustomResourceOptions? opts = null)
    public UserStore(String name, UserStoreArgs args)
    public UserStore(String name, UserStoreArgs args, CustomResourceOptions options)
    
    type: gcp:discoveryengine:UserStore
    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 UserStoreArgs
    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 UserStoreArgs
    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 UserStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserStoreArgs
    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 userStoreResource = new Gcp.DiscoveryEngine.UserStore("userStoreResource", new()
    {
        Location = "string",
        DefaultLicenseConfig = "string",
        EnableExpiredLicenseAutoUpdate = false,
        EnableLicenseAutoRegister = false,
        Project = "string",
        UserStoreId = "string",
    });
    
    example, err := discoveryengine.NewUserStore(ctx, "userStoreResource", &discoveryengine.UserStoreArgs{
    	Location:                       pulumi.String("string"),
    	DefaultLicenseConfig:           pulumi.String("string"),
    	EnableExpiredLicenseAutoUpdate: pulumi.Bool(false),
    	EnableLicenseAutoRegister:      pulumi.Bool(false),
    	Project:                        pulumi.String("string"),
    	UserStoreId:                    pulumi.String("string"),
    })
    
    var userStoreResource = new UserStore("userStoreResource", UserStoreArgs.builder()
        .location("string")
        .defaultLicenseConfig("string")
        .enableExpiredLicenseAutoUpdate(false)
        .enableLicenseAutoRegister(false)
        .project("string")
        .userStoreId("string")
        .build());
    
    user_store_resource = gcp.discoveryengine.UserStore("userStoreResource",
        location="string",
        default_license_config="string",
        enable_expired_license_auto_update=False,
        enable_license_auto_register=False,
        project="string",
        user_store_id="string")
    
    const userStoreResource = new gcp.discoveryengine.UserStore("userStoreResource", {
        location: "string",
        defaultLicenseConfig: "string",
        enableExpiredLicenseAutoUpdate: false,
        enableLicenseAutoRegister: false,
        project: "string",
        userStoreId: "string",
    });
    
    type: gcp:discoveryengine:UserStore
    properties:
        defaultLicenseConfig: string
        enableExpiredLicenseAutoUpdate: false
        enableLicenseAutoRegister: false
        location: string
        project: string
        userStoreId: string
    

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

    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    DefaultLicenseConfig string
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    EnableExpiredLicenseAutoUpdate bool
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    EnableLicenseAutoRegister bool
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UserStoreId string
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".
    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    DefaultLicenseConfig string
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    EnableExpiredLicenseAutoUpdate bool
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    EnableLicenseAutoRegister bool
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UserStoreId string
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".
    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    defaultLicenseConfig String
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    enableExpiredLicenseAutoUpdate Boolean
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    enableLicenseAutoRegister Boolean
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    userStoreId String
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".
    location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    defaultLicenseConfig string
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    enableExpiredLicenseAutoUpdate boolean
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    enableLicenseAutoRegister boolean
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    userStoreId string
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".
    location str
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    default_license_config str
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    enable_expired_license_auto_update bool
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    enable_license_auto_register bool
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    user_store_id str
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".
    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    defaultLicenseConfig String
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    enableExpiredLicenseAutoUpdate Boolean
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    enableLicenseAutoRegister Boolean
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    userStoreId String
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.

    Look up Existing UserStore Resource

    Get an existing UserStore 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?: UserStoreState, opts?: CustomResourceOptions): UserStore
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            default_license_config: Optional[str] = None,
            enable_expired_license_auto_update: Optional[bool] = None,
            enable_license_auto_register: Optional[bool] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            user_store_id: Optional[str] = None) -> UserStore
    func GetUserStore(ctx *Context, name string, id IDInput, state *UserStoreState, opts ...ResourceOption) (*UserStore, error)
    public static UserStore Get(string name, Input<string> id, UserStoreState? state, CustomResourceOptions? opts = null)
    public static UserStore get(String name, Output<String> id, UserStoreState state, CustomResourceOptions options)
    resources:  _:    type: gcp:discoveryengine:UserStore    get:      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:
    DefaultLicenseConfig string
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    EnableExpiredLicenseAutoUpdate bool
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    EnableLicenseAutoRegister bool
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    Name string
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UserStoreId string
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".
    DefaultLicenseConfig string
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    EnableExpiredLicenseAutoUpdate bool
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    EnableLicenseAutoRegister bool
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    Location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    Name string
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    UserStoreId string
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".
    defaultLicenseConfig String
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    enableExpiredLicenseAutoUpdate Boolean
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    enableLicenseAutoRegister Boolean
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name String
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    userStoreId String
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".
    defaultLicenseConfig string
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    enableExpiredLicenseAutoUpdate boolean
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    enableLicenseAutoRegister boolean
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    location string
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name string
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    userStoreId string
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".
    default_license_config str
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    enable_expired_license_auto_update bool
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    enable_license_auto_register bool
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    location str
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name str
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    user_store_id str
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".
    defaultLicenseConfig String
    The resource name of the default license config assigned to users created in this user store. Format: projects/{project}/locations/{location}/licenseConfigs/{license_config}. If enableLicenseAutoRegister is true, new users will automatically register under the default subscription. If the default license config doesn't have remaining license seats left, new users will not be assigned with license.
    enableExpiredLicenseAutoUpdate Boolean
    Whether to enable automatic license update for users with expired licenses in this user store. If enabled, users with expired licenses will automatically be updated to the default subscription if there are remaining license seats.
    enableLicenseAutoRegister Boolean
    Whether to enable automatic license registration for new users created in this user store. If enabled, new users will automatically register under the default subscription.
    location String
    The geographic location where the data store should reside. The value can only be one of "global", "us" and "eu".
    name String
    The unique full resource name of the user store. Values are of the format projects/{project}/locations/{location}/userStores/{user_store_id}.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    userStoreId String
    The ID of the user store. Currently only accepts <span pulumi-lang-nodejs=""defaultUserStore"" pulumi-lang-dotnet=""DefaultUserStore"" pulumi-lang-go=""defaultUserStore"" pulumi-lang-python=""default_user_store"" pulumi-lang-yaml=""defaultUserStore"" pulumi-lang-java=""defaultUserStore"">"default_user_store".

    Import

    UserStore can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/userStores/{{user_store_id}}

    • {{project}}/{{location}}/{{user_store_id}}

    • {{location}}/{{user_store_id}}

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

    $ pulumi import gcp:discoveryengine/userStore:UserStore default projects/{{project}}/locations/{{location}}/userStores/{{user_store_id}}
    
    $ pulumi import gcp:discoveryengine/userStore:UserStore default {{project}}/{{location}}/{{user_store_id}}
    
    $ pulumi import gcp:discoveryengine/userStore:UserStore default {{location}}/{{user_store_id}}
    

    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 v9.6.0 published on Wednesday, Nov 26, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate