1. Packages
  2. Databricks Provider
  3. API Docs
  4. OboToken
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

    This resource creates On-Behalf-Of tokens for a databricks.ServicePrincipal in Databricks workspaces on AWS. It is very useful, when you want to provision resources within a workspace through narrowly-scoped service principal, that has no access to other workspaces within the same Databricks Account.

    The following resources are often used in the same context:

    • End to end workspace management guide.
    • databricks.Group data to retrieve information about databricks.Group members, entitlements and instance profiles.
    • databricks_group_member to attach users and groups as group members.
    • databricks.Permissions to manage access control in Databricks workspace.
    • databricks.ServicePrincipal to manage Service Principals that could be added to databricks.Group within workspace.
    • databricks.SqlPermissions to manage data object access control lists in Databricks workspaces for things like tables, views, databases, and more.

    Create OboToken Resource

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

    Constructor syntax

    new OboToken(name: string, args: OboTokenArgs, opts?: CustomResourceOptions);
    @overload
    def OboToken(resource_name: str,
                 args: OboTokenArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def OboToken(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 application_id: Optional[str] = None,
                 comment: Optional[str] = None,
                 lifetime_seconds: Optional[int] = None)
    func NewOboToken(ctx *Context, name string, args OboTokenArgs, opts ...ResourceOption) (*OboToken, error)
    public OboToken(string name, OboTokenArgs args, CustomResourceOptions? opts = null)
    public OboToken(String name, OboTokenArgs args)
    public OboToken(String name, OboTokenArgs args, CustomResourceOptions options)
    
    type: databricks:OboToken
    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 OboTokenArgs
    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 OboTokenArgs
    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 OboTokenArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OboTokenArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OboTokenArgs
    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 oboTokenResource = new Databricks.OboToken("oboTokenResource", new()
    {
        ApplicationId = "string",
        Comment = "string",
        LifetimeSeconds = 0,
    });
    
    example, err := databricks.NewOboToken(ctx, "oboTokenResource", &databricks.OboTokenArgs{
    	ApplicationId:   pulumi.String("string"),
    	Comment:         pulumi.String("string"),
    	LifetimeSeconds: pulumi.Int(0),
    })
    
    var oboTokenResource = new OboToken("oboTokenResource", OboTokenArgs.builder()
        .applicationId("string")
        .comment("string")
        .lifetimeSeconds(0)
        .build());
    
    obo_token_resource = databricks.OboToken("oboTokenResource",
        application_id="string",
        comment="string",
        lifetime_seconds=0)
    
    const oboTokenResource = new databricks.OboToken("oboTokenResource", {
        applicationId: "string",
        comment: "string",
        lifetimeSeconds: 0,
    });
    
    type: databricks:OboToken
    properties:
        applicationId: string
        comment: string
        lifetimeSeconds: 0
    

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

    ApplicationId string
    Application ID of databricks.ServicePrincipal to create PAT token for.
    Comment string
    Comment that describes the purpose of the token.
    LifetimeSeconds int
    The number of seconds before the token expires. Token resource is re-created when it expires.
    ApplicationId string
    Application ID of databricks.ServicePrincipal to create PAT token for.
    Comment string
    Comment that describes the purpose of the token.
    LifetimeSeconds int
    The number of seconds before the token expires. Token resource is re-created when it expires.
    applicationId String
    Application ID of databricks.ServicePrincipal to create PAT token for.
    comment String
    Comment that describes the purpose of the token.
    lifetimeSeconds Integer
    The number of seconds before the token expires. Token resource is re-created when it expires.
    applicationId string
    Application ID of databricks.ServicePrincipal to create PAT token for.
    comment string
    Comment that describes the purpose of the token.
    lifetimeSeconds number
    The number of seconds before the token expires. Token resource is re-created when it expires.
    application_id str
    Application ID of databricks.ServicePrincipal to create PAT token for.
    comment str
    Comment that describes the purpose of the token.
    lifetime_seconds int
    The number of seconds before the token expires. Token resource is re-created when it expires.
    applicationId String
    Application ID of databricks.ServicePrincipal to create PAT token for.
    comment String
    Comment that describes the purpose of the token.
    lifetimeSeconds Number
    The number of seconds before the token expires. Token resource is re-created when it expires.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    TokenValue string
    Sensitive value of the newly-created token.
    Id string
    The provider-assigned unique ID for this managed resource.
    TokenValue string
    Sensitive value of the newly-created token.
    id String
    The provider-assigned unique ID for this managed resource.
    tokenValue String
    Sensitive value of the newly-created token.
    id string
    The provider-assigned unique ID for this managed resource.
    tokenValue string
    Sensitive value of the newly-created token.
    id str
    The provider-assigned unique ID for this managed resource.
    token_value str
    Sensitive value of the newly-created token.
    id String
    The provider-assigned unique ID for this managed resource.
    tokenValue String
    Sensitive value of the newly-created token.

    Look up Existing OboToken Resource

    Get an existing OboToken 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?: OboTokenState, opts?: CustomResourceOptions): OboToken
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_id: Optional[str] = None,
            comment: Optional[str] = None,
            lifetime_seconds: Optional[int] = None,
            token_value: Optional[str] = None) -> OboToken
    func GetOboToken(ctx *Context, name string, id IDInput, state *OboTokenState, opts ...ResourceOption) (*OboToken, error)
    public static OboToken Get(string name, Input<string> id, OboTokenState? state, CustomResourceOptions? opts = null)
    public static OboToken get(String name, Output<String> id, OboTokenState state, CustomResourceOptions options)
    resources:  _:    type: databricks:OboToken    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:
    ApplicationId string
    Application ID of databricks.ServicePrincipal to create PAT token for.
    Comment string
    Comment that describes the purpose of the token.
    LifetimeSeconds int
    The number of seconds before the token expires. Token resource is re-created when it expires.
    TokenValue string
    Sensitive value of the newly-created token.
    ApplicationId string
    Application ID of databricks.ServicePrincipal to create PAT token for.
    Comment string
    Comment that describes the purpose of the token.
    LifetimeSeconds int
    The number of seconds before the token expires. Token resource is re-created when it expires.
    TokenValue string
    Sensitive value of the newly-created token.
    applicationId String
    Application ID of databricks.ServicePrincipal to create PAT token for.
    comment String
    Comment that describes the purpose of the token.
    lifetimeSeconds Integer
    The number of seconds before the token expires. Token resource is re-created when it expires.
    tokenValue String
    Sensitive value of the newly-created token.
    applicationId string
    Application ID of databricks.ServicePrincipal to create PAT token for.
    comment string
    Comment that describes the purpose of the token.
    lifetimeSeconds number
    The number of seconds before the token expires. Token resource is re-created when it expires.
    tokenValue string
    Sensitive value of the newly-created token.
    application_id str
    Application ID of databricks.ServicePrincipal to create PAT token for.
    comment str
    Comment that describes the purpose of the token.
    lifetime_seconds int
    The number of seconds before the token expires. Token resource is re-created when it expires.
    token_value str
    Sensitive value of the newly-created token.
    applicationId String
    Application ID of databricks.ServicePrincipal to create PAT token for.
    comment String
    Comment that describes the purpose of the token.
    lifetimeSeconds Number
    The number of seconds before the token expires. Token resource is re-created when it expires.
    tokenValue String
    Sensitive value of the newly-created token.

    Import

    -> Note Importing this resource is not currently supported.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Viewing docs for Databricks v0.4.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.