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

dbtcloud.OauthConfiguration

Explore with Pulumi AI

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

    Configure an external OAuth integration for the data warehouse. Currently supports Okta and Entra ID (i.e. Azure AD) for Snowflake.

    See the documentation for more information on how to configure it.

    Create OauthConfiguration Resource

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

    Constructor syntax

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

@overload
def OauthConfiguration(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       authorize_url: Optional[str] = None,
                       client_id: Optional[str] = None,
                       client_secret: Optional[str] = None,
                       redirect_uri: Optional[str] = None,
                       token_url: Optional[str] = None,
                       type: Optional[str] = None,
                       application_id_uri: Optional[str] = None,
                       name: Optional[str] = None)
    func NewOauthConfiguration(ctx *Context, name string, args OauthConfigurationArgs, opts ...ResourceOption) (*OauthConfiguration, error)
    public OauthConfiguration(string name, OauthConfigurationArgs args, CustomResourceOptions? opts = null)
    public OauthConfiguration(String name, OauthConfigurationArgs args)
public OauthConfiguration(String name, OauthConfigurationArgs args, CustomResourceOptions options)

    type: dbtcloud:OauthConfiguration
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 OauthConfigurationArgs
    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 OauthConfigurationArgs
    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 OauthConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OauthConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OauthConfigurationArgs
    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 oauthConfigurationResource = new DbtCloud.OauthConfiguration("oauthConfigurationResource", new()
{
    AuthorizeUrl = "string",
    ClientId = "string",
    ClientSecret = "string",
    RedirectUri = "string",
    TokenUrl = "string",
    Type = "string",
    ApplicationIdUri = "string",
    Name = "string",
});

    example, err := dbtcloud.NewOauthConfiguration(ctx, "oauthConfigurationResource", &dbtcloud.OauthConfigurationArgs{
	AuthorizeUrl:     pulumi.String("string"),
	ClientId:         pulumi.String("string"),
	ClientSecret:     pulumi.String("string"),
	RedirectUri:      pulumi.String("string"),
	TokenUrl:         pulumi.String("string"),
	Type:             pulumi.String("string"),
	ApplicationIdUri: pulumi.String("string"),
	Name:             pulumi.String("string"),
})

    var oauthConfigurationResource = new OauthConfiguration("oauthConfigurationResource", OauthConfigurationArgs.builder()
    .authorizeUrl("string")
    .clientId("string")
    .clientSecret("string")
    .redirectUri("string")
    .tokenUrl("string")
    .type("string")
    .applicationIdUri("string")
    .name("string")
    .build());

    oauth_configuration_resource = dbtcloud.OauthConfiguration("oauthConfigurationResource",
    authorize_url="string",
    client_id="string",
    client_secret="string",
    redirect_uri="string",
    token_url="string",
    type="string",
    application_id_uri="string",
    name="string")

    const oauthConfigurationResource = new dbtcloud.OauthConfiguration("oauthConfigurationResource", {
    authorizeUrl: "string",
    clientId: "string",
    clientSecret: "string",
    redirectUri: "string",
    tokenUrl: "string",
    type: "string",
    applicationIdUri: "string",
    name: "string",
});

    type: dbtcloud:OauthConfiguration
properties:
    applicationIdUri: string
    authorizeUrl: string
    clientId: string
    clientSecret: string
    name: string
    redirectUri: string
    tokenUrl: string
    type: string

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

    AuthorizeUrl string
    The Authorize URL for the OAuth integration
    ClientId string
    The Client ID for the OAuth integration
    ClientSecret string
    The Client secret for the OAuth integration
    RedirectUri string
    The redirect URL for the OAuth integration
    TokenUrl string
    The Token URL for the OAuth integration
    Type string
    The type of OAuth integration (entra or okta)
    ApplicationIdUri string
    The Application ID URI for the OAuth integration. Only for Entra
    Name string
    The name of OAuth integration
    AuthorizeUrl string
    The Authorize URL for the OAuth integration
    ClientId string
    The Client ID for the OAuth integration
    ClientSecret string
    The Client secret for the OAuth integration
    RedirectUri string
    The redirect URL for the OAuth integration
    TokenUrl string
    The Token URL for the OAuth integration
    Type string
    The type of OAuth integration (entra or okta)
    ApplicationIdUri string
    The Application ID URI for the OAuth integration. Only for Entra
    Name string
    The name of OAuth integration
    authorizeUrl String
    The Authorize URL for the OAuth integration
    clientId String
    The Client ID for the OAuth integration
    clientSecret String
    The Client secret for the OAuth integration
    redirectUri String
    The redirect URL for the OAuth integration
    tokenUrl String
    The Token URL for the OAuth integration
    type String
    The type of OAuth integration (entra or okta)
    applicationIdUri String
    The Application ID URI for the OAuth integration. Only for Entra
    name String
    The name of OAuth integration
    authorizeUrl string
    The Authorize URL for the OAuth integration
    clientId string
    The Client ID for the OAuth integration
    clientSecret string
    The Client secret for the OAuth integration
    redirectUri string
    The redirect URL for the OAuth integration
    tokenUrl string
    The Token URL for the OAuth integration
    type string
    The type of OAuth integration (entra or okta)
    applicationIdUri string
    The Application ID URI for the OAuth integration. Only for Entra
    name string
    The name of OAuth integration
    authorize_url str
    The Authorize URL for the OAuth integration
    client_id str
    The Client ID for the OAuth integration
    client_secret str
    The Client secret for the OAuth integration
    redirect_uri str
    The redirect URL for the OAuth integration
    token_url str
    The Token URL for the OAuth integration
    type str
    The type of OAuth integration (entra or okta)
    application_id_uri str
    The Application ID URI for the OAuth integration. Only for Entra
    name str
    The name of OAuth integration
    authorizeUrl String
    The Authorize URL for the OAuth integration
    clientId String
    The Client ID for the OAuth integration
    clientSecret String
    The Client secret for the OAuth integration
    redirectUri String
    The redirect URL for the OAuth integration
    tokenUrl String
    The Token URL for the OAuth integration
    type String
    The type of OAuth integration (entra or okta)
    applicationIdUri String
    The Application ID URI for the OAuth integration. Only for Entra
    name String
    The name of OAuth integration

    Outputs

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

    Get an existing OauthConfiguration 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?: OauthConfigurationState, opts?: CustomResourceOptions): OauthConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_id_uri: Optional[str] = None,
        authorize_url: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        name: Optional[str] = None,
        redirect_uri: Optional[str] = None,
        token_url: Optional[str] = None,
        type: Optional[str] = None) -> OauthConfiguration
    func GetOauthConfiguration(ctx *Context, name string, id IDInput, state *OauthConfigurationState, opts ...ResourceOption) (*OauthConfiguration, error)
    public static OauthConfiguration Get(string name, Input<string> id, OauthConfigurationState? state, CustomResourceOptions? opts = null)
    public static OauthConfiguration get(String name, Output<String> id, OauthConfigurationState 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:
    ApplicationIdUri string
    The Application ID URI for the OAuth integration. Only for Entra
    AuthorizeUrl string
    The Authorize URL for the OAuth integration
    ClientId string
    The Client ID for the OAuth integration
    ClientSecret string
    The Client secret for the OAuth integration
    Name string
    The name of OAuth integration
    RedirectUri string
    The redirect URL for the OAuth integration
    TokenUrl string
    The Token URL for the OAuth integration
    Type string
    The type of OAuth integration (entra or okta)
    ApplicationIdUri string
    The Application ID URI for the OAuth integration. Only for Entra
    AuthorizeUrl string
    The Authorize URL for the OAuth integration
    ClientId string
    The Client ID for the OAuth integration
    ClientSecret string
    The Client secret for the OAuth integration
    Name string
    The name of OAuth integration
    RedirectUri string
    The redirect URL for the OAuth integration
    TokenUrl string
    The Token URL for the OAuth integration
    Type string
    The type of OAuth integration (entra or okta)
    applicationIdUri String
    The Application ID URI for the OAuth integration. Only for Entra
    authorizeUrl String
    The Authorize URL for the OAuth integration
    clientId String
    The Client ID for the OAuth integration
    clientSecret String
    The Client secret for the OAuth integration
    name String
    The name of OAuth integration
    redirectUri String
    The redirect URL for the OAuth integration
    tokenUrl String
    The Token URL for the OAuth integration
    type String
    The type of OAuth integration (entra or okta)
    applicationIdUri string
    The Application ID URI for the OAuth integration. Only for Entra
    authorizeUrl string
    The Authorize URL for the OAuth integration
    clientId string
    The Client ID for the OAuth integration
    clientSecret string
    The Client secret for the OAuth integration
    name string
    The name of OAuth integration
    redirectUri string
    The redirect URL for the OAuth integration
    tokenUrl string
    The Token URL for the OAuth integration
    type string
    The type of OAuth integration (entra or okta)
    application_id_uri str
    The Application ID URI for the OAuth integration. Only for Entra
    authorize_url str
    The Authorize URL for the OAuth integration
    client_id str
    The Client ID for the OAuth integration
    client_secret str
    The Client secret for the OAuth integration
    name str
    The name of OAuth integration
    redirect_uri str
    The redirect URL for the OAuth integration
    token_url str
    The Token URL for the OAuth integration
    type str
    The type of OAuth integration (entra or okta)
    applicationIdUri String
    The Application ID URI for the OAuth integration. Only for Entra
    authorizeUrl String
    The Authorize URL for the OAuth integration
    clientId String
    The Client ID for the OAuth integration
    clientSecret String
    The Client secret for the OAuth integration
    name String
    The name of OAuth integration
    redirectUri String
    The redirect URL for the OAuth integration
    tokenUrl String
    The Token URL for the OAuth integration
    type String
    The type of OAuth integration (entra or okta)

    Import

    using import blocks (requires Terraform >= 1.5)

    import {

    to = dbtcloud_oauth_configuration.my_external_oauth

    id = “external_oauth_id”

    }

    import {

    to = dbtcloud_oauth_configuration.my_external_oauth

    id = “12345”

    }

    using the older import command

    $ pulumi import dbtcloud:index/oauthConfiguration:OauthConfiguration my_external_oauth "external_oauth_id"

    $ pulumi import dbtcloud:index/oauthConfiguration:OauthConfiguration my_external_oauth 12345

    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