@pulumi/databricks/customAppIntegration.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * > Initialize provider with `alias = "account"`, and `host` pointing to the account URL, like, `host = "https://accounts.cloud.databricks.com"`. Use `provider = databricks.account` for all account-level resources.
 *
 * This resource allows you to enable [custom OAuth applications](https://docs.databricks.com/en/integrations/enable-disable-oauth.html#enable-custom-oauth-applications-using-the-databricks-ui).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const _this = new databricks.CustomAppIntegration("this", {
 *     name: "custom_integration_name",
 *     redirectUrls: ["https://example.com"],
 *     scopes: ["all-apis"],
 *     tokenAccessPolicy: {
 *         accessTokenTtlInMinutes: 15,
 *         refreshTokenTtlInMinutes: 30,
 *     },
 * });
 * ```
 *
 * ## Related Resources
 *
 * The following resources are used in the context:
 *
 * * databricks.MwsWorkspaces to set up Databricks workspaces.
 *
 * ## Import
 *
 * This resource can be imported by its integration ID.
 *
 * ```sh
 * $ pulumi import databricks:index/customAppIntegration:CustomAppIntegration this '<integration_id>'
 * ```
 */
export declare class CustomAppIntegration extends pulumi.CustomResource {
    /**
     * Get an existing CustomAppIntegration 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?: CustomAppIntegrationState, opts?: pulumi.CustomResourceOptions): CustomAppIntegration;
    /**
     * Returns true if the given object is an instance of CustomAppIntegration.  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 CustomAppIntegration;
    /**
     * OAuth client-id generated by Databricks
     */
    readonly clientId: pulumi.Output<string>;
    /**
     * OAuth client-secret generated by the Databricks if this is a confidential OAuth app.
     */
    readonly clientSecret: pulumi.Output<string>;
    /**
     * Indicates whether an OAuth client secret is required to authenticate this client. Default to `false`. Change requires a new resource.
     */
    readonly confidential: pulumi.Output<boolean | undefined>;
    readonly createTime: pulumi.Output<string>;
    readonly createdBy: pulumi.Output<number>;
    readonly creatorUsername: pulumi.Output<string>;
    /**
     * Unique integration id for the custom OAuth app.
     */
    readonly integrationId: pulumi.Output<string>;
    /**
     * Name of the custom OAuth app. Change requires a new resource.
     */
    readonly name: pulumi.Output<string>;
    /**
     * List of OAuth redirect urls.
     */
    readonly redirectUrls: pulumi.Output<string[] | undefined>;
    /**
     * OAuth scopes granted to the application. Supported scopes: `all-apis`, `sql`, `offlineAccess`, `openid`, `profile`, `email`.
     */
    readonly scopes: pulumi.Output<string[] | undefined>;
    readonly tokenAccessPolicy: pulumi.Output<outputs.CustomAppIntegrationTokenAccessPolicy | undefined>;
    readonly userAuthorizedScopes: pulumi.Output<string[] | undefined>;
    /**
     * Create a CustomAppIntegration 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?: CustomAppIntegrationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering CustomAppIntegration resources.
 */
export interface CustomAppIntegrationState {
    /**
     * OAuth client-id generated by Databricks
     */
    clientId?: pulumi.Input<string>;
    /**
     * OAuth client-secret generated by the Databricks if this is a confidential OAuth app.
     */
    clientSecret?: pulumi.Input<string>;
    /**
     * Indicates whether an OAuth client secret is required to authenticate this client. Default to `false`. Change requires a new resource.
     */
    confidential?: pulumi.Input<boolean>;
    createTime?: pulumi.Input<string>;
    createdBy?: pulumi.Input<number>;
    creatorUsername?: pulumi.Input<string>;
    /**
     * Unique integration id for the custom OAuth app.
     */
    integrationId?: pulumi.Input<string>;
    /**
     * Name of the custom OAuth app. Change requires a new resource.
     */
    name?: pulumi.Input<string>;
    /**
     * List of OAuth redirect urls.
     */
    redirectUrls?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * OAuth scopes granted to the application. Supported scopes: `all-apis`, `sql`, `offlineAccess`, `openid`, `profile`, `email`.
     */
    scopes?: pulumi.Input<pulumi.Input<string>[]>;
    tokenAccessPolicy?: pulumi.Input<inputs.CustomAppIntegrationTokenAccessPolicy>;
    userAuthorizedScopes?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
 * The set of arguments for constructing a CustomAppIntegration resource.
 */
export interface CustomAppIntegrationArgs {
    /**
     * OAuth client-id generated by Databricks
     */
    clientId?: pulumi.Input<string>;
    /**
     * OAuth client-secret generated by the Databricks if this is a confidential OAuth app.
     */
    clientSecret?: pulumi.Input<string>;
    /**
     * Indicates whether an OAuth client secret is required to authenticate this client. Default to `false`. Change requires a new resource.
     */
    confidential?: pulumi.Input<boolean>;
    createTime?: pulumi.Input<string>;
    createdBy?: pulumi.Input<number>;
    creatorUsername?: pulumi.Input<string>;
    /**
     * Unique integration id for the custom OAuth app.
     */
    integrationId?: pulumi.Input<string>;
    /**
     * Name of the custom OAuth app. Change requires a new resource.
     */
    name?: pulumi.Input<string>;
    /**
     * List of OAuth redirect urls.
     */
    redirectUrls?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * OAuth scopes granted to the application. Supported scopes: `all-apis`, `sql`, `offlineAccess`, `openid`, `profile`, `email`.
     */
    scopes?: pulumi.Input<pulumi.Input<string>[]>;
    tokenAccessPolicy?: pulumi.Input<inputs.CustomAppIntegrationTokenAccessPolicy>;
    userAuthorizedScopes?: pulumi.Input<pulumi.Input<string>[]>;
}