harness.platform.ConnectorJdbc
Explore with Pulumi AI
Resource for creating a JDBC connector.
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
    {
        AuthType = "string",
        PasswordRef = "string",
        ServiceAccount = new Harness.Platform.Inputs.ConnectorJdbcCredentialsServiceAccountArgs
        {
            TokenRef = "string",
        },
        Username = "string",
        UsernamePassword = new Harness.Platform.Inputs.ConnectorJdbcCredentialsUsernamePasswordArgs
        {
            PasswordRef = "string",
            Username = "string",
            UsernameRef = "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{
		AuthType:    pulumi.String("string"),
		PasswordRef: pulumi.String("string"),
		ServiceAccount: &platform.ConnectorJdbcCredentialsServiceAccountArgs{
			TokenRef: pulumi.String("string"),
		},
		Username: pulumi.String("string"),
		UsernamePassword: &platform.ConnectorJdbcCredentialsUsernamePasswordArgs{
			PasswordRef: pulumi.String("string"),
			Username:    pulumi.String("string"),
			UsernameRef: 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()
        .authType("string")
        .passwordRef("string")
        .serviceAccount(ConnectorJdbcCredentialsServiceAccountArgs.builder()
            .tokenRef("string")
            .build())
        .username("string")
        .usernamePassword(ConnectorJdbcCredentialsUsernamePasswordArgs.builder()
            .passwordRef("string")
            .username("string")
            .usernameRef("string")
            .build())
        .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={
        "auth_type": "string",
        "password_ref": "string",
        "service_account": {
            "token_ref": "string",
        },
        "username": "string",
        "username_password": {
            "password_ref": "string",
            "username": "string",
            "username_ref": "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: {
        authType: "string",
        passwordRef: "string",
        serviceAccount: {
            tokenRef: "string",
        },
        username: "string",
        usernamePassword: {
            passwordRef: "string",
            username: "string",
            usernameRef: "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:
        authType: string
        passwordRef: string
        serviceAccount:
            tokenRef: string
        username: string
        usernamePassword:
            passwordRef: string
            username: string
            usernameRef: 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ConnectorJdbc resource accepts the following input properties:
- Credentials
ConnectorJdbc Credentials 
- 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.
- List<string>
- Tags to associate with the resource.
- Credentials
ConnectorJdbc Credentials Args 
- 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.
- []string
- Tags to associate with the resource.
- credentials
ConnectorJdbc Credentials 
- 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.
- List<String>
- Tags to associate with the resource.
- credentials
ConnectorJdbc Credentials 
- 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.
- string[]
- Tags to associate with the resource.
- credentials
ConnectorJdbc Credentials Args 
- 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.
- 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.
- 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) -> ConnectorJdbcfunc 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)resources:  _:    type: harness:platform:ConnectorJdbc    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.
- Credentials
ConnectorJdbc Credentials 
- 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.
- List<string>
- Tags to associate with the resource.
- Url string
- The URL of the database server.
- Credentials
ConnectorJdbc Credentials Args 
- 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.
- []string
- Tags to associate with the resource.
- Url string
- The URL of the database server.
- credentials
ConnectorJdbc Credentials 
- 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.
- List<String>
- Tags to associate with the resource.
- url String
- The URL of the database server.
- credentials
ConnectorJdbc Credentials 
- 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.
- string[]
- Tags to associate with the resource.
- url string
- The URL of the database server.
- credentials
ConnectorJdbc Credentials Args 
- 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.
- 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.
- List<String>
- Tags to associate with the resource.
- url String
- The URL of the database server.
Supporting Types
ConnectorJdbcCredentials, ConnectorJdbcCredentialsArgs      
- AuthType string
- Authentication types for JDBC connector
- 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}.
- ServiceAccount ConnectorJdbc Credentials Service Account 
- Authenticate using service account.
- Username string
- The username to use for the database server.
- UsernamePassword ConnectorJdbc Credentials Username Password 
- Authenticate using username password.
- 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}.
- AuthType string
- Authentication types for JDBC connector
- 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}.
- ServiceAccount ConnectorJdbc Credentials Service Account 
- Authenticate using service account.
- Username string
- The username to use for the database server.
- UsernamePassword ConnectorJdbc Credentials Username Password 
- Authenticate using username password.
- 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}.
- authType String
- Authentication types for JDBC connector
- 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}.
- serviceAccount ConnectorJdbc Credentials Service Account 
- Authenticate using service account.
- username String
- The username to use for the database server.
- usernamePassword ConnectorJdbc Credentials Username Password 
- Authenticate using username password.
- 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}.
- authType string
- Authentication types for JDBC connector
- 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}.
- serviceAccount ConnectorJdbc Credentials Service Account 
- Authenticate using service account.
- username string
- The username to use for the database server.
- usernamePassword ConnectorJdbc Credentials Username Password 
- Authenticate using username password.
- 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}.
- auth_type str
- Authentication types for JDBC connector
- 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}.
- service_account ConnectorJdbc Credentials Service Account 
- Authenticate using service account.
- username str
- The username to use for the database server.
- username_password ConnectorJdbc Credentials Username Password 
- Authenticate using username password.
- 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}.
- authType String
- Authentication types for JDBC connector
- 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}.
- serviceAccount Property Map
- Authenticate using service account.
- username String
- The username to use for the database server.
- usernamePassword Property Map
- Authenticate using username password.
- 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}.
ConnectorJdbcCredentialsServiceAccount, ConnectorJdbcCredentialsServiceAccountArgs          
- TokenRef string
- Reference to a secret containing the token to use for authentication. 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}.
- TokenRef string
- Reference to a secret containing the token to use for authentication. 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}.
- tokenRef String
- Reference to a secret containing the token to use for authentication. 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}.
- tokenRef string
- Reference to a secret containing the token to use for authentication. 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}.
- token_ref str
- Reference to a secret containing the token to use for authentication. 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}.
- tokenRef String
- Reference to a secret containing the token to use for authentication. 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}.
ConnectorJdbcCredentialsUsernamePassword, ConnectorJdbcCredentialsUsernamePasswordArgs          
- PasswordRef string
- Reference to a secret containing the password to use for authentication. 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
- Username to use for authentication.
- UsernameRef string
- Reference to a secret containing the username to use for authentication. 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
- Reference to a secret containing the password to use for authentication. 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
- Username to use for authentication.
- UsernameRef string
- Reference to a secret containing the username to use for authentication. 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
- Reference to a secret containing the password to use for authentication. 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
- Username to use for authentication.
- usernameRef String
- Reference to a secret containing the username to use for authentication. 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
- Reference to a secret containing the password to use for authentication. 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
- Username to use for authentication.
- usernameRef string
- Reference to a secret containing the username to use for authentication. 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
- Reference to a secret containing the password to use for authentication. 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
- Username to use for authentication.
- username_ref str
- Reference to a secret containing the username to use for authentication. 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
- Reference to a secret containing the password to use for authentication. 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
- Username to use for authentication.
- usernameRef String
- Reference to a secret containing the username to use for authentication. 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 harnessTerraform Provider.
