databricks.Secret

With this resource you can insert a secret under the provided scope with the given name. If a secret already exists with the same name, this command overwrites the existing secret’s value. The server encrypts the secret using the secret scope’s encryption settings before storing it. You must have WRITE or MANAGE permission on the secret scope. The secret key must consist of alphanumeric characters, dashes, underscores, and periods, and cannot exceed 128 characters. The maximum allowed secret value size is 128 KB. The maximum number of secrets in a given scope is 1000. You can read a secret value only from within a command on a cluster (for example, through a notebook); there is no API to read a secret value outside of a cluster. The permission applied is based on who is invoking the command and you must have at least READ permission. Please consult Secrets User Guide for more details.

Related Resources

The following resources are often used in the same context:

• End to end workspace management guide.
• databricks.Notebook to manage Databricks Notebooks.
• databricks.Pipeline to deploy Delta Live Tables.
• databricks.Repo to manage Databricks Repos.
• databricks.SecretAcl to manage access to secrets in Databricks workspace.
• databricks.SecretScope to create secret scopes in Databricks workspace.

using Pulumi;
using Databricks = Pulumi.Databricks;

class MyStack : Stack
{
    public MyStack()
    {
        var app = new Databricks.SecretScope("app", new Databricks.SecretScopeArgs
        {
        });
        var publishingApi = new Databricks.Secret("publishingApi", new Databricks.SecretArgs
        {
            Key = "publishing_api",
            StringValue = data.Azurerm_key_vault_secret.Example.Value,
            Scope = app.Id,
        });
    }

}

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 {
		app, err := databricks.NewSecretScope(ctx, "app", nil)
		if err != nil {
			return err
		}
		_, err = databricks.NewSecret(ctx, "publishingApi", &databricks.SecretArgs{
			Key:         pulumi.String("publishing_api"),
			StringValue: pulumi.Any(data.Azurerm_key_vault_secret.Example.Value),
			Scope:       app.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

const app = new databricks.SecretScope("app", {});
const publishingApi = new databricks.Secret("publishingApi", {
    key: "publishing_api",
    stringValue: data.azurerm_key_vault_secret.example.value,
    scope: app.id,
});

import pulumi
import pulumi_databricks as databricks

app = databricks.SecretScope("app")
publishing_api = databricks.Secret("publishingApi",
    key="publishing_api",
    string_value=data["azurerm_key_vault_secret"]["example"]["value"],
    scope=app.id)

Create Secret Resource

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

Constructor syntax

new Secret(name: string, args: SecretArgs, opts?: CustomResourceOptions);

@overload
def Secret(resource_name: str,
           args: SecretArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Secret(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           key: Optional[str] = None,
           scope: Optional[str] = None,
           string_value: Optional[str] = None)

func NewSecret(ctx *Context, name string, args SecretArgs, opts ...ResourceOption) (*Secret, error)

public Secret(string name, SecretArgs args, CustomResourceOptions? opts = null)

public Secret(String name, SecretArgs args)
public Secret(String name, SecretArgs args, CustomResourceOptions options)

type: databricks:Secret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

The following reference example uses placeholder values for all input properties.

var secretResource = new Databricks.Secret("secretResource", new()
{
    Key = "string",
    Scope = "string",
    StringValue = "string",
});

example, err := databricks.NewSecret(ctx, "secretResource", &databricks.SecretArgs{
	Key:         pulumi.String("string"),
	Scope:       pulumi.String("string"),
	StringValue: pulumi.String("string"),
})

var secretResource = new Secret("secretResource", SecretArgs.builder()
    .key("string")
    .scope("string")
    .stringValue("string")
    .build());

secret_resource = databricks.Secret("secretResource",
    key="string",
    scope="string",
    string_value="string")

const secretResource = new databricks.Secret("secretResource", {
    key: "string",
    scope: "string",
    stringValue: "string",
});

type: databricks:Secret
properties:
    key: string
    scope: string
    stringValue: string

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

Outputs

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

Look up Existing Secret Resource

Get an existing Secret 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?: SecretState, opts?: CustomResourceOptions): Secret

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        key: Optional[str] = None,
        last_updated_timestamp: Optional[int] = None,
        scope: Optional[str] = None,
        string_value: Optional[str] = None) -> Secret

func GetSecret(ctx *Context, name string, id IDInput, state *SecretState, opts ...ResourceOption) (*Secret, error)

public static Secret Get(string name, Input<string> id, SecretState? state, CustomResourceOptions? opts = null)

public static Secret get(String name, Output<String> id, SecretState state, CustomResourceOptions options)

resources:  _:    type: databricks:Secret    get:      id: ${id}

Import

The resource secret can be imported using scopeName|||secretKey combination. This may change in future versions. bash

 $ pulumi import databricks:index/secret:Secret app `scopeName|||secretKey`

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.