1. Packages
  2. dbt Cloud Provider
  3. API Docs
  4. BigquerySemanticLayerCredential
dbt Cloud v1.0.0 published on Wednesday, Jun 11, 2025 by Pulumi

dbtcloud.BigquerySemanticLayerCredential

Explore with Pulumi AI

dbtcloud logo
dbt Cloud v1.0.0 published on Wednesday, Jun 11, 2025 by Pulumi

    BigQuery credential resource. This resource is composed of a BigQuery credential and a Semantic Layer configuration. It is used to create a BigQuery credential for the Semantic Layer.

    Create BigquerySemanticLayerCredential Resource

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

    Constructor syntax

    new BigquerySemanticLayerCredential(name: string, args: BigquerySemanticLayerCredentialArgs, opts?: CustomResourceOptions);
    @overload
    def BigquerySemanticLayerCredential(resource_name: str,
                                        args: BigquerySemanticLayerCredentialArgs,
                                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def BigquerySemanticLayerCredential(resource_name: str,
                                        opts: Optional[ResourceOptions] = None,
                                        auth_provider_x509_cert_url: Optional[str] = None,
                                        auth_uri: Optional[str] = None,
                                        client_email: Optional[str] = None,
                                        client_id: Optional[str] = None,
                                        client_x509_cert_url: Optional[str] = None,
                                        configuration: Optional[BigquerySemanticLayerCredentialConfigurationArgs] = None,
                                        credential: Optional[BigquerySemanticLayerCredentialCredentialArgs] = None,
                                        private_key: Optional[str] = None,
                                        private_key_id: Optional[str] = None,
                                        token_uri: Optional[str] = None)
    func NewBigquerySemanticLayerCredential(ctx *Context, name string, args BigquerySemanticLayerCredentialArgs, opts ...ResourceOption) (*BigquerySemanticLayerCredential, error)
    public BigquerySemanticLayerCredential(string name, BigquerySemanticLayerCredentialArgs args, CustomResourceOptions? opts = null)
    public BigquerySemanticLayerCredential(String name, BigquerySemanticLayerCredentialArgs args)
    public BigquerySemanticLayerCredential(String name, BigquerySemanticLayerCredentialArgs args, CustomResourceOptions options)
    
    type: dbtcloud:BigquerySemanticLayerCredential
    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 BigquerySemanticLayerCredentialArgs
    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 BigquerySemanticLayerCredentialArgs
    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 BigquerySemanticLayerCredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BigquerySemanticLayerCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BigquerySemanticLayerCredentialArgs
    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 bigquerySemanticLayerCredentialResource = new DbtCloud.BigquerySemanticLayerCredential("bigquerySemanticLayerCredentialResource", new()
    {
        AuthProviderX509CertUrl = "string",
        AuthUri = "string",
        ClientEmail = "string",
        ClientId = "string",
        ClientX509CertUrl = "string",
        Configuration = new DbtCloud.Inputs.BigquerySemanticLayerCredentialConfigurationArgs
        {
            AdapterVersion = "string",
            Name = "string",
            ProjectId = 0,
        },
        Credential = new DbtCloud.Inputs.BigquerySemanticLayerCredentialCredentialArgs
        {
            Dataset = "string",
            NumThreads = 0,
            ProjectId = 0,
            CredentialId = 0,
            Id = "string",
            IsActive = false,
        },
        PrivateKey = "string",
        PrivateKeyId = "string",
        TokenUri = "string",
    });
    
    example, err := dbtcloud.NewBigquerySemanticLayerCredential(ctx, "bigquerySemanticLayerCredentialResource", &dbtcloud.BigquerySemanticLayerCredentialArgs{
    	AuthProviderX509CertUrl: pulumi.String("string"),
    	AuthUri:                 pulumi.String("string"),
    	ClientEmail:             pulumi.String("string"),
    	ClientId:                pulumi.String("string"),
    	ClientX509CertUrl:       pulumi.String("string"),
    	Configuration: &dbtcloud.BigquerySemanticLayerCredentialConfigurationArgs{
    		AdapterVersion: pulumi.String("string"),
    		Name:           pulumi.String("string"),
    		ProjectId:      pulumi.Int(0),
    	},
    	Credential: &dbtcloud.BigquerySemanticLayerCredentialCredentialArgs{
    		Dataset:      pulumi.String("string"),
    		NumThreads:   pulumi.Int(0),
    		ProjectId:    pulumi.Int(0),
    		CredentialId: pulumi.Int(0),
    		Id:           pulumi.String("string"),
    		IsActive:     pulumi.Bool(false),
    	},
    	PrivateKey:   pulumi.String("string"),
    	PrivateKeyId: pulumi.String("string"),
    	TokenUri:     pulumi.String("string"),
    })
    
    var bigquerySemanticLayerCredentialResource = new BigquerySemanticLayerCredential("bigquerySemanticLayerCredentialResource", BigquerySemanticLayerCredentialArgs.builder()
        .authProviderX509CertUrl("string")
        .authUri("string")
        .clientEmail("string")
        .clientId("string")
        .clientX509CertUrl("string")
        .configuration(BigquerySemanticLayerCredentialConfigurationArgs.builder()
            .adapterVersion("string")
            .name("string")
            .projectId(0)
            .build())
        .credential(BigquerySemanticLayerCredentialCredentialArgs.builder()
            .dataset("string")
            .numThreads(0)
            .projectId(0)
            .credentialId(0)
            .id("string")
            .isActive(false)
            .build())
        .privateKey("string")
        .privateKeyId("string")
        .tokenUri("string")
        .build());
    
    bigquery_semantic_layer_credential_resource = dbtcloud.BigquerySemanticLayerCredential("bigquerySemanticLayerCredentialResource",
        auth_provider_x509_cert_url="string",
        auth_uri="string",
        client_email="string",
        client_id="string",
        client_x509_cert_url="string",
        configuration={
            "adapter_version": "string",
            "name": "string",
            "project_id": 0,
        },
        credential={
            "dataset": "string",
            "num_threads": 0,
            "project_id": 0,
            "credential_id": 0,
            "id": "string",
            "is_active": False,
        },
        private_key="string",
        private_key_id="string",
        token_uri="string")
    
    const bigquerySemanticLayerCredentialResource = new dbtcloud.BigquerySemanticLayerCredential("bigquerySemanticLayerCredentialResource", {
        authProviderX509CertUrl: "string",
        authUri: "string",
        clientEmail: "string",
        clientId: "string",
        clientX509CertUrl: "string",
        configuration: {
            adapterVersion: "string",
            name: "string",
            projectId: 0,
        },
        credential: {
            dataset: "string",
            numThreads: 0,
            projectId: 0,
            credentialId: 0,
            id: "string",
            isActive: false,
        },
        privateKey: "string",
        privateKeyId: "string",
        tokenUri: "string",
    });
    
    type: dbtcloud:BigquerySemanticLayerCredential
    properties:
        authProviderX509CertUrl: string
        authUri: string
        clientEmail: string
        clientId: string
        clientX509CertUrl: string
        configuration:
            adapterVersion: string
            name: string
            projectId: 0
        credential:
            credentialId: 0
            dataset: string
            id: string
            isActive: false
            numThreads: 0
            projectId: 0
        privateKey: string
        privateKeyId: string
        tokenUri: string
    

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

    AuthProviderX509CertUrl string
    Auth Provider X509 Cert URL for the Service Account
    AuthUri string
    Auth URI for the Service Account
    ClientEmail string
    Service Account email
    ClientId string
    Client ID of the Service Account
    ClientX509CertUrl string
    Client X509 Cert URL for the Service Account
    Configuration Pulumi.DbtCloud.Inputs.BigquerySemanticLayerCredentialConfiguration
    Semantic Layer credential configuration details.
    Credential Pulumi.DbtCloud.Inputs.BigquerySemanticLayerCredentialCredential
    BigQuery credential details, but used in the context of the Semantic Layer.
    PrivateKey string
    Private Key for the Service Account
    PrivateKeyId string
    Private Key ID for the Service Account
    TokenUri string
    Token URI for the Service Account
    AuthProviderX509CertUrl string
    Auth Provider X509 Cert URL for the Service Account
    AuthUri string
    Auth URI for the Service Account
    ClientEmail string
    Service Account email
    ClientId string
    Client ID of the Service Account
    ClientX509CertUrl string
    Client X509 Cert URL for the Service Account
    Configuration BigquerySemanticLayerCredentialConfigurationArgs
    Semantic Layer credential configuration details.
    Credential BigquerySemanticLayerCredentialCredentialArgs
    BigQuery credential details, but used in the context of the Semantic Layer.
    PrivateKey string
    Private Key for the Service Account
    PrivateKeyId string
    Private Key ID for the Service Account
    TokenUri string
    Token URI for the Service Account
    authProviderX509CertUrl String
    Auth Provider X509 Cert URL for the Service Account
    authUri String
    Auth URI for the Service Account
    clientEmail String
    Service Account email
    clientId String
    Client ID of the Service Account
    clientX509CertUrl String
    Client X509 Cert URL for the Service Account
    configuration BigquerySemanticLayerCredentialConfiguration
    Semantic Layer credential configuration details.
    credential BigquerySemanticLayerCredentialCredential
    BigQuery credential details, but used in the context of the Semantic Layer.
    privateKey String
    Private Key for the Service Account
    privateKeyId String
    Private Key ID for the Service Account
    tokenUri String
    Token URI for the Service Account
    authProviderX509CertUrl string
    Auth Provider X509 Cert URL for the Service Account
    authUri string
    Auth URI for the Service Account
    clientEmail string
    Service Account email
    clientId string
    Client ID of the Service Account
    clientX509CertUrl string
    Client X509 Cert URL for the Service Account
    configuration BigquerySemanticLayerCredentialConfiguration
    Semantic Layer credential configuration details.
    credential BigquerySemanticLayerCredentialCredential
    BigQuery credential details, but used in the context of the Semantic Layer.
    privateKey string
    Private Key for the Service Account
    privateKeyId string
    Private Key ID for the Service Account
    tokenUri string
    Token URI for the Service Account
    auth_provider_x509_cert_url str
    Auth Provider X509 Cert URL for the Service Account
    auth_uri str
    Auth URI for the Service Account
    client_email str
    Service Account email
    client_id str
    Client ID of the Service Account
    client_x509_cert_url str
    Client X509 Cert URL for the Service Account
    configuration BigquerySemanticLayerCredentialConfigurationArgs
    Semantic Layer credential configuration details.
    credential BigquerySemanticLayerCredentialCredentialArgs
    BigQuery credential details, but used in the context of the Semantic Layer.
    private_key str
    Private Key for the Service Account
    private_key_id str
    Private Key ID for the Service Account
    token_uri str
    Token URI for the Service Account
    authProviderX509CertUrl String
    Auth Provider X509 Cert URL for the Service Account
    authUri String
    Auth URI for the Service Account
    clientEmail String
    Service Account email
    clientId String
    Client ID of the Service Account
    clientX509CertUrl String
    Client X509 Cert URL for the Service Account
    configuration Property Map
    Semantic Layer credential configuration details.
    credential Property Map
    BigQuery credential details, but used in the context of the Semantic Layer.
    privateKey String
    Private Key for the Service Account
    privateKeyId String
    Private Key ID for the Service Account
    tokenUri String
    Token URI for the Service Account

    Outputs

    All input properties are implicitly available as output properties. Additionally, the BigquerySemanticLayerCredential 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 BigquerySemanticLayerCredential Resource

    Get an existing BigquerySemanticLayerCredential 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?: BigquerySemanticLayerCredentialState, opts?: CustomResourceOptions): BigquerySemanticLayerCredential
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auth_provider_x509_cert_url: Optional[str] = None,
            auth_uri: Optional[str] = None,
            client_email: Optional[str] = None,
            client_id: Optional[str] = None,
            client_x509_cert_url: Optional[str] = None,
            configuration: Optional[BigquerySemanticLayerCredentialConfigurationArgs] = None,
            credential: Optional[BigquerySemanticLayerCredentialCredentialArgs] = None,
            private_key: Optional[str] = None,
            private_key_id: Optional[str] = None,
            token_uri: Optional[str] = None) -> BigquerySemanticLayerCredential
    func GetBigquerySemanticLayerCredential(ctx *Context, name string, id IDInput, state *BigquerySemanticLayerCredentialState, opts ...ResourceOption) (*BigquerySemanticLayerCredential, error)
    public static BigquerySemanticLayerCredential Get(string name, Input<string> id, BigquerySemanticLayerCredentialState? state, CustomResourceOptions? opts = null)
    public static BigquerySemanticLayerCredential get(String name, Output<String> id, BigquerySemanticLayerCredentialState state, CustomResourceOptions options)
    resources:  _:    type: dbtcloud:BigquerySemanticLayerCredential    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.
    The following state arguments are supported:
    AuthProviderX509CertUrl string
    Auth Provider X509 Cert URL for the Service Account
    AuthUri string
    Auth URI for the Service Account
    ClientEmail string
    Service Account email
    ClientId string
    Client ID of the Service Account
    ClientX509CertUrl string
    Client X509 Cert URL for the Service Account
    Configuration Pulumi.DbtCloud.Inputs.BigquerySemanticLayerCredentialConfiguration
    Semantic Layer credential configuration details.
    Credential Pulumi.DbtCloud.Inputs.BigquerySemanticLayerCredentialCredential
    BigQuery credential details, but used in the context of the Semantic Layer.
    PrivateKey string
    Private Key for the Service Account
    PrivateKeyId string
    Private Key ID for the Service Account
    TokenUri string
    Token URI for the Service Account
    AuthProviderX509CertUrl string
    Auth Provider X509 Cert URL for the Service Account
    AuthUri string
    Auth URI for the Service Account
    ClientEmail string
    Service Account email
    ClientId string
    Client ID of the Service Account
    ClientX509CertUrl string
    Client X509 Cert URL for the Service Account
    Configuration BigquerySemanticLayerCredentialConfigurationArgs
    Semantic Layer credential configuration details.
    Credential BigquerySemanticLayerCredentialCredentialArgs
    BigQuery credential details, but used in the context of the Semantic Layer.
    PrivateKey string
    Private Key for the Service Account
    PrivateKeyId string
    Private Key ID for the Service Account
    TokenUri string
    Token URI for the Service Account
    authProviderX509CertUrl String
    Auth Provider X509 Cert URL for the Service Account
    authUri String
    Auth URI for the Service Account
    clientEmail String
    Service Account email
    clientId String
    Client ID of the Service Account
    clientX509CertUrl String
    Client X509 Cert URL for the Service Account
    configuration BigquerySemanticLayerCredentialConfiguration
    Semantic Layer credential configuration details.
    credential BigquerySemanticLayerCredentialCredential
    BigQuery credential details, but used in the context of the Semantic Layer.
    privateKey String
    Private Key for the Service Account
    privateKeyId String
    Private Key ID for the Service Account
    tokenUri String
    Token URI for the Service Account
    authProviderX509CertUrl string
    Auth Provider X509 Cert URL for the Service Account
    authUri string
    Auth URI for the Service Account
    clientEmail string
    Service Account email
    clientId string
    Client ID of the Service Account
    clientX509CertUrl string
    Client X509 Cert URL for the Service Account
    configuration BigquerySemanticLayerCredentialConfiguration
    Semantic Layer credential configuration details.
    credential BigquerySemanticLayerCredentialCredential
    BigQuery credential details, but used in the context of the Semantic Layer.
    privateKey string
    Private Key for the Service Account
    privateKeyId string
    Private Key ID for the Service Account
    tokenUri string
    Token URI for the Service Account
    auth_provider_x509_cert_url str
    Auth Provider X509 Cert URL for the Service Account
    auth_uri str
    Auth URI for the Service Account
    client_email str
    Service Account email
    client_id str
    Client ID of the Service Account
    client_x509_cert_url str
    Client X509 Cert URL for the Service Account
    configuration BigquerySemanticLayerCredentialConfigurationArgs
    Semantic Layer credential configuration details.
    credential BigquerySemanticLayerCredentialCredentialArgs
    BigQuery credential details, but used in the context of the Semantic Layer.
    private_key str
    Private Key for the Service Account
    private_key_id str
    Private Key ID for the Service Account
    token_uri str
    Token URI for the Service Account
    authProviderX509CertUrl String
    Auth Provider X509 Cert URL for the Service Account
    authUri String
    Auth URI for the Service Account
    clientEmail String
    Service Account email
    clientId String
    Client ID of the Service Account
    clientX509CertUrl String
    Client X509 Cert URL for the Service Account
    configuration Property Map
    Semantic Layer credential configuration details.
    credential Property Map
    BigQuery credential details, but used in the context of the Semantic Layer.
    privateKey String
    Private Key for the Service Account
    privateKeyId String
    Private Key ID for the Service Account
    tokenUri String
    Token URI for the Service Account

    Supporting Types

    BigquerySemanticLayerCredentialConfiguration, BigquerySemanticLayerCredentialConfigurationArgs

    AdapterVersion string
    The adapter version
    Name string
    The name of the configuration
    ProjectId int
    The ID of the project
    AdapterVersion string
    The adapter version
    Name string
    The name of the configuration
    ProjectId int
    The ID of the project
    adapterVersion String
    The adapter version
    name String
    The name of the configuration
    projectId Integer
    The ID of the project
    adapterVersion string
    The adapter version
    name string
    The name of the configuration
    projectId number
    The ID of the project
    adapter_version str
    The adapter version
    name str
    The name of the configuration
    project_id int
    The ID of the project
    adapterVersion String
    The adapter version
    name String
    The name of the configuration
    projectId Number
    The ID of the project

    BigquerySemanticLayerCredentialCredential, BigquerySemanticLayerCredentialCredentialArgs

    Dataset string
    Default dataset name
    NumThreads int
    Number of threads to use
    ProjectId int
    Project ID to create the BigQuery credential in
    CredentialId int
    The internal credential ID
    Id string
    The ID of this resource. Contains the project ID and the credential ID.
    IsActive bool
    Whether the BigQuery credential is active
    Dataset string
    Default dataset name
    NumThreads int
    Number of threads to use
    ProjectId int
    Project ID to create the BigQuery credential in
    CredentialId int
    The internal credential ID
    Id string
    The ID of this resource. Contains the project ID and the credential ID.
    IsActive bool
    Whether the BigQuery credential is active
    dataset String
    Default dataset name
    numThreads Integer
    Number of threads to use
    projectId Integer
    Project ID to create the BigQuery credential in
    credentialId Integer
    The internal credential ID
    id String
    The ID of this resource. Contains the project ID and the credential ID.
    isActive Boolean
    Whether the BigQuery credential is active
    dataset string
    Default dataset name
    numThreads number
    Number of threads to use
    projectId number
    Project ID to create the BigQuery credential in
    credentialId number
    The internal credential ID
    id string
    The ID of this resource. Contains the project ID and the credential ID.
    isActive boolean
    Whether the BigQuery credential is active
    dataset str
    Default dataset name
    num_threads int
    Number of threads to use
    project_id int
    Project ID to create the BigQuery credential in
    credential_id int
    The internal credential ID
    id str
    The ID of this resource. Contains the project ID and the credential ID.
    is_active bool
    Whether the BigQuery credential is active
    dataset String
    Default dataset name
    numThreads Number
    Number of threads to use
    projectId Number
    Project ID to create the BigQuery credential in
    credentialId Number
    The internal credential ID
    id String
    The ID of this resource. Contains the project ID and the credential ID.
    isActive Boolean
    Whether the BigQuery credential is active

    Package Details

    Repository
    dbtcloud pulumi/pulumi-dbtcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dbtcloud Terraform Provider.
    dbtcloud logo
    dbt Cloud v1.0.0 published on Wednesday, Jun 11, 2025 by Pulumi