published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a SQL connector and its configuration in a Descope project. SQL connector for relational databases including PostgreSQL, MySQL, MariaDB, Microsoft SQL Server (MSSQL), Oracle, CockroachDB, and Amazon Redshift.
Create SqlConnector Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SqlConnector(name: string, args: SqlConnectorArgs, opts?: CustomResourceOptions);@overload
def SqlConnector(resource_name: str,
args: SqlConnectorArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SqlConnector(resource_name: str,
opts: Optional[ResourceOptions] = None,
engine_name: Optional[str] = None,
host: Optional[str] = None,
password: Optional[str] = None,
project_id: Optional[str] = None,
username: Optional[str] = None,
database_name: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
engine_id: Optional[str] = None,
name: Optional[str] = None,
port: Optional[float] = None,
service_name: Optional[str] = None)func NewSqlConnector(ctx *Context, name string, args SqlConnectorArgs, opts ...ResourceOption) (*SqlConnector, error)public SqlConnector(string name, SqlConnectorArgs args, CustomResourceOptions? opts = null)
public SqlConnector(String name, SqlConnectorArgs args)
public SqlConnector(String name, SqlConnectorArgs args, CustomResourceOptions options)
type: descope:SqlConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_sql_connector" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args SqlConnectorArgs
- 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 SqlConnectorArgs
- 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 SqlConnectorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SqlConnectorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SqlConnectorArgs
- 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 sqlConnectorResource = new Descope.SqlConnector("sqlConnectorResource", new()
{
EngineName = "string",
Host = "string",
Password = "string",
ProjectId = "string",
Username = "string",
DatabaseName = "string",
Description = "string",
Disabled = false,
EngineId = "string",
Name = "string",
Port = 0.0,
ServiceName = "string",
});
example, err := descope.NewSqlConnector(ctx, "sqlConnectorResource", &descope.SqlConnectorArgs{
EngineName: pulumi.String("string"),
Host: pulumi.String("string"),
Password: pulumi.String("string"),
ProjectId: pulumi.String("string"),
Username: pulumi.String("string"),
DatabaseName: pulumi.String("string"),
Description: pulumi.String("string"),
Disabled: pulumi.Bool(false),
EngineId: pulumi.String("string"),
Name: pulumi.String("string"),
Port: pulumi.Float64(0),
ServiceName: pulumi.String("string"),
})
resource "descope_sql_connector" "sqlConnectorResource" {
lifecycle {
create_before_destroy = true
}
engine_name = "string"
host = "string"
password = "string"
project_id = "string"
username = "string"
database_name = "string"
description = "string"
disabled = false
engine_id = "string"
name = "string"
port = 0
service_name = "string"
}
var sqlConnectorResource = new SqlConnector("sqlConnectorResource", SqlConnectorArgs.builder()
.engineName("string")
.host("string")
.password("string")
.projectId("string")
.username("string")
.databaseName("string")
.description("string")
.disabled(false)
.engineId("string")
.name("string")
.port(0.0)
.serviceName("string")
.build());
sql_connector_resource = descope.SqlConnector("sqlConnectorResource",
engine_name="string",
host="string",
password="string",
project_id="string",
username="string",
database_name="string",
description="string",
disabled=False,
engine_id="string",
name="string",
port=float(0),
service_name="string")
const sqlConnectorResource = new descope.SqlConnector("sqlConnectorResource", {
engineName: "string",
host: "string",
password: "string",
projectId: "string",
username: "string",
databaseName: "string",
description: "string",
disabled: false,
engineId: "string",
name: "string",
port: 0,
serviceName: "string",
});
type: descope:SqlConnector
properties:
databaseName: string
description: string
disabled: false
engineId: string
engineName: string
host: string
name: string
password: string
port: 0
projectId: string
serviceName: string
username: string
SqlConnector 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 SqlConnector resource accepts the following input properties:
- Engine
Name string - The database engine type.
- Host string
- The database host.
- Password string
- The database password.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Username string
- The database username.
- Database
Name string - The database name.
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- Name string
- A custom name for your connector.
- Port double
- The database port. If not specified, the default port for the selected engine will be used.
- Service
Name string - The Oracle service name (required for Oracle only).
- Engine
Name string - The database engine type.
- Host string
- The database host.
- Password string
- The database password.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Username string
- The database username.
- Database
Name string - The database name.
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- Name string
- A custom name for your connector.
- Port float64
- The database port. If not specified, the default port for the selected engine will be used.
- Service
Name string - The Oracle service name (required for Oracle only).
- engine_
name string - The database engine type.
- host string
- The database host.
- password string
- The database password.
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- username string
- The database username.
- database_
name string - The database name.
- description string
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine_
id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name string
- A custom name for your connector.
- port number
- The database port. If not specified, the default port for the selected engine will be used.
- service_
name string - The Oracle service name (required for Oracle only).
- engine
Name String - The database engine type.
- host String
- The database host.
- password String
- The database password.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- username String
- The database username.
- database
Name String - The database name.
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id String - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name String
- A custom name for your connector.
- port Double
- The database port. If not specified, the default port for the selected engine will be used.
- service
Name String - The Oracle service name (required for Oracle only).
- engine
Name string - The database engine type.
- host string
- The database host.
- password string
- The database password.
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- username string
- The database username.
- database
Name string - The database name.
- description string
- A description of what your connector is used for.
- disabled boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name string
- A custom name for your connector.
- port number
- The database port. If not specified, the default port for the selected engine will be used.
- service
Name string - The Oracle service name (required for Oracle only).
- engine_
name str - The database engine type.
- host str
- The database host.
- password str
- The database password.
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- username str
- The database username.
- database_
name str - The database name.
- description str
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine_
id str - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name str
- A custom name for your connector.
- port float
- The database port. If not specified, the default port for the selected engine will be used.
- service_
name str - The Oracle service name (required for Oracle only).
- engine
Name String - The database engine type.
- host String
- The database host.
- password String
- The database password.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- username String
- The database username.
- database
Name String - The database name.
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id String - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- name String
- A custom name for your connector.
- port Number
- The database port. If not specified, the default port for the selected engine will be used.
- service
Name String - The Oracle service name (required for Oracle only).
Outputs
All input properties are implicitly available as output properties. Additionally, the SqlConnector 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 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 SqlConnector Resource
Get an existing SqlConnector 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?: SqlConnectorState, opts?: CustomResourceOptions): SqlConnector@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
database_name: Optional[str] = None,
description: Optional[str] = None,
disabled: Optional[bool] = None,
engine_id: Optional[str] = None,
engine_name: Optional[str] = None,
host: Optional[str] = None,
name: Optional[str] = None,
password: Optional[str] = None,
port: Optional[float] = None,
project_id: Optional[str] = None,
service_name: Optional[str] = None,
username: Optional[str] = None) -> SqlConnectorfunc GetSqlConnector(ctx *Context, name string, id IDInput, state *SqlConnectorState, opts ...ResourceOption) (*SqlConnector, error)public static SqlConnector Get(string name, Input<string> id, SqlConnectorState? state, CustomResourceOptions? opts = null)public static SqlConnector get(String name, Output<String> id, SqlConnectorState state, CustomResourceOptions options)resources: existingSqlConnector: type: descope:SqlConnector get: id: ${id}import {
to = descope_sql_connector.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state SqlConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state SqlConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state SqlConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state SqlConnectorState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Database
Name string - The database name.
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- Engine
Name string - The database engine type.
- Host string
- The database host.
- Name string
- A custom name for your connector.
- Password string
- The database password.
- Port double
- The database port. If not specified, the default port for the selected engine will be used.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Service
Name string - The Oracle service name (required for Oracle only).
- Username string
- The database username.
- Database
Name string - The database name.
- Description string
- A description of what your connector is used for.
- Disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- Engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- Engine
Name string - The database engine type.
- Host string
- The database host.
- Name string
- A custom name for your connector.
- Password string
- The database password.
- Port float64
- The database port. If not specified, the default port for the selected engine will be used.
- Project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- Service
Name string - The Oracle service name (required for Oracle only).
- Username string
- The database username.
- database_
name string - The database name.
- description string
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine_
id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- engine_
name string - The database engine type.
- host string
- The database host.
- name string
- A custom name for your connector.
- password string
- The database password.
- port number
- The database port. If not specified, the default port for the selected engine will be used.
- project_
id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- service_
name string - The Oracle service name (required for Oracle only).
- username string
- The database username.
- database
Name String - The database name.
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id String - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- engine
Name String - The database engine type.
- host String
- The database host.
- name String
- A custom name for your connector.
- password String
- The database password.
- port Double
- The database port. If not specified, the default port for the selected engine will be used.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- service
Name String - The Oracle service name (required for Oracle only).
- username String
- The database username.
- database
Name string - The database name.
- description string
- A description of what your connector is used for.
- disabled boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id string - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- engine
Name string - The database engine type.
- host string
- The database host.
- name string
- A custom name for your connector.
- password string
- The database password.
- port number
- The database port. If not specified, the default port for the selected engine will be used.
- project
Id string - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- service
Name string - The Oracle service name (required for Oracle only).
- username string
- The database username.
- database_
name str - The database name.
- description str
- A description of what your connector is used for.
- disabled bool
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine_
id str - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- engine_
name str - The database engine type.
- host str
- The database host.
- name str
- A custom name for your connector.
- password str
- The database password.
- port float
- The database port. If not specified, the default port for the selected engine will be used.
- project_
id str - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- service_
name str - The Oracle service name (required for Oracle only).
- username str
- The database username.
- database
Name String - The database name.
- description String
- A description of what your connector is used for.
- disabled Boolean
- Whether the connector is disabled. This can be used to temporarily stop a connector from executing without fully deleting it.
- engine
Id String - The ID of the Descope Engine that runs this connector's actions inside your private network. Leave empty to run the connector in the Descope backend.
- engine
Name String - The database engine type.
- host String
- The database host.
- name String
- A custom name for your connector.
- password String
- The database password.
- port Number
- The database port. If not specified, the default port for the selected engine will be used.
- project
Id String - The ID of the Descope project that the connector belongs to. Changing this value will require the resource to be deleted and recreated.
- service
Name String - The Oracle service name (required for Oracle only).
- username String
- The database username.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope