Manages catalog configuration filters for a dbt Cloud connection.
This resource configures what database objects (databases, schemas, tables, views) are included or excluded when ingesting metadata from your data warehouse. It works in conjunction with platform metadata credentials to control what gets synchronized into dbt Cloud’s catalog.
Each filter type has an “allow” list (whitelist) and a “deny” list (blacklist):
- If an allow list is set, only matching objects are included
- If a deny list is set, matching objects are excluded
- Deny takes precedence over allow
- Patterns support wildcards (e.g., “temp_*”)
Note: The
connection_idcannot be changed after creation. To use a different connection, you must destroy and recreate the resource.
Note: This resource requires a platform metadata credential to be configured for the connection.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as dbtcloud from "@pulumi/dbtcloud";
// Example: Configure catalog filters for a Snowflake connection
const snowflakeFilters = new dbtcloud.ConnectionCatalogConfig("snowflake_filters", {
connectionId: snowflake.id,
databaseAllows: [
"analytics",
"reporting",
],
schemaDenies: [
"staging",
"temp",
"scratch",
],
tableDenies: [
"tmp_*",
"temp_*",
],
viewDenies: [
"secret_*",
"internal_*",
],
});
// Example: Minimal configuration - just filter databases
const minimal = new dbtcloud.ConnectionCatalogConfig("minimal", {
connectionId: snowflake.id,
databaseAllows: ["production"],
});
// Example: Full configuration with platform metadata credential
const creds = new dbtcloud.SnowflakePlatformMetadataCredential("creds", {
connectionId: snowflake.id,
catalogIngestionEnabled: true,
authType: "password",
user: snowflakeUser,
password: snowflakePassword,
role: snowflakeRole,
warehouse: snowflakeWarehouse,
});
const withCreds = new dbtcloud.ConnectionCatalogConfig("with_creds", {
connectionId: snowflake.id,
databaseAllows: [
"analytics",
"reporting",
],
databaseDenies: ["sandbox"],
schemaAllows: [
"public",
"dbt_*",
],
schemaDenies: [
"information_schema",
"pg_*",
],
tableDenies: [
"_tmp_*",
"_staging_*",
],
viewDenies: ["_internal_*"],
}, {
dependsOn: [creds],
});
import pulumi
import pulumi_dbtcloud as dbtcloud
# Example: Configure catalog filters for a Snowflake connection
snowflake_filters = dbtcloud.ConnectionCatalogConfig("snowflake_filters",
connection_id=snowflake["id"],
database_allows=[
"analytics",
"reporting",
],
schema_denies=[
"staging",
"temp",
"scratch",
],
table_denies=[
"tmp_*",
"temp_*",
],
view_denies=[
"secret_*",
"internal_*",
])
# Example: Minimal configuration - just filter databases
minimal = dbtcloud.ConnectionCatalogConfig("minimal",
connection_id=snowflake["id"],
database_allows=["production"])
# Example: Full configuration with platform metadata credential
creds = dbtcloud.SnowflakePlatformMetadataCredential("creds",
connection_id=snowflake["id"],
catalog_ingestion_enabled=True,
auth_type="password",
user=snowflake_user,
password=snowflake_password,
role=snowflake_role,
warehouse=snowflake_warehouse)
with_creds = dbtcloud.ConnectionCatalogConfig("with_creds",
connection_id=snowflake["id"],
database_allows=[
"analytics",
"reporting",
],
database_denies=["sandbox"],
schema_allows=[
"public",
"dbt_*",
],
schema_denies=[
"information_schema",
"pg_*",
],
table_denies=[
"_tmp_*",
"_staging_*",
],
view_denies=["_internal_*"],
opts = pulumi.ResourceOptions(depends_on=[creds]))
package main
import (
"github.com/pulumi/pulumi-dbtcloud/sdk/go/dbtcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Example: Configure catalog filters for a Snowflake connection
_, err := dbtcloud.NewConnectionCatalogConfig(ctx, "snowflake_filters", &dbtcloud.ConnectionCatalogConfigArgs{
ConnectionId: pulumi.Any(snowflake.Id),
DatabaseAllows: pulumi.StringArray{
pulumi.String("analytics"),
pulumi.String("reporting"),
},
SchemaDenies: pulumi.StringArray{
pulumi.String("staging"),
pulumi.String("temp"),
pulumi.String("scratch"),
},
TableDenies: pulumi.StringArray{
pulumi.String("tmp_*"),
pulumi.String("temp_*"),
},
ViewDenies: pulumi.StringArray{
pulumi.String("secret_*"),
pulumi.String("internal_*"),
},
})
if err != nil {
return err
}
// Example: Minimal configuration - just filter databases
_, err = dbtcloud.NewConnectionCatalogConfig(ctx, "minimal", &dbtcloud.ConnectionCatalogConfigArgs{
ConnectionId: pulumi.Any(snowflake.Id),
DatabaseAllows: pulumi.StringArray{
pulumi.String("production"),
},
})
if err != nil {
return err
}
// Example: Full configuration with platform metadata credential
creds, err := dbtcloud.NewSnowflakePlatformMetadataCredential(ctx, "creds", &dbtcloud.SnowflakePlatformMetadataCredentialArgs{
ConnectionId: pulumi.Any(snowflake.Id),
CatalogIngestionEnabled: pulumi.Bool(true),
AuthType: pulumi.String("password"),
User: pulumi.Any(snowflakeUser),
Password: pulumi.Any(snowflakePassword),
Role: pulumi.Any(snowflakeRole),
Warehouse: pulumi.Any(snowflakeWarehouse),
})
if err != nil {
return err
}
_, err = dbtcloud.NewConnectionCatalogConfig(ctx, "with_creds", &dbtcloud.ConnectionCatalogConfigArgs{
ConnectionId: pulumi.Any(snowflake.Id),
DatabaseAllows: pulumi.StringArray{
pulumi.String("analytics"),
pulumi.String("reporting"),
},
DatabaseDenies: pulumi.StringArray{
pulumi.String("sandbox"),
},
SchemaAllows: pulumi.StringArray{
pulumi.String("public"),
pulumi.String("dbt_*"),
},
SchemaDenies: pulumi.StringArray{
pulumi.String("information_schema"),
pulumi.String("pg_*"),
},
TableDenies: pulumi.StringArray{
pulumi.String("_tmp_*"),
pulumi.String("_staging_*"),
},
ViewDenies: pulumi.StringArray{
pulumi.String("_internal_*"),
},
}, pulumi.DependsOn([]pulumi.Resource{
creds,
}))
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DbtCloud = Pulumi.DbtCloud;
return await Deployment.RunAsync(() =>
{
// Example: Configure catalog filters for a Snowflake connection
var snowflakeFilters = new DbtCloud.ConnectionCatalogConfig("snowflake_filters", new()
{
ConnectionId = snowflake.Id,
DatabaseAllows = new[]
{
"analytics",
"reporting",
},
SchemaDenies = new[]
{
"staging",
"temp",
"scratch",
},
TableDenies = new[]
{
"tmp_*",
"temp_*",
},
ViewDenies = new[]
{
"secret_*",
"internal_*",
},
});
// Example: Minimal configuration - just filter databases
var minimal = new DbtCloud.ConnectionCatalogConfig("minimal", new()
{
ConnectionId = snowflake.Id,
DatabaseAllows = new[]
{
"production",
},
});
// Example: Full configuration with platform metadata credential
var creds = new DbtCloud.SnowflakePlatformMetadataCredential("creds", new()
{
ConnectionId = snowflake.Id,
CatalogIngestionEnabled = true,
AuthType = "password",
User = snowflakeUser,
Password = snowflakePassword,
Role = snowflakeRole,
Warehouse = snowflakeWarehouse,
});
var withCreds = new DbtCloud.ConnectionCatalogConfig("with_creds", new()
{
ConnectionId = snowflake.Id,
DatabaseAllows = new[]
{
"analytics",
"reporting",
},
DatabaseDenies = new[]
{
"sandbox",
},
SchemaAllows = new[]
{
"public",
"dbt_*",
},
SchemaDenies = new[]
{
"information_schema",
"pg_*",
},
TableDenies = new[]
{
"_tmp_*",
"_staging_*",
},
ViewDenies = new[]
{
"_internal_*",
},
}, new CustomResourceOptions
{
DependsOn =
{
creds,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dbtcloud.ConnectionCatalogConfig;
import com.pulumi.dbtcloud.ConnectionCatalogConfigArgs;
import com.pulumi.dbtcloud.SnowflakePlatformMetadataCredential;
import com.pulumi.dbtcloud.SnowflakePlatformMetadataCredentialArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Example: Configure catalog filters for a Snowflake connection
var snowflakeFilters = new ConnectionCatalogConfig("snowflakeFilters", ConnectionCatalogConfigArgs.builder()
.connectionId(snowflake.id())
.databaseAllows(
"analytics",
"reporting")
.schemaDenies(
"staging",
"temp",
"scratch")
.tableDenies(
"tmp_*",
"temp_*")
.viewDenies(
"secret_*",
"internal_*")
.build());
// Example: Minimal configuration - just filter databases
var minimal = new ConnectionCatalogConfig("minimal", ConnectionCatalogConfigArgs.builder()
.connectionId(snowflake.id())
.databaseAllows("production")
.build());
// Example: Full configuration with platform metadata credential
var creds = new SnowflakePlatformMetadataCredential("creds", SnowflakePlatformMetadataCredentialArgs.builder()
.connectionId(snowflake.id())
.catalogIngestionEnabled(true)
.authType("password")
.user(snowflakeUser)
.password(snowflakePassword)
.role(snowflakeRole)
.warehouse(snowflakeWarehouse)
.build());
var withCreds = new ConnectionCatalogConfig("withCreds", ConnectionCatalogConfigArgs.builder()
.connectionId(snowflake.id())
.databaseAllows(
"analytics",
"reporting")
.databaseDenies("sandbox")
.schemaAllows(
"public",
"dbt_*")
.schemaDenies(
"information_schema",
"pg_*")
.tableDenies(
"_tmp_*",
"_staging_*")
.viewDenies("_internal_*")
.build(), CustomResourceOptions.builder()
.dependsOn(creds)
.build());
}
}
resources:
# Example: Configure catalog filters for a Snowflake connection
snowflakeFilters:
type: dbtcloud:ConnectionCatalogConfig
name: snowflake_filters
properties:
connectionId: ${snowflake.id}
databaseAllows:
- analytics
- reporting
schemaDenies:
- staging
- temp
- scratch
tableDenies:
- tmp_*
- temp_*
viewDenies:
- secret_*
- internal_*
# Example: Minimal configuration - just filter databases
minimal:
type: dbtcloud:ConnectionCatalogConfig
properties:
connectionId: ${snowflake.id}
databaseAllows:
- production
# Example: Full configuration with platform metadata credential
creds:
type: dbtcloud:SnowflakePlatformMetadataCredential
properties:
connectionId: ${snowflake.id}
catalogIngestionEnabled: true
authType: password
user: ${snowflakeUser}
password: ${snowflakePassword}
role: ${snowflakeRole}
warehouse: ${snowflakeWarehouse}
withCreds:
type: dbtcloud:ConnectionCatalogConfig
name: with_creds
properties:
connectionId: ${snowflake.id}
databaseAllows:
- analytics
- reporting
databaseDenies:
- sandbox
schemaAllows:
- public
- dbt_*
schemaDenies:
- information_schema
- pg_*
tableDenies:
- _tmp_*
- _staging_*
viewDenies:
- _internal_*
options:
dependsOn:
- ${creds}
Create ConnectionCatalogConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ConnectionCatalogConfig(name: string, args: ConnectionCatalogConfigArgs, opts?: CustomResourceOptions);@overload
def ConnectionCatalogConfig(resource_name: str,
args: ConnectionCatalogConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ConnectionCatalogConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
connection_id: Optional[int] = None,
database_allows: Optional[Sequence[str]] = None,
database_denies: Optional[Sequence[str]] = None,
schema_allows: Optional[Sequence[str]] = None,
schema_denies: Optional[Sequence[str]] = None,
table_allows: Optional[Sequence[str]] = None,
table_denies: Optional[Sequence[str]] = None,
view_allows: Optional[Sequence[str]] = None,
view_denies: Optional[Sequence[str]] = None)func NewConnectionCatalogConfig(ctx *Context, name string, args ConnectionCatalogConfigArgs, opts ...ResourceOption) (*ConnectionCatalogConfig, error)public ConnectionCatalogConfig(string name, ConnectionCatalogConfigArgs args, CustomResourceOptions? opts = null)
public ConnectionCatalogConfig(String name, ConnectionCatalogConfigArgs args)
public ConnectionCatalogConfig(String name, ConnectionCatalogConfigArgs args, CustomResourceOptions options)
type: dbtcloud:ConnectionCatalogConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ConnectionCatalogConfigArgs
- 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 ConnectionCatalogConfigArgs
- 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 ConnectionCatalogConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ConnectionCatalogConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ConnectionCatalogConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var connectionCatalogConfigResource = new DbtCloud.ConnectionCatalogConfig("connectionCatalogConfigResource", new()
{
ConnectionId = 0,
DatabaseAllows = new[]
{
"string",
},
DatabaseDenies = new[]
{
"string",
},
SchemaAllows = new[]
{
"string",
},
SchemaDenies = new[]
{
"string",
},
TableAllows = new[]
{
"string",
},
TableDenies = new[]
{
"string",
},
ViewAllows = new[]
{
"string",
},
ViewDenies = new[]
{
"string",
},
});
example, err := dbtcloud.NewConnectionCatalogConfig(ctx, "connectionCatalogConfigResource", &dbtcloud.ConnectionCatalogConfigArgs{
ConnectionId: pulumi.Int(0),
DatabaseAllows: pulumi.StringArray{
pulumi.String("string"),
},
DatabaseDenies: pulumi.StringArray{
pulumi.String("string"),
},
SchemaAllows: pulumi.StringArray{
pulumi.String("string"),
},
SchemaDenies: pulumi.StringArray{
pulumi.String("string"),
},
TableAllows: pulumi.StringArray{
pulumi.String("string"),
},
TableDenies: pulumi.StringArray{
pulumi.String("string"),
},
ViewAllows: pulumi.StringArray{
pulumi.String("string"),
},
ViewDenies: pulumi.StringArray{
pulumi.String("string"),
},
})
var connectionCatalogConfigResource = new ConnectionCatalogConfig("connectionCatalogConfigResource", ConnectionCatalogConfigArgs.builder()
.connectionId(0)
.databaseAllows("string")
.databaseDenies("string")
.schemaAllows("string")
.schemaDenies("string")
.tableAllows("string")
.tableDenies("string")
.viewAllows("string")
.viewDenies("string")
.build());
connection_catalog_config_resource = dbtcloud.ConnectionCatalogConfig("connectionCatalogConfigResource",
connection_id=0,
database_allows=["string"],
database_denies=["string"],
schema_allows=["string"],
schema_denies=["string"],
table_allows=["string"],
table_denies=["string"],
view_allows=["string"],
view_denies=["string"])
const connectionCatalogConfigResource = new dbtcloud.ConnectionCatalogConfig("connectionCatalogConfigResource", {
connectionId: 0,
databaseAllows: ["string"],
databaseDenies: ["string"],
schemaAllows: ["string"],
schemaDenies: ["string"],
tableAllows: ["string"],
tableDenies: ["string"],
viewAllows: ["string"],
viewDenies: ["string"],
});
type: dbtcloud:ConnectionCatalogConfig
properties:
connectionId: 0
databaseAllows:
- string
databaseDenies:
- string
schemaAllows:
- string
schemaDenies:
- string
tableAllows:
- string
tableDenies:
- string
viewAllows:
- string
viewDenies:
- string
ConnectionCatalogConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ConnectionCatalogConfig resource accepts the following input properties:
- Connection
Id int - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- Database
Allows List<string> - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- Database
Denies List<string> - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- Schema
Allows List<string> - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- Schema
Denies List<string> - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- Table
Allows List<string> - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- Table
Denies List<string> - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- View
Allows List<string> - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- View
Denies List<string> - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
- Connection
Id int - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- Database
Allows []string - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- Database
Denies []string - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- Schema
Allows []string - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- Schema
Denies []string - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- Table
Allows []string - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- Table
Denies []string - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- View
Allows []string - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- View
Denies []string - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
- connection
Id Integer - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- database
Allows List<String> - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- database
Denies List<String> - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- schema
Allows List<String> - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- schema
Denies List<String> - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- table
Allows List<String> - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- table
Denies List<String> - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- view
Allows List<String> - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- view
Denies List<String> - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
- connection
Id number - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- database
Allows string[] - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- database
Denies string[] - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- schema
Allows string[] - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- schema
Denies string[] - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- table
Allows string[] - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- table
Denies string[] - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- view
Allows string[] - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- view
Denies string[] - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
- connection_
id int - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- database_
allows Sequence[str] - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- database_
denies Sequence[str] - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- schema_
allows Sequence[str] - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- schema_
denies Sequence[str] - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- table_
allows Sequence[str] - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- table_
denies Sequence[str] - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- view_
allows Sequence[str] - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- view_
denies Sequence[str] - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
- connection
Id Number - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- database
Allows List<String> - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- database
Denies List<String> - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- schema
Allows List<String> - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- schema
Denies List<String> - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- table
Allows List<String> - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- table
Denies List<String> - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- view
Allows List<String> - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- view
Denies List<String> - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
Outputs
All input properties are implicitly available as output properties. Additionally, the ConnectionCatalogConfig resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing ConnectionCatalogConfig Resource
Get an existing ConnectionCatalogConfig 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?: ConnectionCatalogConfigState, opts?: CustomResourceOptions): ConnectionCatalogConfig@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
connection_id: Optional[int] = None,
database_allows: Optional[Sequence[str]] = None,
database_denies: Optional[Sequence[str]] = None,
schema_allows: Optional[Sequence[str]] = None,
schema_denies: Optional[Sequence[str]] = None,
table_allows: Optional[Sequence[str]] = None,
table_denies: Optional[Sequence[str]] = None,
view_allows: Optional[Sequence[str]] = None,
view_denies: Optional[Sequence[str]] = None) -> ConnectionCatalogConfigfunc GetConnectionCatalogConfig(ctx *Context, name string, id IDInput, state *ConnectionCatalogConfigState, opts ...ResourceOption) (*ConnectionCatalogConfig, error)public static ConnectionCatalogConfig Get(string name, Input<string> id, ConnectionCatalogConfigState? state, CustomResourceOptions? opts = null)public static ConnectionCatalogConfig get(String name, Output<String> id, ConnectionCatalogConfigState state, CustomResourceOptions options)resources: _: type: dbtcloud:ConnectionCatalogConfig get: id: ${id}- 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.
- Connection
Id int - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- Database
Allows List<string> - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- Database
Denies List<string> - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- Schema
Allows List<string> - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- Schema
Denies List<string> - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- Table
Allows List<string> - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- Table
Denies List<string> - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- View
Allows List<string> - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- View
Denies List<string> - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
- Connection
Id int - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- Database
Allows []string - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- Database
Denies []string - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- Schema
Allows []string - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- Schema
Denies []string - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- Table
Allows []string - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- Table
Denies []string - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- View
Allows []string - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- View
Denies []string - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
- connection
Id Integer - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- database
Allows List<String> - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- database
Denies List<String> - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- schema
Allows List<String> - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- schema
Denies List<String> - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- table
Allows List<String> - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- table
Denies List<String> - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- view
Allows List<String> - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- view
Denies List<String> - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
- connection
Id number - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- database
Allows string[] - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- database
Denies string[] - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- schema
Allows string[] - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- schema
Denies string[] - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- table
Allows string[] - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- table
Denies string[] - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- view
Allows string[] - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- view
Denies string[] - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
- connection_
id int - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- database_
allows Sequence[str] - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- database_
denies Sequence[str] - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- schema_
allows Sequence[str] - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- schema_
denies Sequence[str] - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- table_
allows Sequence[str] - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- table_
denies Sequence[str] - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- view_
allows Sequence[str] - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- view_
denies Sequence[str] - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
- connection
Id Number - The ID of the global connection this catalog config is associated with. Cannot be changed after creation.
- database
Allows List<String> - List of database names to include. Supports wildcards (e.g., 'analytics_*'). If set, only these databases are ingested.
- database
Denies List<String> - List of database names to exclude. Supports wildcards (e.g., 'staging_*'). Matching databases are not ingested.
- schema
Allows List<String> - List of schema names to include. Supports wildcards (e.g., 'public_*'). If set, only these schemas are ingested.
- schema
Denies List<String> - List of schema names to exclude. Supports wildcards (e.g., 'temp_*'). Matching schemas are not ingested.
- table
Allows List<String> - List of table names to include. Supports wildcards (e.g., 'fact_*'). If set, only these tables are ingested.
- table
Denies List<String> - List of table names to exclude. Supports wildcards (e.g., 'tmp_*'). Matching tables are not ingested.
- view
Allows List<String> - List of view names to include. Supports wildcards (e.g., 'v_*'). If set, only these views are ingested.
- view
Denies List<String> - List of view names to exclude. Supports wildcards (e.g., 'secret_*'). Matching views are not ingested.
Package Details
- Repository
- dbtcloud pulumi/pulumi-dbtcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
dbtcloudTerraform Provider.
