@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
106 lines (105 loc) • 4.24 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* [](https://docs.databricks.com/aws/en/release-notes/release-types)
*
* This data source can be used to get a single Synced Database Table.
*
* ## Example Usage
*
* Referring to a Database Instance by name:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = databricks.getDatabaseSyncedDatabaseTable({
* name: "my_database_catalog.public.synced_table",
* });
* ```
*/
export declare function getDatabaseSyncedDatabaseTable(args: GetDatabaseSyncedDatabaseTableArgs, opts?: pulumi.InvokeOptions): Promise<GetDatabaseSyncedDatabaseTableResult>;
/**
* A collection of arguments for invoking getDatabaseSyncedDatabaseTable.
*/
export interface GetDatabaseSyncedDatabaseTableArgs {
/**
* Full three-part (catalog, schema, table) name of the table
*/
name: string;
}
/**
* A collection of values returned by getDatabaseSyncedDatabaseTable.
*/
export interface GetDatabaseSyncedDatabaseTableResult {
/**
* (SyncedTableStatus) - Synced Table data synchronization status
*/
readonly dataSynchronizationStatus: outputs.GetDatabaseSyncedDatabaseTableDataSynchronizationStatus;
/**
* (string) - Name of the target database instance. This is required when creating synced database tables in standard catalogs.
* This is optional when creating synced database tables in registered catalogs. If this field is specified
* when creating synced database tables in registered catalogs, the database instance name MUST
* match that of the registered catalog (or the request will be rejected)
*/
readonly databaseInstanceName: string;
/**
* (string) - The name of the database instance that this table is registered to. This field is always returned, and for
* tables inside database catalogs is inferred database instance associated with the catalog
*/
readonly effectiveDatabaseInstanceName: string;
/**
* (string) - The name of the logical database that this table is registered to
*/
readonly effectiveLogicalDatabaseName: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* (string) - Target Postgres database object (logical database) name for this table.
*/
readonly logicalDatabaseName: string;
/**
* (string) - Full three-part (catalog, schema, table) name of the table
*/
readonly name: string;
/**
* (SyncedTableSpec)
*/
readonly spec: outputs.GetDatabaseSyncedDatabaseTableSpec;
/**
* (string) - The provisioning state of the synced table entity in Unity Catalog. This is distinct from the
* state of the data synchronization pipeline (i.e. the table may be in "ACTIVE" but the pipeline
* may be in "PROVISIONING" as it runs asynchronously). Possible values are: `ACTIVE`, `DEGRADED`, `DELETING`, `FAILED`, `PROVISIONING`, `UPDATING`
*/
readonly unityCatalogProvisioningState: string;
}
/**
* [](https://docs.databricks.com/aws/en/release-notes/release-types)
*
* This data source can be used to get a single Synced Database Table.
*
* ## Example Usage
*
* Referring to a Database Instance by name:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const _this = databricks.getDatabaseSyncedDatabaseTable({
* name: "my_database_catalog.public.synced_table",
* });
* ```
*/
export declare function getDatabaseSyncedDatabaseTableOutput(args: GetDatabaseSyncedDatabaseTableOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDatabaseSyncedDatabaseTableResult>;
/**
* A collection of arguments for invoking getDatabaseSyncedDatabaseTable.
*/
export interface GetDatabaseSyncedDatabaseTableOutputArgs {
/**
* Full three-part (catalog, schema, table) name of the table
*/
name: pulumi.Input<string>;
}