Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. Token
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.Token

Explore with Pulumi AI

databricks logo
Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-databricks

    This resource can only be used with a workspace-level provider!

    This resource creates Personal Access Tokens for the same user that is authenticated with the provider. Most likely you should use databricks.OboToken to create On-Behalf-Of tokens for a databricks.ServicePrincipal in Databricks workspaces on AWS. Databricks workspaces on other clouds use their own native OAuth token flows.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

// create PAT token to provision entities within workspace
const pat = new databricks.Token("pat", {
    comment: "Pulumi Provisioning",
    lifetimeSeconds: 8640000,
});
export const databricksToken = pat.tokenValue;

    import pulumi
import pulumi_databricks as databricks

# create PAT token to provision entities within workspace
pat = databricks.Token("pat",
    comment="Pulumi Provisioning",
    lifetime_seconds=8640000)
pulumi.export("databricksToken", pat.token_value)

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// create PAT token to provision entities within workspace
		pat, err := databricks.NewToken(ctx, "pat", &databricks.TokenArgs{
			Comment:         pulumi.String("Pulumi Provisioning"),
			LifetimeSeconds: pulumi.Int(8640000),
		})
		if err != nil {
			return err
		}
		ctx.Export("databricksToken", pat.TokenValue)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    // create PAT token to provision entities within workspace
    var pat = new Databricks.Token("pat", new()
    {
        Comment = "Pulumi Provisioning",
        LifetimeSeconds = 8640000,
    });

    return new Dictionary<string, object?>
    {
        ["databricksToken"] = pat.TokenValue,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Token;
import com.pulumi.databricks.TokenArgs;
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) {
        // create PAT token to provision entities within workspace
        var pat = new Token("pat", TokenArgs.builder()
            .comment("Pulumi Provisioning")
            .lifetimeSeconds(8640000)
            .build());

        ctx.export("databricksToken", pat.tokenValue());
    }
}

    resources:
  # create PAT token to provision entities within workspace
  pat:
    type: databricks:Token
    properties:
      comment: Pulumi Provisioning
      lifetimeSeconds: 8.64e+06
outputs:
  # output token for other modules
  databricksToken: ${pat.tokenValue}

    A token can be automatically rotated by taking a dependency on the time_rotating resource:

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";
import * as time from "@pulumiverse/time";

const _this = new time.Rotating("this", {rotationDays: 30});
const pat = new databricks.Token("pat", {
    comment: pulumi.interpolate`Pulumi (created: ${_this.rfc3339})`,
    lifetimeSeconds: 60 * 24 * 60 * 60,
});

    import pulumi
import pulumi_databricks as databricks
import pulumiverse_time as time

this = time.Rotating("this", rotation_days=30)
pat = databricks.Token("pat",
    comment=this.rfc3339.apply(lambda rfc3339: f"Pulumi (created: {rfc3339})"),
    lifetime_seconds=60 * 24 * 60 * 60)

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi-time/sdk/go/time"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		this, err := time.NewRotating(ctx, "this", &time.RotatingArgs{
			RotationDays: pulumi.Int(30),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewToken(ctx, "pat", &databricks.TokenArgs{
			Comment: this.Rfc3339.ApplyT(func(rfc3339 string) (string, error) {
				return fmt.Sprintf("Pulumi (created: %v)", rfc3339), nil
			}).(pulumi.StringOutput),
			LifetimeSeconds: int(60 * 24 * 60 * 60),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;
using Time = Pulumiverse.Time;

return await Deployment.RunAsync(() => 
{
    var @this = new Time.Rotating("this", new()
    {
        RotationDays = 30,
    });

    var pat = new Databricks.Token("pat", new()
    {
        Comment = @this.Rfc3339.Apply(rfc3339 => $"Pulumi (created: {rfc3339})"),
        LifetimeSeconds = 60 * 24 * 60 * 60,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.time.Rotating;
import com.pulumi.time.RotatingArgs;
import com.pulumi.databricks.Token;
import com.pulumi.databricks.TokenArgs;
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 this_ = new Rotating("this", RotatingArgs.builder()
            .rotationDays(30)
            .build());

        var pat = new Token("pat", TokenArgs.builder()
            .comment(this_.rfc3339().applyValue(rfc3339 -> String.format("Pulumi (created: %s)", rfc3339)))
            .lifetimeSeconds(60 * 24 * 60 * 60)
            .build());

    }
}

    Coming soon!

    Create Token Resource

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

    Constructor syntax

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

@overload
def Token(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          comment: Optional[str] = None,
          creation_time: Optional[int] = None,
          expiry_time: Optional[int] = None,
          lifetime_seconds: Optional[int] = None,
          token_id: Optional[str] = None)
    func NewToken(ctx *Context, name string, args *TokenArgs, opts ...ResourceOption) (*Token, error)
    public Token(string name, TokenArgs? args = null, CustomResourceOptions? opts = null)
    public Token(String name, TokenArgs args)
public Token(String name, TokenArgs args, CustomResourceOptions options)

    type: databricks:Token
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 TokenArgs
    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 TokenArgs
    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 TokenArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TokenArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TokenArgs
    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 tokenResource = new Databricks.Token("tokenResource", new()
{
    Comment = "string",
    CreationTime = 0,
    ExpiryTime = 0,
    LifetimeSeconds = 0,
    TokenId = "string",
});

    example, err := databricks.NewToken(ctx, "tokenResource", &databricks.TokenArgs{
	Comment:         pulumi.String("string"),
	CreationTime:    pulumi.Int(0),
	ExpiryTime:      pulumi.Int(0),
	LifetimeSeconds: pulumi.Int(0),
	TokenId:         pulumi.String("string"),
})

    var tokenResource = new Token("tokenResource", TokenArgs.builder()
    .comment("string")
    .creationTime(0)
    .expiryTime(0)
    .lifetimeSeconds(0)
    .tokenId("string")
    .build());

    token_resource = databricks.Token("tokenResource",
    comment="string",
    creation_time=0,
    expiry_time=0,
    lifetime_seconds=0,
    token_id="string")

    const tokenResource = new databricks.Token("tokenResource", {
    comment: "string",
    creationTime: 0,
    expiryTime: 0,
    lifetimeSeconds: 0,
    tokenId: "string",
});

    type: databricks:Token
properties:
    comment: string
    creationTime: 0
    expiryTime: 0
    lifetimeSeconds: 0
    tokenId: string

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

    Comment string
    (String) Comment that will appear on the user’s settings page for this token.
    CreationTime int
    ExpiryTime int
    LifetimeSeconds int
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    TokenId string
    Comment string
    (String) Comment that will appear on the user’s settings page for this token.
    CreationTime int
    ExpiryTime int
    LifetimeSeconds int
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    TokenId string
    comment String
    (String) Comment that will appear on the user’s settings page for this token.
    creationTime Integer
    expiryTime Integer
    lifetimeSeconds Integer
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    tokenId String
    comment string
    (String) Comment that will appear on the user’s settings page for this token.
    creationTime number
    expiryTime number
    lifetimeSeconds number
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    tokenId string
    comment str
    (String) Comment that will appear on the user’s settings page for this token.
    creation_time int
    expiry_time int
    lifetime_seconds int
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    token_id str
    comment String
    (String) Comment that will appear on the user’s settings page for this token.
    creationTime Number
    expiryTime Number
    lifetimeSeconds Number
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    tokenId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Token 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 Token Resource

    Get an existing Token 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?: TokenState, opts?: CustomResourceOptions): Token
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        creation_time: Optional[int] = None,
        expiry_time: Optional[int] = None,
        lifetime_seconds: Optional[int] = None,
        token_id: Optional[str] = None,
        token_value: Optional[str] = None) -> Token
    func GetToken(ctx *Context, name string, id IDInput, state *TokenState, opts ...ResourceOption) (*Token, error)
    public static Token Get(string name, Input<string> id, TokenState? state, CustomResourceOptions? opts = null)
    public static Token get(String name, Output<String> id, TokenState state, CustomResourceOptions options)
    resources:  _:    type: databricks:Token    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:
    Comment string
    (String) Comment that will appear on the user’s settings page for this token.
    CreationTime int
    ExpiryTime int
    LifetimeSeconds int
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    TokenId string
    TokenValue string
    Sensitive value of the newly-created token.
    Comment string
    (String) Comment that will appear on the user’s settings page for this token.
    CreationTime int
    ExpiryTime int
    LifetimeSeconds int
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    TokenId string
    TokenValue string
    Sensitive value of the newly-created token.
    comment String
    (String) Comment that will appear on the user’s settings page for this token.
    creationTime Integer
    expiryTime Integer
    lifetimeSeconds Integer
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    tokenId String
    tokenValue String
    Sensitive value of the newly-created token.
    comment string
    (String) Comment that will appear on the user’s settings page for this token.
    creationTime number
    expiryTime number
    lifetimeSeconds number
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    tokenId string
    tokenValue string
    Sensitive value of the newly-created token.
    comment str
    (String) Comment that will appear on the user’s settings page for this token.
    creation_time int
    expiry_time int
    lifetime_seconds int
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    token_id str
    token_value str
    Sensitive value of the newly-created token.
    comment String
    (String) Comment that will appear on the user’s settings page for this token.
    creationTime Number
    expiryTime Number
    lifetimeSeconds Number
    (Integer) The lifetime of the token, in seconds. If no lifetime is specified, then expire time will be set to maximum allowed by the workspace configuration or platform.
    tokenId String
    tokenValue String
    Sensitive value of the newly-created token.

    Import

    !> 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
    Databricks v1.63.0 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-databricks