@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
159 lines (158 loc) • 6.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* > This resource can only be used with an account-level provider.
*
* With this resource you can create a secret for a given [Service Principals](https://docs.databricks.com/administration-guide/users-groups/service-principals.html).
*
* This secret can be used to configure the Databricks Pulumi Provider to authenticate with the service principal. See Authenticating with service principal.
*
* Additionally, the secret can be used to request OAuth tokens for the service principal, which can be used to authenticate to Databricks REST APIs. See [Authentication using OAuth tokens for service principals](https://docs.databricks.com/dev-tools/authentication-oauth.html).
*
* ## Example Usage
*
* Create service principal secret
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const terraformSp = new databricks.ServicePrincipalSecret("terraform_sp", {servicePrincipalId: _this.id});
* ```
*
* ## Related Resources
*
* The following resources are often used in the same context:
*
* * databricks.ServicePrincipal to manage [Service Principals](https://docs.databricks.com/administration-guide/users-groups/service-principals.html) in Databricks
*/
export declare class ServicePrincipalSecret extends pulumi.CustomResource {
/**
* Get an existing ServicePrincipalSecret resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServicePrincipalSecretState, opts?: pulumi.CustomResourceOptions): ServicePrincipalSecret;
/**
* Returns true if the given object is an instance of ServicePrincipalSecret. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ServicePrincipalSecret;
/**
* UTC time when the secret was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* UTC time when the secret will expire. If the field is not present, the secret does not expire.
*/
readonly expireTime: pulumi.Output<string>;
/**
* The lifetime of the secret in seconds formatted as `NNNNs`. If this parameter is not provided, the secret will have a default lifetime of 730 days (`63072000s`). Expiration of secret will lead to generation of new secret.
*/
readonly lifetime: pulumi.Output<string>;
/**
* Generated secret for the service principal.
*/
readonly secret: pulumi.Output<string>;
/**
* Secret Hash.
*/
readonly secretHash: pulumi.Output<string>;
/**
* SCIM ID of the databricks.ServicePrincipal (not application ID).
*/
readonly servicePrincipalId: pulumi.Output<string>;
/**
* Status of the secret (i.e., `ACTIVE` - see [REST API docs for full list](https://docs.databricks.com/api/account/serviceprincipalsecrets/list#secrets-status)).
*/
readonly status: pulumi.Output<string>;
/**
* UTC time when the secret was updated.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a ServicePrincipalSecret resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ServicePrincipalSecretArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServicePrincipalSecret resources.
*/
export interface ServicePrincipalSecretState {
/**
* UTC time when the secret was created.
*/
createTime?: pulumi.Input<string>;
/**
* UTC time when the secret will expire. If the field is not present, the secret does not expire.
*/
expireTime?: pulumi.Input<string>;
/**
* The lifetime of the secret in seconds formatted as `NNNNs`. If this parameter is not provided, the secret will have a default lifetime of 730 days (`63072000s`). Expiration of secret will lead to generation of new secret.
*/
lifetime?: pulumi.Input<string>;
/**
* Generated secret for the service principal.
*/
secret?: pulumi.Input<string>;
/**
* Secret Hash.
*/
secretHash?: pulumi.Input<string>;
/**
* SCIM ID of the databricks.ServicePrincipal (not application ID).
*/
servicePrincipalId?: pulumi.Input<string>;
/**
* Status of the secret (i.e., `ACTIVE` - see [REST API docs for full list](https://docs.databricks.com/api/account/serviceprincipalsecrets/list#secrets-status)).
*/
status?: pulumi.Input<string>;
/**
* UTC time when the secret was updated.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ServicePrincipalSecret resource.
*/
export interface ServicePrincipalSecretArgs {
/**
* UTC time when the secret was created.
*/
createTime?: pulumi.Input<string>;
/**
* UTC time when the secret will expire. If the field is not present, the secret does not expire.
*/
expireTime?: pulumi.Input<string>;
/**
* The lifetime of the secret in seconds formatted as `NNNNs`. If this parameter is not provided, the secret will have a default lifetime of 730 days (`63072000s`). Expiration of secret will lead to generation of new secret.
*/
lifetime?: pulumi.Input<string>;
/**
* Generated secret for the service principal.
*/
secret?: pulumi.Input<string>;
/**
* Secret Hash.
*/
secretHash?: pulumi.Input<string>;
/**
* SCIM ID of the databricks.ServicePrincipal (not application ID).
*/
servicePrincipalId: pulumi.Input<string>;
/**
* Status of the secret (i.e., `ACTIVE` - see [REST API docs for full list](https://docs.databricks.com/api/account/serviceprincipalsecrets/list#secrets-status)).
*/
status?: pulumi.Input<string>;
/**
* UTC time when the secret was updated.
*/
updateTime?: pulumi.Input<string>;
}