Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. dbt Cloud Provider
  3. API Docs
  4. AthenaCredential
dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-dbtcloud

dbtcloud.AthenaCredential

Explore with Pulumi AI

dbtcloud logo
dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-dbtcloud

    Athena credential resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as dbtcloud from "@pulumi/dbtcloud";

const example = new dbtcloud.AthenaCredential("example", {
    projectId: exampleDbtcloudProject.id,
    awsAccessKeyId: "your-access-key-id",
    awsSecretAccessKey: "your-secret-access-key",
    schema: "your_schema",
});

    import pulumi
import pulumi_dbtcloud as dbtcloud

example = dbtcloud.AthenaCredential("example",
    project_id=example_dbtcloud_project["id"],
    aws_access_key_id="your-access-key-id",
    aws_secret_access_key="your-secret-access-key",
    schema="your_schema")

    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 {
		_, err := dbtcloud.NewAthenaCredential(ctx, "example", &dbtcloud.AthenaCredentialArgs{
			ProjectId:          pulumi.Any(exampleDbtcloudProject.Id),
			AwsAccessKeyId:     pulumi.String("your-access-key-id"),
			AwsSecretAccessKey: pulumi.String("your-secret-access-key"),
			Schema:             pulumi.String("your_schema"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DbtCloud = Pulumi.DbtCloud;

return await Deployment.RunAsync(() => 
{
    var example = new DbtCloud.AthenaCredential("example", new()
    {
        ProjectId = exampleDbtcloudProject.Id,
        AwsAccessKeyId = "your-access-key-id",
        AwsSecretAccessKey = "your-secret-access-key",
        Schema = "your_schema",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dbtcloud.AthenaCredential;
import com.pulumi.dbtcloud.AthenaCredentialArgs;
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) {
        var example = new AthenaCredential("example", AthenaCredentialArgs.builder()
            .projectId(exampleDbtcloudProject.id())
            .awsAccessKeyId("your-access-key-id")
            .awsSecretAccessKey("your-secret-access-key")
            .schema("your_schema")
            .build());

    }
}

    resources:
  example:
    type: dbtcloud:AthenaCredential
    properties:
      projectId: ${exampleDbtcloudProject.id}
      awsAccessKeyId: your-access-key-id
      awsSecretAccessKey: your-secret-access-key
      schema: your_schema

    Create AthenaCredential Resource

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

    Constructor syntax

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

@overload
def AthenaCredential(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     aws_access_key_id: Optional[str] = None,
                     aws_secret_access_key: Optional[str] = None,
                     project_id: Optional[int] = None,
                     schema: Optional[str] = None)
    func NewAthenaCredential(ctx *Context, name string, args AthenaCredentialArgs, opts ...ResourceOption) (*AthenaCredential, error)
    public AthenaCredential(string name, AthenaCredentialArgs args, CustomResourceOptions? opts = null)
    public AthenaCredential(String name, AthenaCredentialArgs args)
public AthenaCredential(String name, AthenaCredentialArgs args, CustomResourceOptions options)

    type: dbtcloud:AthenaCredential
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 AthenaCredentialArgs
    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 AthenaCredentialArgs
    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 AthenaCredentialArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AthenaCredentialArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AthenaCredentialArgs
    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 athenaCredentialResource = new DbtCloud.AthenaCredential("athenaCredentialResource", new()
{
    AwsAccessKeyId = "string",
    AwsSecretAccessKey = "string",
    ProjectId = 0,
    Schema = "string",
});

    example, err := dbtcloud.NewAthenaCredential(ctx, "athenaCredentialResource", &dbtcloud.AthenaCredentialArgs{
	AwsAccessKeyId:     pulumi.String("string"),
	AwsSecretAccessKey: pulumi.String("string"),
	ProjectId:          pulumi.Int(0),
	Schema:             pulumi.String("string"),
})

    var athenaCredentialResource = new AthenaCredential("athenaCredentialResource", AthenaCredentialArgs.builder()
    .awsAccessKeyId("string")
    .awsSecretAccessKey("string")
    .projectId(0)
    .schema("string")
    .build());

    athena_credential_resource = dbtcloud.AthenaCredential("athenaCredentialResource",
    aws_access_key_id="string",
    aws_secret_access_key="string",
    project_id=0,
    schema="string")

    const athenaCredentialResource = new dbtcloud.AthenaCredential("athenaCredentialResource", {
    awsAccessKeyId: "string",
    awsSecretAccessKey: "string",
    projectId: 0,
    schema: "string",
});

    type: dbtcloud:AthenaCredential
properties:
    awsAccessKeyId: string
    awsSecretAccessKey: string
    projectId: 0
    schema: string

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

    AwsAccessKeyId string
    AWS access key ID for Athena user
    AwsSecretAccessKey string
    AWS secret access key for Athena user
    ProjectId int
    Project ID to create the Athena credential in
    Schema string
    The schema where to create models
    AwsAccessKeyId string
    AWS access key ID for Athena user
    AwsSecretAccessKey string
    AWS secret access key for Athena user
    ProjectId int
    Project ID to create the Athena credential in
    Schema string
    The schema where to create models
    awsAccessKeyId String
    AWS access key ID for Athena user
    awsSecretAccessKey String
    AWS secret access key for Athena user
    projectId Integer
    Project ID to create the Athena credential in
    schema String
    The schema where to create models
    awsAccessKeyId string
    AWS access key ID for Athena user
    awsSecretAccessKey string
    AWS secret access key for Athena user
    projectId number
    Project ID to create the Athena credential in
    schema string
    The schema where to create models
    aws_access_key_id str
    AWS access key ID for Athena user
    aws_secret_access_key str
    AWS secret access key for Athena user
    project_id int
    Project ID to create the Athena credential in
    schema str
    The schema where to create models
    awsAccessKeyId String
    AWS access key ID for Athena user
    awsSecretAccessKey String
    AWS secret access key for Athena user
    projectId Number
    Project ID to create the Athena credential in
    schema String
    The schema where to create models

    Outputs

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

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

    Look up Existing AthenaCredential Resource

    Get an existing AthenaCredential 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?: AthenaCredentialState, opts?: CustomResourceOptions): AthenaCredential
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_access_key_id: Optional[str] = None,
        aws_secret_access_key: Optional[str] = None,
        credential_id: Optional[int] = None,
        project_id: Optional[int] = None,
        schema: Optional[str] = None) -> AthenaCredential
    func GetAthenaCredential(ctx *Context, name string, id IDInput, state *AthenaCredentialState, opts ...ResourceOption) (*AthenaCredential, error)
    public static AthenaCredential Get(string name, Input<string> id, AthenaCredentialState? state, CustomResourceOptions? opts = null)
    public static AthenaCredential get(String name, Output<String> id, AthenaCredentialState state, CustomResourceOptions options)
    resources:  _:    type: dbtcloud:AthenaCredential    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:
    AwsAccessKeyId string
    AWS access key ID for Athena user
    AwsSecretAccessKey string
    AWS secret access key for Athena user
    CredentialId int
    The internal credential ID
    ProjectId int
    Project ID to create the Athena credential in
    Schema string
    The schema where to create models
    AwsAccessKeyId string
    AWS access key ID for Athena user
    AwsSecretAccessKey string
    AWS secret access key for Athena user
    CredentialId int
    The internal credential ID
    ProjectId int
    Project ID to create the Athena credential in
    Schema string
    The schema where to create models
    awsAccessKeyId String
    AWS access key ID for Athena user
    awsSecretAccessKey String
    AWS secret access key for Athena user
    credentialId Integer
    The internal credential ID
    projectId Integer
    Project ID to create the Athena credential in
    schema String
    The schema where to create models
    awsAccessKeyId string
    AWS access key ID for Athena user
    awsSecretAccessKey string
    AWS secret access key for Athena user
    credentialId number
    The internal credential ID
    projectId number
    Project ID to create the Athena credential in
    schema string
    The schema where to create models
    aws_access_key_id str
    AWS access key ID for Athena user
    aws_secret_access_key str
    AWS secret access key for Athena user
    credential_id int
    The internal credential ID
    project_id int
    Project ID to create the Athena credential in
    schema str
    The schema where to create models
    awsAccessKeyId String
    AWS access key ID for Athena user
    awsSecretAccessKey String
    AWS secret access key for Athena user
    credentialId Number
    The internal credential ID
    projectId Number
    Project ID to create the Athena credential in
    schema String
    The schema where to create models

    Import

    using import blocks (requires Terraform >= 1.5)

    import {

    to = dbtcloud_athena_credential.my_athena_credential

    id = “project_id:credential_id”

    }

    import {

    to = dbtcloud_athena_credential.my_athena_credential

    id = “12345:6789”

    }

    using the older import command

    $ pulumi import dbtcloud:index/athenaCredential:AthenaCredential my_athena_credential "project_id:credential_id"

    $ pulumi import dbtcloud:index/athenaCredential:AthenaCredential my_athena_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.30 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-dbtcloud