Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. OnlineStore
Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.OnlineStore

Explore with Pulumi AI

databricks logo
Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi
pulumi/pulumi-databricks

    Import

    As of Pulumi v1.5, resources can be imported through configuration.

    hcl

    import {

    id = name

    to = databricks_online_store.this

    }

    If you are using an older version of Pulumi, import the resource using the pulumi import command as follows:

    $ pulumi import databricks:index/onlineStore:OnlineStore databricks_online_store name

    Create OnlineStore Resource

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

    Constructor syntax

    new OnlineStore(name: string, args: OnlineStoreArgs, opts?: CustomResourceOptions);
    @overload
def OnlineStore(resource_name: str,
                args: OnlineStoreArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def OnlineStore(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                capacity: Optional[str] = None,
                name: Optional[str] = None,
                read_replica_count: Optional[int] = None)
    func NewOnlineStore(ctx *Context, name string, args OnlineStoreArgs, opts ...ResourceOption) (*OnlineStore, error)
    public OnlineStore(string name, OnlineStoreArgs args, CustomResourceOptions? opts = null)
    public OnlineStore(String name, OnlineStoreArgs args)
public OnlineStore(String name, OnlineStoreArgs args, CustomResourceOptions options)

    type: databricks:OnlineStore
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 OnlineStoreArgs
    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 OnlineStoreArgs
    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 OnlineStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OnlineStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OnlineStoreArgs
    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 onlineStoreResource = new Databricks.OnlineStore("onlineStoreResource", new()
{
    Capacity = "string",
    Name = "string",
    ReadReplicaCount = 0,
});

    example, err := databricks.NewOnlineStore(ctx, "onlineStoreResource", &databricks.OnlineStoreArgs{
	Capacity:         pulumi.String("string"),
	Name:             pulumi.String("string"),
	ReadReplicaCount: pulumi.Int(0),
})

    var onlineStoreResource = new OnlineStore("onlineStoreResource", OnlineStoreArgs.builder()
    .capacity("string")
    .name("string")
    .readReplicaCount(0)
    .build());

    online_store_resource = databricks.OnlineStore("onlineStoreResource",
    capacity="string",
    name="string",
    read_replica_count=0)

    const onlineStoreResource = new databricks.OnlineStore("onlineStoreResource", {
    capacity: "string",
    name: "string",
    readReplicaCount: 0,
});

    type: databricks:OnlineStore
properties:
    capacity: string
    name: string
    readReplicaCount: 0

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

    Capacity string
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    Name string
    The name of the online store. This is the unique identifier for the online store
    ReadReplicaCount int
    The number of read replicas for the online store. Defaults to 0
    Capacity string
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    Name string
    The name of the online store. This is the unique identifier for the online store
    ReadReplicaCount int
    The number of read replicas for the online store. Defaults to 0
    capacity String
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    name String
    The name of the online store. This is the unique identifier for the online store
    readReplicaCount Integer
    The number of read replicas for the online store. Defaults to 0
    capacity string
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    name string
    The name of the online store. This is the unique identifier for the online store
    readReplicaCount number
    The number of read replicas for the online store. Defaults to 0
    capacity str
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    name str
    The name of the online store. This is the unique identifier for the online store
    read_replica_count int
    The number of read replicas for the online store. Defaults to 0
    capacity String
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    name String
    The name of the online store. This is the unique identifier for the online store
    readReplicaCount Number
    The number of read replicas for the online store. Defaults to 0

    Outputs

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

    CreationTime string
    (string) - The timestamp when the online store was created
    Creator string
    (string) - The email of the creator of the online store
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    CreationTime string
    (string) - The timestamp when the online store was created
    Creator string
    (string) - The email of the creator of the online store
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    creationTime String
    (string) - The timestamp when the online store was created
    creator String
    (string) - The email of the creator of the online store
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    creationTime string
    (string) - The timestamp when the online store was created
    creator string
    (string) - The email of the creator of the online store
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    creation_time str
    (string) - The timestamp when the online store was created
    creator str
    (string) - The email of the creator of the online store
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    creationTime String
    (string) - The timestamp when the online store was created
    creator String
    (string) - The email of the creator of the online store
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING

    Look up Existing OnlineStore Resource

    Get an existing OnlineStore 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?: OnlineStoreState, opts?: CustomResourceOptions): OnlineStore
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capacity: Optional[str] = None,
        creation_time: Optional[str] = None,
        creator: Optional[str] = None,
        name: Optional[str] = None,
        read_replica_count: Optional[int] = None,
        state: Optional[str] = None) -> OnlineStore
    func GetOnlineStore(ctx *Context, name string, id IDInput, state *OnlineStoreState, opts ...ResourceOption) (*OnlineStore, error)
    public static OnlineStore Get(string name, Input<string> id, OnlineStoreState? state, CustomResourceOptions? opts = null)
    public static OnlineStore get(String name, Output<String> id, OnlineStoreState state, CustomResourceOptions options)
    resources:  _:    type: databricks:OnlineStore    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:
    Capacity string
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    CreationTime string
    (string) - The timestamp when the online store was created
    Creator string
    (string) - The email of the creator of the online store
    Name string
    The name of the online store. This is the unique identifier for the online store
    ReadReplicaCount int
    The number of read replicas for the online store. Defaults to 0
    State string
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    Capacity string
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    CreationTime string
    (string) - The timestamp when the online store was created
    Creator string
    (string) - The email of the creator of the online store
    Name string
    The name of the online store. This is the unique identifier for the online store
    ReadReplicaCount int
    The number of read replicas for the online store. Defaults to 0
    State string
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    capacity String
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    creationTime String
    (string) - The timestamp when the online store was created
    creator String
    (string) - The email of the creator of the online store
    name String
    The name of the online store. This is the unique identifier for the online store
    readReplicaCount Integer
    The number of read replicas for the online store. Defaults to 0
    state String
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    capacity string
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    creationTime string
    (string) - The timestamp when the online store was created
    creator string
    (string) - The email of the creator of the online store
    name string
    The name of the online store. This is the unique identifier for the online store
    readReplicaCount number
    The number of read replicas for the online store. Defaults to 0
    state string
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    capacity str
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    creation_time str
    (string) - The timestamp when the online store was created
    creator str
    (string) - The email of the creator of the online store
    name str
    The name of the online store. This is the unique identifier for the online store
    read_replica_count int
    The number of read replicas for the online store. Defaults to 0
    state str
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    capacity String
    The capacity of the online store. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    creationTime String
    (string) - The timestamp when the online store was created
    creator String
    (string) - The email of the creator of the online store
    name String
    The name of the online store. This is the unique identifier for the online store
    readReplicaCount Number
    The number of read replicas for the online store. Defaults to 0
    state String
    (string) - The current state of the online store. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi
    pulumi/pulumi-databricks