Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. ConnectorJdbc
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-harness

harness.platform.ConnectorJdbc

Explore with Pulumi AI

harness logo
Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-harness

    Resource for creating a JDBC connector.

    Example Usage

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

const test = new harness.platform.ConnectorJdbc("test", {
    identifier: "identifer",
    name: "name",
    description: "test",
    tags: ["foo:bar"],
    url: "jdbc:sqlserver://1.2.3;trustServerCertificate=true",
    delegateSelectors: ["harness-delegate"],
    credentials: {
        username: "admin",
        passwordRef: "account.secret_id",
    },
});

    import pulumi
import pulumi_harness as harness

test = harness.platform.ConnectorJdbc("test",
    identifier="identifer",
    name="name",
    description="test",
    tags=["foo:bar"],
    url="jdbc:sqlserver://1.2.3;trustServerCertificate=true",
    delegate_selectors=["harness-delegate"],
    credentials={
        "username": "admin",
        "password_ref": "account.secret_id",
    })

    package main

import (
	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.NewConnectorJdbc(ctx, "test", &platform.ConnectorJdbcArgs{
			Identifier:  pulumi.String("identifer"),
			Name:        pulumi.String("name"),
			Description: pulumi.String("test"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
			},
			Url: pulumi.String("jdbc:sqlserver://1.2.3;trustServerCertificate=true"),
			DelegateSelectors: pulumi.StringArray{
				pulumi.String("harness-delegate"),
			},
			Credentials: &platform.ConnectorJdbcCredentialsArgs{
				Username:    pulumi.String("admin"),
				PasswordRef: pulumi.String("account.secret_id"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = new Harness.Platform.ConnectorJdbc("test", new()
    {
        Identifier = "identifer",
        Name = "name",
        Description = "test",
        Tags = new[]
        {
            "foo:bar",
        },
        Url = "jdbc:sqlserver://1.2.3;trustServerCertificate=true",
        DelegateSelectors = new[]
        {
            "harness-delegate",
        },
        Credentials = new Harness.Platform.Inputs.ConnectorJdbcCredentialsArgs
        {
            Username = "admin",
            PasswordRef = "account.secret_id",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.ConnectorJdbc;
import com.pulumi.harness.platform.ConnectorJdbcArgs;
import com.pulumi.harness.platform.inputs.ConnectorJdbcCredentialsArgs;
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 test = new ConnectorJdbc("test", ConnectorJdbcArgs.builder()
            .identifier("identifer")
            .name("name")
            .description("test")
            .tags("foo:bar")
            .url("jdbc:sqlserver://1.2.3;trustServerCertificate=true")
            .delegateSelectors("harness-delegate")
            .credentials(ConnectorJdbcCredentialsArgs.builder()
                .username("admin")
                .passwordRef("account.secret_id")
                .build())
            .build());

    }
}

    resources:
  test:
    type: harness:platform:ConnectorJdbc
    properties:
      identifier: identifer
      name: name
      description: test
      tags:
        - foo:bar
      url: jdbc:sqlserver://1.2.3;trustServerCertificate=true
      delegateSelectors:
        - harness-delegate
      credentials:
        username: admin
        passwordRef: account.secret_id

    Create ConnectorJdbc Resource

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

    Constructor syntax

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

@overload
def ConnectorJdbc(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  credentials: Optional[ConnectorJdbcCredentialsArgs] = None,
                  identifier: Optional[str] = None,
                  url: Optional[str] = None,
                  delegate_selectors: Optional[Sequence[str]] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  org_id: Optional[str] = None,
                  project_id: Optional[str] = None,
                  tags: Optional[Sequence[str]] = None)
    func NewConnectorJdbc(ctx *Context, name string, args ConnectorJdbcArgs, opts ...ResourceOption) (*ConnectorJdbc, error)
    public ConnectorJdbc(string name, ConnectorJdbcArgs args, CustomResourceOptions? opts = null)
    public ConnectorJdbc(String name, ConnectorJdbcArgs args)
public ConnectorJdbc(String name, ConnectorJdbcArgs args, CustomResourceOptions options)

    type: harness:platform:ConnectorJdbc
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 ConnectorJdbcArgs
    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 ConnectorJdbcArgs
    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 ConnectorJdbcArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectorJdbcArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectorJdbcArgs
    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 connectorJdbcResource = new Harness.Platform.ConnectorJdbc("connectorJdbcResource", new()
{
    Credentials = new Harness.Platform.Inputs.ConnectorJdbcCredentialsArgs
    {
        PasswordRef = "string",
        Username = "string",
        UsernameRef = "string",
    },
    Identifier = "string",
    Url = "string",
    DelegateSelectors = new[]
    {
        "string",
    },
    Description = "string",
    Name = "string",
    OrgId = "string",
    ProjectId = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := platform.NewConnectorJdbc(ctx, "connectorJdbcResource", &platform.ConnectorJdbcArgs{
	Credentials: &platform.ConnectorJdbcCredentialsArgs{
		PasswordRef: pulumi.String("string"),
		Username:    pulumi.String("string"),
		UsernameRef: pulumi.String("string"),
	},
	Identifier: pulumi.String("string"),
	Url:        pulumi.String("string"),
	DelegateSelectors: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	OrgId:       pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var connectorJdbcResource = new ConnectorJdbc("connectorJdbcResource", ConnectorJdbcArgs.builder()
    .credentials(ConnectorJdbcCredentialsArgs.builder()
        .passwordRef("string")
        .username("string")
        .usernameRef("string")
        .build())
    .identifier("string")
    .url("string")
    .delegateSelectors("string")
    .description("string")
    .name("string")
    .orgId("string")
    .projectId("string")
    .tags("string")
    .build());

    connector_jdbc_resource = harness.platform.ConnectorJdbc("connectorJdbcResource",
    credentials=harness.platform.ConnectorJdbcCredentialsArgs(
        password_ref="string",
        username="string",
        username_ref="string",
    ),
    identifier="string",
    url="string",
    delegate_selectors=["string"],
    description="string",
    name="string",
    org_id="string",
    project_id="string",
    tags=["string"])

    const connectorJdbcResource = new harness.platform.ConnectorJdbc("connectorJdbcResource", {
    credentials: {
        passwordRef: "string",
        username: "string",
        usernameRef: "string",
    },
    identifier: "string",
    url: "string",
    delegateSelectors: ["string"],
    description: "string",
    name: "string",
    orgId: "string",
    projectId: "string",
    tags: ["string"],
});

    type: harness:platform:ConnectorJdbc
properties:
    credentials:
        passwordRef: string
        username: string
        usernameRef: string
    delegateSelectors:
        - string
    description: string
    identifier: string
    name: string
    orgId: string
    projectId: string
    tags:
        - string
    url: string

    ConnectorJdbc Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ConnectorJdbc resource accepts the following input properties:

    Credentials ConnectorJdbcCredentials
    The credentials to use for the database server.
    Identifier string
    Unique identifier of the resource.
    Url string
    The URL of the database server.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Credentials ConnectorJdbcCredentialsArgs
    The credentials to use for the database server.
    Identifier string
    Unique identifier of the resource.
    Url string
    The URL of the database server.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    credentials ConnectorJdbcCredentials
    The credentials to use for the database server.
    identifier String
    Unique identifier of the resource.
    url String
    The URL of the database server.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    credentials ConnectorJdbcCredentials
    The credentials to use for the database server.
    identifier string
    Unique identifier of the resource.
    url string
    The URL of the database server.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    credentials ConnectorJdbcCredentialsArgs
    The credentials to use for the database server.
    identifier str
    Unique identifier of the resource.
    url str
    The URL of the database server.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    credentials Property Map
    The credentials to use for the database server.
    identifier String
    Unique identifier of the resource.
    url String
    The URL of the database server.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.

    Outputs

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

    Get an existing ConnectorJdbc 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?: ConnectorJdbcState, opts?: CustomResourceOptions): ConnectorJdbc
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credentials: Optional[ConnectorJdbcCredentialsArgs] = None,
        delegate_selectors: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        identifier: Optional[str] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        url: Optional[str] = None) -> ConnectorJdbc
    func GetConnectorJdbc(ctx *Context, name string, id IDInput, state *ConnectorJdbcState, opts ...ResourceOption) (*ConnectorJdbc, error)
    public static ConnectorJdbc Get(string name, Input<string> id, ConnectorJdbcState? state, CustomResourceOptions? opts = null)
    public static ConnectorJdbc get(String name, Output<String> id, ConnectorJdbcState 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:
    Credentials ConnectorJdbcCredentials
    The credentials to use for the database server.
    DelegateSelectors List<string>
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags List<string>
    Tags to associate with the resource.
    Url string
    The URL of the database server.
    Credentials ConnectorJdbcCredentialsArgs
    The credentials to use for the database server.
    DelegateSelectors []string
    Tags to filter delegates for connection.
    Description string
    Description of the resource.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Tags []string
    Tags to associate with the resource.
    Url string
    The URL of the database server.
    credentials ConnectorJdbcCredentials
    The credentials to use for the database server.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    url String
    The URL of the database server.
    credentials ConnectorJdbcCredentials
    The credentials to use for the database server.
    delegateSelectors string[]
    Tags to filter delegates for connection.
    description string
    Description of the resource.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    tags string[]
    Tags to associate with the resource.
    url string
    The URL of the database server.
    credentials ConnectorJdbcCredentialsArgs
    The credentials to use for the database server.
    delegate_selectors Sequence[str]
    Tags to filter delegates for connection.
    description str
    Description of the resource.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    tags Sequence[str]
    Tags to associate with the resource.
    url str
    The URL of the database server.
    credentials Property Map
    The credentials to use for the database server.
    delegateSelectors List<String>
    Tags to filter delegates for connection.
    description String
    Description of the resource.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    tags List<String>
    Tags to associate with the resource.
    url String
    The URL of the database server.

    Supporting Types

    ConnectorJdbcCredentials, ConnectorJdbcCredentialsArgs

    PasswordRef string
    The reference to the Harness secret containing the password to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Username string
    The username to use for the database server.
    UsernameRef string
    The reference to the Harness secret containing the username to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    PasswordRef string
    The reference to the Harness secret containing the password to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    Username string
    The username to use for the database server.
    UsernameRef string
    The reference to the Harness secret containing the username to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    passwordRef String
    The reference to the Harness secret containing the password to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username String
    The username to use for the database server.
    usernameRef String
    The reference to the Harness secret containing the username to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    passwordRef string
    The reference to the Harness secret containing the password to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username string
    The username to use for the database server.
    usernameRef string
    The reference to the Harness secret containing the username to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    password_ref str
    The reference to the Harness secret containing the password to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username str
    The username to use for the database server.
    username_ref str
    The reference to the Harness secret containing the username to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    passwordRef String
    The reference to the Harness secret containing the password to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.
    username String
    The username to use for the database server.
    usernameRef String
    The reference to the Harness secret containing the username to use for the database server. To reference a secret at the organization scope, prefix 'org' to the expression: org.{identifier}. To reference a secret at the account scope, prefix 'account` to the expression: account.{identifier}.

    Import

    Import account level jdbc connector

    $ pulumi import harness:platform/connectorJdbc:ConnectorJdbc example <connector_id>

    Import org level jdbc connector

    $ pulumi import harness:platform/connectorJdbc:ConnectorJdbc example <ord_id>/<connector_id>

    Import project level jdbc connector

    $ pulumi import harness:platform/connectorJdbc:ConnectorJdbc example <org_id>/<project_id>/<connector_id>

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

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.3.2 published on Monday, Sep 16, 2024 by Pulumi
    pulumi/pulumi-harness