Databricks v1.14.0, May 23 23

databricks.Token

Explore with Pulumi AI

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.

Create Token Resource

new Token(name: string, args?: TokenArgs, opts?: CustomResourceOptions);

@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)
@overload
def Token(resource_name: str,
          args: Optional[TokenArgs] = None,
          opts: Optional[ResourceOptions] = 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.

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.

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

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, the token remains valid indefinitely.
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, the token remains valid indefinitely.
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, the token remains valid indefinitely.
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, the token remains valid indefinitely.
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, the token remains valid indefinitely.
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, the token remains valid indefinitely.
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)

Resource lookup is not supported in YAML

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, the token remains valid indefinitely.
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, the token remains valid indefinitely.
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, the token remains valid indefinitely.
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, the token remains valid indefinitely.
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, the token remains valid indefinitely.
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, the token remains valid indefinitely.
tokenId String
tokenValue String: Sensitive value of the newly-created token.

Import

-> Note Importing this resource is not currently supported.

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.