Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Dbtcloud Provider
  3. API Docs
  4. DatabricksCredential
dbt Cloud v0.1.25 published on Friday, Nov 8, 2024 by Pulumi
pulumi/pulumi-dbtcloud

dbtcloud.DatabricksCredential

Explore with Pulumi AI

dbtcloud logo
dbt Cloud v0.1.25 published on Friday, Nov 8, 2024 by Pulumi
pulumi/pulumi-dbtcloud

    Example Usage

    Create DatabricksCredential Resource

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

    Constructor syntax

    new DatabricksCredential(name: string, args: DatabricksCredentialArgs, opts?: CustomResourceOptions);
    @overload
def DatabricksCredential(resource_name: str,
                         args: DatabricksCredentialArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def DatabricksCredential(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         adapter_type: Optional[str] = None,
                         project_id: Optional[int] = None,
                         schema: Optional[str] = None,
                         token: Optional[str] = None,
                         adapter_id: Optional[int] = None,
                         catalog: Optional[str] = None,
                         target_name: Optional[str] = None)
    func NewDatabricksCredential(ctx *Context, name string, args DatabricksCredentialArgs, opts ...ResourceOption) (*DatabricksCredential, error)
    public DatabricksCredential(string name, DatabricksCredentialArgs args, CustomResourceOptions? opts = null)
    public DatabricksCredential(String name, DatabricksCredentialArgs args)
public DatabricksCredential(String name, DatabricksCredentialArgs args, CustomResourceOptions options)

    type: dbtcloud:DatabricksCredential
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 DatabricksCredentialArgs
    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 DatabricksCredentialArgs
    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 DatabricksCredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabricksCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabricksCredentialArgs
    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 databricksCredentialResource = new DbtCloud.DatabricksCredential("databricksCredentialResource", new()
{
    AdapterType = "string",
    ProjectId = 0,
    Schema = "string",
    Token = "string",
    AdapterId = 0,
    Catalog = "string",
});

    example, err := dbtcloud.NewDatabricksCredential(ctx, "databricksCredentialResource", &dbtcloud.DatabricksCredentialArgs{
	AdapterType: pulumi.String("string"),
	ProjectId:   pulumi.Int(0),
	Schema:      pulumi.String("string"),
	Token:       pulumi.String("string"),
	AdapterId:   pulumi.Int(0),
	Catalog:     pulumi.String("string"),
})

    var databricksCredentialResource = new DatabricksCredential("databricksCredentialResource", DatabricksCredentialArgs.builder()
    .adapterType("string")
    .projectId(0)
    .schema("string")
    .token("string")
    .adapterId(0)
    .catalog("string")
    .build());

    databricks_credential_resource = dbtcloud.DatabricksCredential("databricksCredentialResource",
    adapter_type="string",
    project_id=0,
    schema="string",
    token="string",
    adapter_id=0,
    catalog="string")

    const databricksCredentialResource = new dbtcloud.DatabricksCredential("databricksCredentialResource", {
    adapterType: "string",
    projectId: 0,
    schema: "string",
    token: "string",
    adapterId: 0,
    catalog: "string",
});

    type: dbtcloud:DatabricksCredential
properties:
    adapterId: 0
    adapterType: string
    catalog: string
    projectId: 0
    schema: string
    token: string

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

    AdapterType string
    The type of the adapter (databricks or spark)
    ProjectId int
    Project ID to create the Databricks credential in
    Schema string
    The schema where to create models
    Token string
    Token for Databricks user
    AdapterId int
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    Catalog string
    The catalog where to create models (only for the databricks adapter)
    TargetName string
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    AdapterType string
    The type of the adapter (databricks or spark)
    ProjectId int
    Project ID to create the Databricks credential in
    Schema string
    The schema where to create models
    Token string
    Token for Databricks user
    AdapterId int
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    Catalog string
    The catalog where to create models (only for the databricks adapter)
    TargetName string
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    adapterType String
    The type of the adapter (databricks or spark)
    projectId Integer
    Project ID to create the Databricks credential in
    schema String
    The schema where to create models
    token String
    Token for Databricks user
    adapterId Integer
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    catalog String
    The catalog where to create models (only for the databricks adapter)
    targetName String
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    adapterType string
    The type of the adapter (databricks or spark)
    projectId number
    Project ID to create the Databricks credential in
    schema string
    The schema where to create models
    token string
    Token for Databricks user
    adapterId number
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    catalog string
    The catalog where to create models (only for the databricks adapter)
    targetName string
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    adapter_type str
    The type of the adapter (databricks or spark)
    project_id int
    Project ID to create the Databricks credential in
    schema str
    The schema where to create models
    token str
    Token for Databricks user
    adapter_id int
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    catalog str
    The catalog where to create models (only for the databricks adapter)
    target_name str
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    adapterType String
    The type of the adapter (databricks or spark)
    projectId Number
    Project ID to create the Databricks credential in
    schema String
    The schema where to create models
    token String
    Token for Databricks user
    adapterId Number
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    catalog String
    The catalog where to create models (only for the databricks adapter)
    targetName String
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    Outputs

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

    CredentialId int
    The system Databricks credential ID
    Id string
    The provider-assigned unique ID for this managed resource.
    CredentialId int
    The system Databricks credential ID
    Id string
    The provider-assigned unique ID for this managed resource.
    credentialId Integer
    The system Databricks credential ID
    id String
    The provider-assigned unique ID for this managed resource.
    credentialId number
    The system Databricks credential ID
    id string
    The provider-assigned unique ID for this managed resource.
    credential_id int
    The system Databricks credential ID
    id str
    The provider-assigned unique ID for this managed resource.
    credentialId Number
    The system Databricks credential ID
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DatabricksCredential Resource

    Get an existing DatabricksCredential 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?: DatabricksCredentialState, opts?: CustomResourceOptions): DatabricksCredential
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adapter_id: Optional[int] = None,
        adapter_type: Optional[str] = None,
        catalog: Optional[str] = None,
        credential_id: Optional[int] = None,
        project_id: Optional[int] = None,
        schema: Optional[str] = None,
        target_name: Optional[str] = None,
        token: Optional[str] = None) -> DatabricksCredential
    func GetDatabricksCredential(ctx *Context, name string, id IDInput, state *DatabricksCredentialState, opts ...ResourceOption) (*DatabricksCredential, error)
    public static DatabricksCredential Get(string name, Input<string> id, DatabricksCredentialState? state, CustomResourceOptions? opts = null)
    public static DatabricksCredential get(String name, Output<String> id, DatabricksCredentialState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AdapterId int
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    AdapterType string
    The type of the adapter (databricks or spark)
    Catalog string
    The catalog where to create models (only for the databricks adapter)
    CredentialId int
    The system Databricks credential ID
    ProjectId int
    Project ID to create the Databricks credential in
    Schema string
    The schema where to create models
    TargetName string
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    Token string
    Token for Databricks user
    AdapterId int
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    AdapterType string
    The type of the adapter (databricks or spark)
    Catalog string
    The catalog where to create models (only for the databricks adapter)
    CredentialId int
    The system Databricks credential ID
    ProjectId int
    Project ID to create the Databricks credential in
    Schema string
    The schema where to create models
    TargetName string
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    Token string
    Token for Databricks user
    adapterId Integer
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    adapterType String
    The type of the adapter (databricks or spark)
    catalog String
    The catalog where to create models (only for the databricks adapter)
    credentialId Integer
    The system Databricks credential ID
    projectId Integer
    Project ID to create the Databricks credential in
    schema String
    The schema where to create models
    targetName String
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    token String
    Token for Databricks user
    adapterId number
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    adapterType string
    The type of the adapter (databricks or spark)
    catalog string
    The catalog where to create models (only for the databricks adapter)
    credentialId number
    The system Databricks credential ID
    projectId number
    Project ID to create the Databricks credential in
    schema string
    The schema where to create models
    targetName string
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    token string
    Token for Databricks user
    adapter_id int
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    adapter_type str
    The type of the adapter (databricks or spark)
    catalog str
    The catalog where to create models (only for the databricks adapter)
    credential_id int
    The system Databricks credential ID
    project_id int
    Project ID to create the Databricks credential in
    schema str
    The schema where to create models
    target_name str
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    token str
    Token for Databricks user
    adapterId Number
    Databricks adapter ID for the credential (do not fill in when using global connections, only to be used for connections created with the legacy connection resource dbtcloud.Connection)
    adapterType String
    The type of the adapter (databricks or spark)
    catalog String
    The catalog where to create models (only for the databricks adapter)
    credentialId Number
    The system Databricks credential ID
    projectId Number
    Project ID to create the Databricks credential in
    schema String
    The schema where to create models
    targetName String
    Target name

    Deprecated: This field is deprecated at the environment level (it was never possible to set it in the UI) and will be removed in a future release. Please remove it and set the target name at the job level or leverage environment variables.

    token String
    Token for Databricks user

    Import

    using import blocks (requires Terraform >= 1.5)

    import {

    to = dbtcloud_databricks_credential.my_databricks_credential

    id = “project_id:credential_id”

    }

    import {

    to = dbtcloud_databricks_credential.my_databricks_credential

    id = “12345:6789”

    }

    using the older import command

    $ pulumi import dbtcloud:index/databricksCredential:DatabricksCredential my_databricks_credential "project_id:credential_id"

    $ pulumi import dbtcloud:index/databricksCredential:DatabricksCredential my_databricks_credential 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
    dbt Cloud v0.1.25 published on Friday, Nov 8, 2024 by Pulumi
    pulumi/pulumi-dbtcloud