1. Registry
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. AgentKitSessionStore
Viewing docs for Databricks v1.118.1
published on Tuesday, Oct 27, 2026 by Pulumi
databricks logo databricks logo
Viewing docs for Databricks v1.118.1
published on Tuesday, Oct 27, 2026 by Pulumi

    Public Beta

    API Documentation

    Create AgentKitSessionStore Resource

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

    Constructor syntax

    new AgentKitSessionStore(name: string, args: AgentKitSessionStoreArgs, opts?: CustomResourceOptions);
    @overload
    def AgentKitSessionStore(resource_name: str,
                             args: AgentKitSessionStoreArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def AgentKitSessionStore(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             session_store_id: Optional[str] = None,
                             description: Optional[str] = None,
                             metadata: Optional[Mapping[str, str]] = None,
                             provider_config: Optional[AgentKitSessionStoreProviderConfigArgs] = None)
    func NewAgentKitSessionStore(ctx *Context, name string, args AgentKitSessionStoreArgs, opts ...ResourceOption) (*AgentKitSessionStore, error)
    public AgentKitSessionStore(string name, AgentKitSessionStoreArgs args, CustomResourceOptions? opts = null)
    public AgentKitSessionStore(String name, AgentKitSessionStoreArgs args)
    public AgentKitSessionStore(String name, AgentKitSessionStoreArgs args, CustomResourceOptions options)
    
    type: databricks:AgentKitSessionStore
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "databricks_agent_kit_session_store" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AgentKitSessionStoreArgs
    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 AgentKitSessionStoreArgs
    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 AgentKitSessionStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentKitSessionStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentKitSessionStoreArgs
    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 agentKitSessionStoreResource = new Databricks.AgentKitSessionStore("agentKitSessionStoreResource", new()
    {
        SessionStoreId = "string",
        Description = "string",
        Metadata = 
        {
            { "string", "string" },
        },
        ProviderConfig = new Databricks.Inputs.AgentKitSessionStoreProviderConfigArgs
        {
            WorkspaceId = "string",
        },
    });
    
    example, err := databricks.NewAgentKitSessionStore(ctx, "agentKitSessionStoreResource", &databricks.AgentKitSessionStoreArgs{
    	SessionStoreId: pulumi.String("string"),
    	Description:    pulumi.String("string"),
    	Metadata: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ProviderConfig: &databricks.AgentKitSessionStoreProviderConfigArgs{
    		WorkspaceId: pulumi.String("string"),
    	},
    })
    
    resource "databricks_agent_kit_session_store" "agentKitSessionStoreResource" {
      lifecycle {
        create_before_destroy = true
      }
      session_store_id = "string"
      description      = "string"
      metadata = {
        "string" = "string"
      }
      provider_config = {
        workspace_id = "string"
      }
    }
    
    var agentKitSessionStoreResource = new AgentKitSessionStore("agentKitSessionStoreResource", AgentKitSessionStoreArgs.builder()
        .sessionStoreId("string")
        .description("string")
        .metadata(Map.of("string", "string"))
        .providerConfig(AgentKitSessionStoreProviderConfigArgs.builder()
            .workspaceId("string")
            .build())
        .build());
    
    agent_kit_session_store_resource = databricks.AgentKitSessionStore("agentKitSessionStoreResource",
        session_store_id="string",
        description="string",
        metadata={
            "string": "string",
        },
        provider_config={
            "workspace_id": "string",
        })
    
    const agentKitSessionStoreResource = new databricks.AgentKitSessionStore("agentKitSessionStoreResource", {
        sessionStoreId: "string",
        description: "string",
        metadata: {
            string: "string",
        },
        providerConfig: {
            workspaceId: "string",
        },
    });
    
    type: databricks:AgentKitSessionStore
    properties:
        description: string
        metadata:
            string: string
        providerConfig:
            workspaceId: string
        sessionStoreId: string
    

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

    SessionStoreId string
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    Description string
    Human-readable description of the session store
    Metadata Dictionary<string, string>
    Mutable caller-defined string labels
    ProviderConfig AgentKitSessionStoreProviderConfig
    Configure the provider for management through account provider.
    SessionStoreId string
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    Description string
    Human-readable description of the session store
    Metadata map[string]string
    Mutable caller-defined string labels
    ProviderConfig AgentKitSessionStoreProviderConfigArgs
    Configure the provider for management through account provider.
    session_store_id string
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    description string
    Human-readable description of the session store
    metadata map(string)
    Mutable caller-defined string labels
    provider_config object
    Configure the provider for management through account provider.
    sessionStoreId String
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    description String
    Human-readable description of the session store
    metadata Map<String,String>
    Mutable caller-defined string labels
    providerConfig AgentKitSessionStoreProviderConfig
    Configure the provider for management through account provider.
    sessionStoreId string
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    description string
    Human-readable description of the session store
    metadata {[key: string]: string}
    Mutable caller-defined string labels
    providerConfig AgentKitSessionStoreProviderConfig
    Configure the provider for management through account provider.
    session_store_id str
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    description str
    Human-readable description of the session store
    metadata Mapping[str, str]
    Mutable caller-defined string labels
    provider_config AgentKitSessionStoreProviderConfigArgs
    Configure the provider for management through account provider.
    sessionStoreId String
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    description String
    Human-readable description of the session store
    metadata Map<String>
    Mutable caller-defined string labels
    providerConfig Property Map
    Configure the provider for management through account provider.

    Outputs

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

    CreateTime string
    (string) - Time when the store was created
    CreatorUserId string
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Resource name in the form session-stores/{session_store_id}
    UpdateTime string
    (string) - Time when the store was last updated
    CreateTime string
    (string) - Time when the store was created
    CreatorUserId string
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Resource name in the form session-stores/{session_store_id}
    UpdateTime string
    (string) - Time when the store was last updated
    create_time string
    (string) - Time when the store was created
    creator_user_id string
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - Resource name in the form session-stores/{session_store_id}
    update_time string
    (string) - Time when the store was last updated
    createTime String
    (string) - Time when the store was created
    creatorUserId String
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Resource name in the form session-stores/{session_store_id}
    updateTime String
    (string) - Time when the store was last updated
    createTime string
    (string) - Time when the store was created
    creatorUserId string
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - Resource name in the form session-stores/{session_store_id}
    updateTime string
    (string) - Time when the store was last updated
    create_time str
    (string) - Time when the store was created
    creator_user_id str
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - Resource name in the form session-stores/{session_store_id}
    update_time str
    (string) - Time when the store was last updated
    createTime String
    (string) - Time when the store was created
    creatorUserId String
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Resource name in the form session-stores/{session_store_id}
    updateTime String
    (string) - Time when the store was last updated

    Look up Existing AgentKitSessionStore Resource

    Get an existing AgentKitSessionStore 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?: AgentKitSessionStoreState, opts?: CustomResourceOptions): AgentKitSessionStore
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            create_time: Optional[str] = None,
            creator_user_id: Optional[str] = None,
            description: Optional[str] = None,
            metadata: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            provider_config: Optional[AgentKitSessionStoreProviderConfigArgs] = None,
            session_store_id: Optional[str] = None,
            update_time: Optional[str] = None) -> AgentKitSessionStore
    func GetAgentKitSessionStore(ctx *Context, name string, id IDInput, state *AgentKitSessionStoreState, opts ...ResourceOption) (*AgentKitSessionStore, error)
    public static AgentKitSessionStore Get(string name, Input<string> id, AgentKitSessionStoreState? state, CustomResourceOptions? opts = null)
    public static AgentKitSessionStore get(String name, Output<String> id, AgentKitSessionStoreState state, CustomResourceOptions options)
    resources:  _:    type: databricks:AgentKitSessionStore    get:      id: ${id}
    import {
      to = databricks_agent_kit_session_store.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:
    CreateTime string
    (string) - Time when the store was created
    CreatorUserId string
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    Description string
    Human-readable description of the session store
    Metadata Dictionary<string, string>
    Mutable caller-defined string labels
    Name string
    (string) - Resource name in the form session-stores/{session_store_id}
    ProviderConfig AgentKitSessionStoreProviderConfig
    Configure the provider for management through account provider.
    SessionStoreId string
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    UpdateTime string
    (string) - Time when the store was last updated
    CreateTime string
    (string) - Time when the store was created
    CreatorUserId string
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    Description string
    Human-readable description of the session store
    Metadata map[string]string
    Mutable caller-defined string labels
    Name string
    (string) - Resource name in the form session-stores/{session_store_id}
    ProviderConfig AgentKitSessionStoreProviderConfigArgs
    Configure the provider for management through account provider.
    SessionStoreId string
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    UpdateTime string
    (string) - Time when the store was last updated
    create_time string
    (string) - Time when the store was created
    creator_user_id string
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    description string
    Human-readable description of the session store
    metadata map(string)
    Mutable caller-defined string labels
    name string
    (string) - Resource name in the form session-stores/{session_store_id}
    provider_config object
    Configure the provider for management through account provider.
    session_store_id string
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    update_time string
    (string) - Time when the store was last updated
    createTime String
    (string) - Time when the store was created
    creatorUserId String
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    description String
    Human-readable description of the session store
    metadata Map<String,String>
    Mutable caller-defined string labels
    name String
    (string) - Resource name in the form session-stores/{session_store_id}
    providerConfig AgentKitSessionStoreProviderConfig
    Configure the provider for management through account provider.
    sessionStoreId String
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    updateTime String
    (string) - Time when the store was last updated
    createTime string
    (string) - Time when the store was created
    creatorUserId string
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    description string
    Human-readable description of the session store
    metadata {[key: string]: string}
    Mutable caller-defined string labels
    name string
    (string) - Resource name in the form session-stores/{session_store_id}
    providerConfig AgentKitSessionStoreProviderConfig
    Configure the provider for management through account provider.
    sessionStoreId string
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    updateTime string
    (string) - Time when the store was last updated
    create_time str
    (string) - Time when the store was created
    creator_user_id str
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    description str
    Human-readable description of the session store
    metadata Mapping[str, str]
    Mutable caller-defined string labels
    name str
    (string) - Resource name in the form session-stores/{session_store_id}
    provider_config AgentKitSessionStoreProviderConfigArgs
    Configure the provider for management through account provider.
    session_store_id str
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    update_time str
    (string) - Time when the store was last updated
    createTime String
    (string) - Time when the store was created
    creatorUserId String
    (string) - Workspace-local user ID of the authenticated principal that created the store. This is immutable server-set attribution and does not grant access; authorization is evaluated from the authenticated request context
    description String
    Human-readable description of the session store
    metadata Map<String>
    Mutable caller-defined string labels
    name String
    (string) - Resource name in the form session-stores/{session_store_id}
    providerConfig Property Map
    Configure the provider for management through account provider.
    sessionStoreId String
    Caller-provided, workspace-unique session store ID. It must be 3-55 characters, begin with a lowercase letter, and contain only lowercase letters, digits, and hyphens
    updateTime String
    (string) - Time when the store was last updated

    Supporting Types

    AgentKitSessionStoreProviderConfig, AgentKitSessionStoreProviderConfigArgs

    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    WorkspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId string
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspace_id str
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.
    workspaceId String
    Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with.

    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 logo
    Viewing docs for Databricks v1.118.1
    published on Tuesday, Oct 27, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial