1. Packages
  2. dbt Cloud Provider
  3. API Docs
  4. Profile
Viewing docs for dbt Cloud v1.6.1
published on Thursday, Feb 26, 2026 by Pulumi
dbtcloud logo
Viewing docs for dbt Cloud v1.6.1
published on Thursday, Feb 26, 2026 by Pulumi

    Manages a dbt Cloud profile. A profile ties together a connection and credentials for use within environments.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as dbtcloud from "@pulumi/dbtcloud";
    
    // A profile ties together a connection and credentials for use within environments.
    const myProfile = new dbtcloud.Profile("my_profile", {
        projectId: myProject.id,
        key: "my-profile",
        connectionId: myConnection.id,
        credentialsId: myCredential.credentialId,
    });
    // A profile with extended attributes
    const myProfileWithAttrs = new dbtcloud.Profile("my_profile_with_attrs", {
        projectId: myProject.id,
        key: "my-profile-with-attrs",
        connectionId: myConnection.id,
        credentialsId: myCredential.credentialId,
        extendedAttributesId: myAttributes.extendedAttributesId,
    });
    
    import pulumi
    import pulumi_dbtcloud as dbtcloud
    
    # A profile ties together a connection and credentials for use within environments.
    my_profile = dbtcloud.Profile("my_profile",
        project_id=my_project["id"],
        key="my-profile",
        connection_id=my_connection["id"],
        credentials_id=my_credential["credentialId"])
    # A profile with extended attributes
    my_profile_with_attrs = dbtcloud.Profile("my_profile_with_attrs",
        project_id=my_project["id"],
        key="my-profile-with-attrs",
        connection_id=my_connection["id"],
        credentials_id=my_credential["credentialId"],
        extended_attributes_id=my_attributes["extendedAttributesId"])
    
    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 {
    		// A profile ties together a connection and credentials for use within environments.
    		_, err := dbtcloud.NewProfile(ctx, "my_profile", &dbtcloud.ProfileArgs{
    			ProjectId:     pulumi.Any(myProject.Id),
    			Key:           pulumi.String("my-profile"),
    			ConnectionId:  pulumi.Any(myConnection.Id),
    			CredentialsId: pulumi.Any(myCredential.CredentialId),
    		})
    		if err != nil {
    			return err
    		}
    		// A profile with extended attributes
    		_, err = dbtcloud.NewProfile(ctx, "my_profile_with_attrs", &dbtcloud.ProfileArgs{
    			ProjectId:            pulumi.Any(myProject.Id),
    			Key:                  pulumi.String("my-profile-with-attrs"),
    			ConnectionId:         pulumi.Any(myConnection.Id),
    			CredentialsId:        pulumi.Any(myCredential.CredentialId),
    			ExtendedAttributesId: pulumi.Any(myAttributes.ExtendedAttributesId),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DbtCloud = Pulumi.DbtCloud;
    
    return await Deployment.RunAsync(() => 
    {
        // A profile ties together a connection and credentials for use within environments.
        var myProfile = new DbtCloud.Profile("my_profile", new()
        {
            ProjectId = myProject.Id,
            Key = "my-profile",
            ConnectionId = myConnection.Id,
            CredentialsId = myCredential.CredentialId,
        });
    
        // A profile with extended attributes
        var myProfileWithAttrs = new DbtCloud.Profile("my_profile_with_attrs", new()
        {
            ProjectId = myProject.Id,
            Key = "my-profile-with-attrs",
            ConnectionId = myConnection.Id,
            CredentialsId = myCredential.CredentialId,
            ExtendedAttributesId = myAttributes.ExtendedAttributesId,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.dbtcloud.Profile;
    import com.pulumi.dbtcloud.ProfileArgs;
    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) {
            // A profile ties together a connection and credentials for use within environments.
            var myProfile = new Profile("myProfile", ProfileArgs.builder()
                .projectId(myProject.id())
                .key("my-profile")
                .connectionId(myConnection.id())
                .credentialsId(myCredential.credentialId())
                .build());
    
            // A profile with extended attributes
            var myProfileWithAttrs = new Profile("myProfileWithAttrs", ProfileArgs.builder()
                .projectId(myProject.id())
                .key("my-profile-with-attrs")
                .connectionId(myConnection.id())
                .credentialsId(myCredential.credentialId())
                .extendedAttributesId(myAttributes.extendedAttributesId())
                .build());
    
        }
    }
    
    resources:
      # A profile ties together a connection and credentials for use within environments.
      myProfile:
        type: dbtcloud:Profile
        name: my_profile
        properties:
          projectId: ${myProject.id}
          key: my-profile
          connectionId: ${myConnection.id}
          credentialsId: ${myCredential.credentialId}
      # A profile with extended attributes
      myProfileWithAttrs:
        type: dbtcloud:Profile
        name: my_profile_with_attrs
        properties:
          projectId: ${myProject.id}
          key: my-profile-with-attrs
          connectionId: ${myConnection.id}
          credentialsId: ${myCredential.credentialId}
          extendedAttributesId: ${myAttributes.extendedAttributesId}
    

    Create Profile Resource

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

    Constructor syntax

    new Profile(name: string, args: ProfileArgs, opts?: CustomResourceOptions);
    @overload
    def Profile(resource_name: str,
                args: ProfileArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Profile(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                connection_id: Optional[int] = None,
                credentials_id: Optional[int] = None,
                key: Optional[str] = None,
                project_id: Optional[int] = None,
                extended_attributes_id: Optional[int] = None)
    func NewProfile(ctx *Context, name string, args ProfileArgs, opts ...ResourceOption) (*Profile, error)
    public Profile(string name, ProfileArgs args, CustomResourceOptions? opts = null)
    public Profile(String name, ProfileArgs args)
    public Profile(String name, ProfileArgs args, CustomResourceOptions options)
    
    type: dbtcloud:Profile
    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 ProfileArgs
    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 ProfileArgs
    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 ProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProfileArgs
    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 profileResource = new DbtCloud.Profile("profileResource", new()
    {
        ConnectionId = 0,
        CredentialsId = 0,
        Key = "string",
        ProjectId = 0,
        ExtendedAttributesId = 0,
    });
    
    example, err := dbtcloud.NewProfile(ctx, "profileResource", &dbtcloud.ProfileArgs{
    	ConnectionId:         pulumi.Int(0),
    	CredentialsId:        pulumi.Int(0),
    	Key:                  pulumi.String("string"),
    	ProjectId:            pulumi.Int(0),
    	ExtendedAttributesId: pulumi.Int(0),
    })
    
    var profileResource = new Profile("profileResource", ProfileArgs.builder()
        .connectionId(0)
        .credentialsId(0)
        .key("string")
        .projectId(0)
        .extendedAttributesId(0)
        .build());
    
    profile_resource = dbtcloud.Profile("profileResource",
        connection_id=0,
        credentials_id=0,
        key="string",
        project_id=0,
        extended_attributes_id=0)
    
    const profileResource = new dbtcloud.Profile("profileResource", {
        connectionId: 0,
        credentialsId: 0,
        key: "string",
        projectId: 0,
        extendedAttributesId: 0,
    });
    
    type: dbtcloud:Profile
    properties:
        connectionId: 0
        credentialsId: 0
        extendedAttributesId: 0
        key: string
        projectId: 0
    

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

    ConnectionId int
    The ID of the connection to use for this profile
    CredentialsId int
    The ID of the credentials to use for this profile
    Key string
    Unique identifier for the profile
    ProjectId int
    The ID of the project in which to create the profile
    ExtendedAttributesId int
    The ID of the extended attributes for this profile. Set to null to unset.
    ConnectionId int
    The ID of the connection to use for this profile
    CredentialsId int
    The ID of the credentials to use for this profile
    Key string
    Unique identifier for the profile
    ProjectId int
    The ID of the project in which to create the profile
    ExtendedAttributesId int
    The ID of the extended attributes for this profile. Set to null to unset.
    connectionId Integer
    The ID of the connection to use for this profile
    credentialsId Integer
    The ID of the credentials to use for this profile
    key String
    Unique identifier for the profile
    projectId Integer
    The ID of the project in which to create the profile
    extendedAttributesId Integer
    The ID of the extended attributes for this profile. Set to null to unset.
    connectionId number
    The ID of the connection to use for this profile
    credentialsId number
    The ID of the credentials to use for this profile
    key string
    Unique identifier for the profile
    projectId number
    The ID of the project in which to create the profile
    extendedAttributesId number
    The ID of the extended attributes for this profile. Set to null to unset.
    connection_id int
    The ID of the connection to use for this profile
    credentials_id int
    The ID of the credentials to use for this profile
    key str
    Unique identifier for the profile
    project_id int
    The ID of the project in which to create the profile
    extended_attributes_id int
    The ID of the extended attributes for this profile. Set to null to unset.
    connectionId Number
    The ID of the connection to use for this profile
    credentialsId Number
    The ID of the credentials to use for this profile
    key String
    Unique identifier for the profile
    projectId Number
    The ID of the project in which to create the profile
    extendedAttributesId Number
    The ID of the extended attributes for this profile. Set to null to unset.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Profile resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ProfileId int
    The ID of the profile
    Id string
    The provider-assigned unique ID for this managed resource.
    ProfileId int
    The ID of the profile
    id String
    The provider-assigned unique ID for this managed resource.
    profileId Integer
    The ID of the profile
    id string
    The provider-assigned unique ID for this managed resource.
    profileId number
    The ID of the profile
    id str
    The provider-assigned unique ID for this managed resource.
    profile_id int
    The ID of the profile
    id String
    The provider-assigned unique ID for this managed resource.
    profileId Number
    The ID of the profile

    Look up Existing Profile Resource

    Get an existing Profile 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?: ProfileState, opts?: CustomResourceOptions): Profile
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            connection_id: Optional[int] = None,
            credentials_id: Optional[int] = None,
            extended_attributes_id: Optional[int] = None,
            key: Optional[str] = None,
            profile_id: Optional[int] = None,
            project_id: Optional[int] = None) -> Profile
    func GetProfile(ctx *Context, name string, id IDInput, state *ProfileState, opts ...ResourceOption) (*Profile, error)
    public static Profile Get(string name, Input<string> id, ProfileState? state, CustomResourceOptions? opts = null)
    public static Profile get(String name, Output<String> id, ProfileState state, CustomResourceOptions options)
    resources:  _:    type: dbtcloud:Profile    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:
    ConnectionId int
    The ID of the connection to use for this profile
    CredentialsId int
    The ID of the credentials to use for this profile
    ExtendedAttributesId int
    The ID of the extended attributes for this profile. Set to null to unset.
    Key string
    Unique identifier for the profile
    ProfileId int
    The ID of the profile
    ProjectId int
    The ID of the project in which to create the profile
    ConnectionId int
    The ID of the connection to use for this profile
    CredentialsId int
    The ID of the credentials to use for this profile
    ExtendedAttributesId int
    The ID of the extended attributes for this profile. Set to null to unset.
    Key string
    Unique identifier for the profile
    ProfileId int
    The ID of the profile
    ProjectId int
    The ID of the project in which to create the profile
    connectionId Integer
    The ID of the connection to use for this profile
    credentialsId Integer
    The ID of the credentials to use for this profile
    extendedAttributesId Integer
    The ID of the extended attributes for this profile. Set to null to unset.
    key String
    Unique identifier for the profile
    profileId Integer
    The ID of the profile
    projectId Integer
    The ID of the project in which to create the profile
    connectionId number
    The ID of the connection to use for this profile
    credentialsId number
    The ID of the credentials to use for this profile
    extendedAttributesId number
    The ID of the extended attributes for this profile. Set to null to unset.
    key string
    Unique identifier for the profile
    profileId number
    The ID of the profile
    projectId number
    The ID of the project in which to create the profile
    connection_id int
    The ID of the connection to use for this profile
    credentials_id int
    The ID of the credentials to use for this profile
    extended_attributes_id int
    The ID of the extended attributes for this profile. Set to null to unset.
    key str
    Unique identifier for the profile
    profile_id int
    The ID of the profile
    project_id int
    The ID of the project in which to create the profile
    connectionId Number
    The ID of the connection to use for this profile
    credentialsId Number
    The ID of the credentials to use for this profile
    extendedAttributesId Number
    The ID of the extended attributes for this profile. Set to null to unset.
    key String
    Unique identifier for the profile
    profileId Number
    The ID of the profile
    projectId Number
    The ID of the project in which to create the profile

    Import

    using import blocks (requires Terraform >= 1.5) import { to = dbtcloud_profile.my_profile id = “project_id:profile_id” }

    import { to = dbtcloud_profile.my_profile id = “12345:6789” }

    using the older import command

    $ pulumi import dbtcloud:index/profile:Profile my_profile "project_id:profile_id"
    $ pulumi import dbtcloud:index/profile:Profile my_profile 12345:6789
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    dbtcloud pulumi/pulumi-dbtcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dbtcloud Terraform Provider.
    dbtcloud logo
    Viewing docs for dbt Cloud v1.6.1
    published on Thursday, Feb 26, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.