TargetDb

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create TargetDb Resource

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

Constructor syntax

new TargetDb(name: string, args: TargetDbArgs, opts?: CustomResourceOptions);

@overload
def TargetDb(resource_name: str,
             args: TargetDbArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def TargetDb(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             db_type: Optional[str] = None,
             mongodb_atlas_api_public_key: Optional[str] = None,
             mongodb_default_auth_db: Optional[str] = None,
             cloud_service_provider: Optional[str] = None,
             cluster_mode: Optional[bool] = None,
             connection_type: Optional[str] = None,
             db_name: Optional[str] = None,
             db_server_certificates: Optional[str] = None,
             db_server_name: Optional[str] = None,
             azure_client_secret: Optional[str] = None,
             description: Optional[str] = None,
             mongodb_uri_options: Optional[str] = None,
             key: Optional[str] = None,
             max_versions: Optional[str] = None,
             mongodb_atlas: Optional[bool] = None,
             mongodb_atlas_api_private_key: Optional[str] = None,
             azure_client_id: Optional[str] = None,
             azure_tenant_id: Optional[str] = None,
             mongodb_atlas_project_id: Optional[str] = None,
             host: Optional[str] = None,
             name: Optional[str] = None,
             oracle_service_name: Optional[str] = None,
             oracle_wallet_login_type: Optional[str] = None,
             oracle_wallet_p12_file_data: Optional[str] = None,
             oracle_wallet_sso_file_data: Optional[str] = None,
             parent_target_name: Optional[str] = None,
             port: Optional[str] = None,
             pwd: Optional[str] = None,
             snowflake_account: Optional[str] = None,
             snowflake_api_private_key: Optional[str] = None,
             snowflake_api_private_key_password: Optional[str] = None,
             ssl: Optional[bool] = None,
             ssl_certificate: Optional[str] = None,
             target_db_id: Optional[str] = None,
             user_name: Optional[str] = None)

func NewTargetDb(ctx *Context, name string, args TargetDbArgs, opts ...ResourceOption) (*TargetDb, error)

public TargetDb(string name, TargetDbArgs args, CustomResourceOptions? opts = null)

public TargetDb(String name, TargetDbArgs args)
public TargetDb(String name, TargetDbArgs args, CustomResourceOptions options)

type: akeyless:TargetDb
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "akeyless_targetdb" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args TargetDbArgs: 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 TargetDbArgs: 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 TargetDbArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TargetDbArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TargetDbArgs: 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 targetDbResource = new Akeyless.TargetDb("targetDbResource", new()
{
    DbType = "string",
    MongodbAtlasApiPublicKey = "string",
    MongodbDefaultAuthDb = "string",
    CloudServiceProvider = "string",
    ClusterMode = false,
    ConnectionType = "string",
    DbName = "string",
    DbServerCertificates = "string",
    DbServerName = "string",
    AzureClientSecret = "string",
    Description = "string",
    MongodbUriOptions = "string",
    Key = "string",
    MaxVersions = "string",
    MongodbAtlas = false,
    MongodbAtlasApiPrivateKey = "string",
    AzureClientId = "string",
    AzureTenantId = "string",
    MongodbAtlasProjectId = "string",
    Host = "string",
    Name = "string",
    OracleServiceName = "string",
    OracleWalletLoginType = "string",
    OracleWalletP12FileData = "string",
    OracleWalletSsoFileData = "string",
    ParentTargetName = "string",
    Port = "string",
    Pwd = "string",
    SnowflakeAccount = "string",
    SnowflakeApiPrivateKey = "string",
    SnowflakeApiPrivateKeyPassword = "string",
    Ssl = false,
    SslCertificate = "string",
    TargetDbId = "string",
    UserName = "string",
});

example, err := akeyless.NewTargetDb(ctx, "targetDbResource", &akeyless.TargetDbArgs{
	DbType:                         pulumi.String("string"),
	MongodbAtlasApiPublicKey:       pulumi.String("string"),
	MongodbDefaultAuthDb:           pulumi.String("string"),
	CloudServiceProvider:           pulumi.String("string"),
	ClusterMode:                    pulumi.Bool(false),
	ConnectionType:                 pulumi.String("string"),
	DbName:                         pulumi.String("string"),
	DbServerCertificates:           pulumi.String("string"),
	DbServerName:                   pulumi.String("string"),
	AzureClientSecret:              pulumi.String("string"),
	Description:                    pulumi.String("string"),
	MongodbUriOptions:              pulumi.String("string"),
	Key:                            pulumi.String("string"),
	MaxVersions:                    pulumi.String("string"),
	MongodbAtlas:                   pulumi.Bool(false),
	MongodbAtlasApiPrivateKey:      pulumi.String("string"),
	AzureClientId:                  pulumi.String("string"),
	AzureTenantId:                  pulumi.String("string"),
	MongodbAtlasProjectId:          pulumi.String("string"),
	Host:                           pulumi.String("string"),
	Name:                           pulumi.String("string"),
	OracleServiceName:              pulumi.String("string"),
	OracleWalletLoginType:          pulumi.String("string"),
	OracleWalletP12FileData:        pulumi.String("string"),
	OracleWalletSsoFileData:        pulumi.String("string"),
	ParentTargetName:               pulumi.String("string"),
	Port:                           pulumi.String("string"),
	Pwd:                            pulumi.String("string"),
	SnowflakeAccount:               pulumi.String("string"),
	SnowflakeApiPrivateKey:         pulumi.String("string"),
	SnowflakeApiPrivateKeyPassword: pulumi.String("string"),
	Ssl:                            pulumi.Bool(false),
	SslCertificate:                 pulumi.String("string"),
	TargetDbId:                     pulumi.String("string"),
	UserName:                       pulumi.String("string"),
})

resource "akeyless_targetdb" "targetDbResource" {
  db_type                            = "string"
  mongodb_atlas_api_public_key       = "string"
  mongodb_default_auth_db            = "string"
  cloud_service_provider             = "string"
  cluster_mode                       = false
  connection_type                    = "string"
  db_name                            = "string"
  db_server_certificates             = "string"
  db_server_name                     = "string"
  azure_client_secret                = "string"
  description                        = "string"
  mongodb_uri_options                = "string"
  key                                = "string"
  max_versions                       = "string"
  mongodb_atlas                      = false
  mongodb_atlas_api_private_key      = "string"
  azure_client_id                    = "string"
  azure_tenant_id                    = "string"
  mongodb_atlas_project_id           = "string"
  host                               = "string"
  name                               = "string"
  oracle_service_name                = "string"
  oracle_wallet_login_type           = "string"
  oracle_wallet_p12_file_data        = "string"
  oracle_wallet_sso_file_data        = "string"
  parent_target_name                 = "string"
  port                               = "string"
  pwd                                = "string"
  snowflake_account                  = "string"
  snowflake_api_private_key          = "string"
  snowflake_api_private_key_password = "string"
  ssl                                = false
  ssl_certificate                    = "string"
  target_db_id                       = "string"
  user_name                          = "string"
}

var targetDbResource = new TargetDb("targetDbResource", TargetDbArgs.builder()
    .dbType("string")
    .mongodbAtlasApiPublicKey("string")
    .mongodbDefaultAuthDb("string")
    .cloudServiceProvider("string")
    .clusterMode(false)
    .connectionType("string")
    .dbName("string")
    .dbServerCertificates("string")
    .dbServerName("string")
    .azureClientSecret("string")
    .description("string")
    .mongodbUriOptions("string")
    .key("string")
    .maxVersions("string")
    .mongodbAtlas(false)
    .mongodbAtlasApiPrivateKey("string")
    .azureClientId("string")
    .azureTenantId("string")
    .mongodbAtlasProjectId("string")
    .host("string")
    .name("string")
    .oracleServiceName("string")
    .oracleWalletLoginType("string")
    .oracleWalletP12FileData("string")
    .oracleWalletSsoFileData("string")
    .parentTargetName("string")
    .port("string")
    .pwd("string")
    .snowflakeAccount("string")
    .snowflakeApiPrivateKey("string")
    .snowflakeApiPrivateKeyPassword("string")
    .ssl(false)
    .sslCertificate("string")
    .targetDbId("string")
    .userName("string")
    .build());

target_db_resource = akeyless.TargetDb("targetDbResource",
    db_type="string",
    mongodb_atlas_api_public_key="string",
    mongodb_default_auth_db="string",
    cloud_service_provider="string",
    cluster_mode=False,
    connection_type="string",
    db_name="string",
    db_server_certificates="string",
    db_server_name="string",
    azure_client_secret="string",
    description="string",
    mongodb_uri_options="string",
    key="string",
    max_versions="string",
    mongodb_atlas=False,
    mongodb_atlas_api_private_key="string",
    azure_client_id="string",
    azure_tenant_id="string",
    mongodb_atlas_project_id="string",
    host="string",
    name="string",
    oracle_service_name="string",
    oracle_wallet_login_type="string",
    oracle_wallet_p12_file_data="string",
    oracle_wallet_sso_file_data="string",
    parent_target_name="string",
    port="string",
    pwd="string",
    snowflake_account="string",
    snowflake_api_private_key="string",
    snowflake_api_private_key_password="string",
    ssl=False,
    ssl_certificate="string",
    target_db_id="string",
    user_name="string")

const targetDbResource = new akeyless.TargetDb("targetDbResource", {
    dbType: "string",
    mongodbAtlasApiPublicKey: "string",
    mongodbDefaultAuthDb: "string",
    cloudServiceProvider: "string",
    clusterMode: false,
    connectionType: "string",
    dbName: "string",
    dbServerCertificates: "string",
    dbServerName: "string",
    azureClientSecret: "string",
    description: "string",
    mongodbUriOptions: "string",
    key: "string",
    maxVersions: "string",
    mongodbAtlas: false,
    mongodbAtlasApiPrivateKey: "string",
    azureClientId: "string",
    azureTenantId: "string",
    mongodbAtlasProjectId: "string",
    host: "string",
    name: "string",
    oracleServiceName: "string",
    oracleWalletLoginType: "string",
    oracleWalletP12FileData: "string",
    oracleWalletSsoFileData: "string",
    parentTargetName: "string",
    port: "string",
    pwd: "string",
    snowflakeAccount: "string",
    snowflakeApiPrivateKey: "string",
    snowflakeApiPrivateKeyPassword: "string",
    ssl: false,
    sslCertificate: "string",
    targetDbId: "string",
    userName: "string",
});

type: akeyless:TargetDb
properties:
    azureClientId: string
    azureClientSecret: string
    azureTenantId: string
    cloudServiceProvider: string
    clusterMode: false
    connectionType: string
    dbName: string
    dbServerCertificates: string
    dbServerName: string
    dbType: string
    description: string
    host: string
    key: string
    maxVersions: string
    mongodbAtlas: false
    mongodbAtlasApiPrivateKey: string
    mongodbAtlasApiPublicKey: string
    mongodbAtlasProjectId: string
    mongodbDefaultAuthDb: string
    mongodbUriOptions: string
    name: string
    oracleServiceName: string
    oracleWalletLoginType: string
    oracleWalletP12FileData: string
    oracleWalletSsoFileData: string
    parentTargetName: string
    port: string
    pwd: string
    snowflakeAccount: string
    snowflakeApiPrivateKey: string
    snowflakeApiPrivateKeyPassword: string
    ssl: false
    sslCertificate: string
    targetDbId: string
    userName: string

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

DbType string: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
AzureClientId string: (Optional) Client id (relevant for "cloud-service-provider" only)
AzureClientSecret string: (Optional) Client secret (relevant for "cloud-service-provider" only)
AzureTenantId string: (Optional) Tenant id (relevant for "cloud-service-provider" only)
CloudServiceProvider string: (Optional) Cloud service provider (currently only supports Azure)
ClusterMode bool: Cluster Mode
ConnectionType string: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
DbName string: Database name
DbServerCertificates string: (Optional) DB server certificates
DbServerName string: (Optional) Server name for certificate verification
Description string: Description of the object
Host string: Database host
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
MongodbAtlas bool: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
MongodbAtlasApiPrivateKey string: MongoDB Atlas private key
MongodbAtlasApiPublicKey string: MongoDB Atlas public key
MongodbAtlasProjectId string: MongoDB Atlas project ID
MongodbDefaultAuthDb string: MongoDB server default authentication database
MongodbUriOptions string: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
Name string: Target name
OracleServiceName string: Oracle db service name
OracleWalletLoginType string: Oracle Wallet login type (password/mtls)
OracleWalletP12FileData string: Oracle wallet p12 file data in base64
OracleWalletSsoFileData string: Oracle wallet sso file data in base64
ParentTargetName string: Name of the parent target, relevant only when connection-type is parent-target
Port string: Database port
Pwd string: Database password
SnowflakeAccount string: Snowflake account name
SnowflakeApiPrivateKey string: RSA Private key (base64 encoded)
SnowflakeApiPrivateKeyPassword string: The Private key passphrase
Ssl bool: Enable/Disable SSL [true/false]
SslCertificate string: SSL connection certificate
TargetDbId string: The ID of this resource.
UserName string: Database user name

DbType string: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
AzureClientId string: (Optional) Client id (relevant for "cloud-service-provider" only)
AzureClientSecret string: (Optional) Client secret (relevant for "cloud-service-provider" only)
AzureTenantId string: (Optional) Tenant id (relevant for "cloud-service-provider" only)
CloudServiceProvider string: (Optional) Cloud service provider (currently only supports Azure)
ClusterMode bool: Cluster Mode
ConnectionType string: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
DbName string: Database name
DbServerCertificates string: (Optional) DB server certificates
DbServerName string: (Optional) Server name for certificate verification
Description string: Description of the object
Host string: Database host
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
MongodbAtlas bool: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
MongodbAtlasApiPrivateKey string: MongoDB Atlas private key
MongodbAtlasApiPublicKey string: MongoDB Atlas public key
MongodbAtlasProjectId string: MongoDB Atlas project ID
MongodbDefaultAuthDb string: MongoDB server default authentication database
MongodbUriOptions string: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
Name string: Target name
OracleServiceName string: Oracle db service name
OracleWalletLoginType string: Oracle Wallet login type (password/mtls)
OracleWalletP12FileData string: Oracle wallet p12 file data in base64
OracleWalletSsoFileData string: Oracle wallet sso file data in base64
ParentTargetName string: Name of the parent target, relevant only when connection-type is parent-target
Port string: Database port
Pwd string: Database password
SnowflakeAccount string: Snowflake account name
SnowflakeApiPrivateKey string: RSA Private key (base64 encoded)
SnowflakeApiPrivateKeyPassword string: The Private key passphrase
Ssl bool: Enable/Disable SSL [true/false]
SslCertificate string: SSL connection certificate
TargetDbId string: The ID of this resource.
UserName string: Database user name

db_type string: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
azure_client_id string: (Optional) Client id (relevant for "cloud-service-provider" only)
azure_client_secret string: (Optional) Client secret (relevant for "cloud-service-provider" only)
azure_tenant_id string: (Optional) Tenant id (relevant for "cloud-service-provider" only)
cloud_service_provider string: (Optional) Cloud service provider (currently only supports Azure)
cluster_mode bool: Cluster Mode
connection_type string: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
db_name string: Database name
db_server_certificates string: (Optional) DB server certificates
db_server_name string: (Optional) Server name for certificate verification
description string: Description of the object
host string: Database host
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions string: Set the maximum number of versions, limited by the account settings defaults.
mongodb_atlas bool: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
mongodb_atlas_api_private_key string: MongoDB Atlas private key
mongodb_atlas_api_public_key string: MongoDB Atlas public key
mongodb_atlas_project_id string: MongoDB Atlas project ID
mongodb_default_auth_db string: MongoDB server default authentication database
mongodb_uri_options string: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
name string: Target name
oracle_service_name string: Oracle db service name
oracle_wallet_login_type string: Oracle Wallet login type (password/mtls)
oracle_wallet_p12_file_data string: Oracle wallet p12 file data in base64
oracle_wallet_sso_file_data string: Oracle wallet sso file data in base64
parent_target_name string: Name of the parent target, relevant only when connection-type is parent-target
port string: Database port
pwd string: Database password
snowflake_account string: Snowflake account name
snowflake_api_private_key string: RSA Private key (base64 encoded)
snowflake_api_private_key_password string: The Private key passphrase
ssl bool: Enable/Disable SSL [true/false]
ssl_certificate string: SSL connection certificate
target_db_id string: The ID of this resource.
user_name string: Database user name

dbType String: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
azureClientId String: (Optional) Client id (relevant for "cloud-service-provider" only)
azureClientSecret String: (Optional) Client secret (relevant for "cloud-service-provider" only)
azureTenantId String: (Optional) Tenant id (relevant for "cloud-service-provider" only)
cloudServiceProvider String: (Optional) Cloud service provider (currently only supports Azure)
clusterMode Boolean: Cluster Mode
connectionType String: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
dbName String: Database name
dbServerCertificates String: (Optional) DB server certificates
dbServerName String: (Optional) Server name for certificate verification
description String: Description of the object
host String: Database host
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
mongodbAtlas Boolean: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
mongodbAtlasApiPrivateKey String: MongoDB Atlas private key
mongodbAtlasApiPublicKey String: MongoDB Atlas public key
mongodbAtlasProjectId String: MongoDB Atlas project ID
mongodbDefaultAuthDb String: MongoDB server default authentication database
mongodbUriOptions String: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
name String: Target name
oracleServiceName String: Oracle db service name
oracleWalletLoginType String: Oracle Wallet login type (password/mtls)
oracleWalletP12FileData String: Oracle wallet p12 file data in base64
oracleWalletSsoFileData String: Oracle wallet sso file data in base64
parentTargetName String: Name of the parent target, relevant only when connection-type is parent-target
port String: Database port
pwd String: Database password
snowflakeAccount String: Snowflake account name
snowflakeApiPrivateKey String: RSA Private key (base64 encoded)
snowflakeApiPrivateKeyPassword String: The Private key passphrase
ssl Boolean: Enable/Disable SSL [true/false]
sslCertificate String: SSL connection certificate
targetDbId String: The ID of this resource.
userName String: Database user name

dbType string: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
azureClientId string: (Optional) Client id (relevant for "cloud-service-provider" only)
azureClientSecret string: (Optional) Client secret (relevant for "cloud-service-provider" only)
azureTenantId string: (Optional) Tenant id (relevant for "cloud-service-provider" only)
cloudServiceProvider string: (Optional) Cloud service provider (currently only supports Azure)
clusterMode boolean: Cluster Mode
connectionType string: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
dbName string: Database name
dbServerCertificates string: (Optional) DB server certificates
dbServerName string: (Optional) Server name for certificate verification
description string: Description of the object
host string: Database host
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
mongodbAtlas boolean: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
mongodbAtlasApiPrivateKey string: MongoDB Atlas private key
mongodbAtlasApiPublicKey string: MongoDB Atlas public key
mongodbAtlasProjectId string: MongoDB Atlas project ID
mongodbDefaultAuthDb string: MongoDB server default authentication database
mongodbUriOptions string: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
name string: Target name
oracleServiceName string: Oracle db service name
oracleWalletLoginType string: Oracle Wallet login type (password/mtls)
oracleWalletP12FileData string: Oracle wallet p12 file data in base64
oracleWalletSsoFileData string: Oracle wallet sso file data in base64
parentTargetName string: Name of the parent target, relevant only when connection-type is parent-target
port string: Database port
pwd string: Database password
snowflakeAccount string: Snowflake account name
snowflakeApiPrivateKey string: RSA Private key (base64 encoded)
snowflakeApiPrivateKeyPassword string: The Private key passphrase
ssl boolean: Enable/Disable SSL [true/false]
sslCertificate string: SSL connection certificate
targetDbId string: The ID of this resource.
userName string: Database user name

db_type str: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
azure_client_id str: (Optional) Client id (relevant for "cloud-service-provider" only)
azure_client_secret str: (Optional) Client secret (relevant for "cloud-service-provider" only)
azure_tenant_id str: (Optional) Tenant id (relevant for "cloud-service-provider" only)
cloud_service_provider str: (Optional) Cloud service provider (currently only supports Azure)
cluster_mode bool: Cluster Mode
connection_type str: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
db_name str: Database name
db_server_certificates str: (Optional) DB server certificates
db_server_name str: (Optional) Server name for certificate verification
description str: Description of the object
host str: Database host
key str: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
mongodb_atlas bool: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
mongodb_atlas_api_private_key str: MongoDB Atlas private key
mongodb_atlas_api_public_key str: MongoDB Atlas public key
mongodb_atlas_project_id str: MongoDB Atlas project ID
mongodb_default_auth_db str: MongoDB server default authentication database
mongodb_uri_options str: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
name str: Target name
oracle_service_name str: Oracle db service name
oracle_wallet_login_type str: Oracle Wallet login type (password/mtls)
oracle_wallet_p12_file_data str: Oracle wallet p12 file data in base64
oracle_wallet_sso_file_data str: Oracle wallet sso file data in base64
parent_target_name str: Name of the parent target, relevant only when connection-type is parent-target
port str: Database port
pwd str: Database password
snowflake_account str: Snowflake account name
snowflake_api_private_key str: RSA Private key (base64 encoded)
snowflake_api_private_key_password str: The Private key passphrase
ssl bool: Enable/Disable SSL [true/false]
ssl_certificate str: SSL connection certificate
target_db_id str: The ID of this resource.
user_name str: Database user name

dbType String: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
azureClientId String: (Optional) Client id (relevant for "cloud-service-provider" only)
azureClientSecret String: (Optional) Client secret (relevant for "cloud-service-provider" only)
azureTenantId String: (Optional) Tenant id (relevant for "cloud-service-provider" only)
cloudServiceProvider String: (Optional) Cloud service provider (currently only supports Azure)
clusterMode Boolean: Cluster Mode
connectionType String: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
dbName String: Database name
dbServerCertificates String: (Optional) DB server certificates
dbServerName String: (Optional) Server name for certificate verification
description String: Description of the object
host String: Database host
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
mongodbAtlas Boolean: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
mongodbAtlasApiPrivateKey String: MongoDB Atlas private key
mongodbAtlasApiPublicKey String: MongoDB Atlas public key
mongodbAtlasProjectId String: MongoDB Atlas project ID
mongodbDefaultAuthDb String: MongoDB server default authentication database
mongodbUriOptions String: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
name String: Target name
oracleServiceName String: Oracle db service name
oracleWalletLoginType String: Oracle Wallet login type (password/mtls)
oracleWalletP12FileData String: Oracle wallet p12 file data in base64
oracleWalletSsoFileData String: Oracle wallet sso file data in base64
parentTargetName String: Name of the parent target, relevant only when connection-type is parent-target
port String: Database port
pwd String: Database password
snowflakeAccount String: Snowflake account name
snowflakeApiPrivateKey String: RSA Private key (base64 encoded)
snowflakeApiPrivateKeyPassword String: The Private key passphrase
ssl Boolean: Enable/Disable SSL [true/false]
sslCertificate String: SSL connection certificate
targetDbId String: The ID of this resource.
userName String: Database user name

Outputs

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

Get an existing TargetDb 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?: TargetDbState, opts?: CustomResourceOptions): TargetDb

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        azure_client_id: Optional[str] = None,
        azure_client_secret: Optional[str] = None,
        azure_tenant_id: Optional[str] = None,
        cloud_service_provider: Optional[str] = None,
        cluster_mode: Optional[bool] = None,
        connection_type: Optional[str] = None,
        db_name: Optional[str] = None,
        db_server_certificates: Optional[str] = None,
        db_server_name: Optional[str] = None,
        db_type: Optional[str] = None,
        description: Optional[str] = None,
        host: Optional[str] = None,
        key: Optional[str] = None,
        max_versions: Optional[str] = None,
        mongodb_atlas: Optional[bool] = None,
        mongodb_atlas_api_private_key: Optional[str] = None,
        mongodb_atlas_api_public_key: Optional[str] = None,
        mongodb_atlas_project_id: Optional[str] = None,
        mongodb_default_auth_db: Optional[str] = None,
        mongodb_uri_options: Optional[str] = None,
        name: Optional[str] = None,
        oracle_service_name: Optional[str] = None,
        oracle_wallet_login_type: Optional[str] = None,
        oracle_wallet_p12_file_data: Optional[str] = None,
        oracle_wallet_sso_file_data: Optional[str] = None,
        parent_target_name: Optional[str] = None,
        port: Optional[str] = None,
        pwd: Optional[str] = None,
        snowflake_account: Optional[str] = None,
        snowflake_api_private_key: Optional[str] = None,
        snowflake_api_private_key_password: Optional[str] = None,
        ssl: Optional[bool] = None,
        ssl_certificate: Optional[str] = None,
        target_db_id: Optional[str] = None,
        user_name: Optional[str] = None) -> TargetDb

func GetTargetDb(ctx *Context, name string, id IDInput, state *TargetDbState, opts ...ResourceOption) (*TargetDb, error)

public static TargetDb Get(string name, Input<string> id, TargetDbState? state, CustomResourceOptions? opts = null)

public static TargetDb get(String name, Output<String> id, TargetDbState state, CustomResourceOptions options)

resources:  _:    type: akeyless:TargetDb    get:      id: ${id}

import {
  to = akeyless_targetdb.example
  id = "${id}"
}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AzureClientId string: (Optional) Client id (relevant for "cloud-service-provider" only)
AzureClientSecret string: (Optional) Client secret (relevant for "cloud-service-provider" only)
AzureTenantId string: (Optional) Tenant id (relevant for "cloud-service-provider" only)
CloudServiceProvider string: (Optional) Cloud service provider (currently only supports Azure)
ClusterMode bool: Cluster Mode
ConnectionType string: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
DbName string: Database name
DbServerCertificates string: (Optional) DB server certificates
DbServerName string: (Optional) Server name for certificate verification
DbType string: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
Description string: Description of the object
Host string: Database host
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
MongodbAtlas bool: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
MongodbAtlasApiPrivateKey string: MongoDB Atlas private key
MongodbAtlasApiPublicKey string: MongoDB Atlas public key
MongodbAtlasProjectId string: MongoDB Atlas project ID
MongodbDefaultAuthDb string: MongoDB server default authentication database
MongodbUriOptions string: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
Name string: Target name
OracleServiceName string: Oracle db service name
OracleWalletLoginType string: Oracle Wallet login type (password/mtls)
OracleWalletP12FileData string: Oracle wallet p12 file data in base64
OracleWalletSsoFileData string: Oracle wallet sso file data in base64
ParentTargetName string: Name of the parent target, relevant only when connection-type is parent-target
Port string: Database port
Pwd string: Database password
SnowflakeAccount string: Snowflake account name
SnowflakeApiPrivateKey string: RSA Private key (base64 encoded)
SnowflakeApiPrivateKeyPassword string: The Private key passphrase
Ssl bool: Enable/Disable SSL [true/false]
SslCertificate string: SSL connection certificate
TargetDbId string: The ID of this resource.
UserName string: Database user name

AzureClientId string: (Optional) Client id (relevant for "cloud-service-provider" only)
AzureClientSecret string: (Optional) Client secret (relevant for "cloud-service-provider" only)
AzureTenantId string: (Optional) Tenant id (relevant for "cloud-service-provider" only)
CloudServiceProvider string: (Optional) Cloud service provider (currently only supports Azure)
ClusterMode bool: Cluster Mode
ConnectionType string: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
DbName string: Database name
DbServerCertificates string: (Optional) DB server certificates
DbServerName string: (Optional) Server name for certificate verification
DbType string: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
Description string: Description of the object
Host string: Database host
Key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
MongodbAtlas bool: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
MongodbAtlasApiPrivateKey string: MongoDB Atlas private key
MongodbAtlasApiPublicKey string: MongoDB Atlas public key
MongodbAtlasProjectId string: MongoDB Atlas project ID
MongodbDefaultAuthDb string: MongoDB server default authentication database
MongodbUriOptions string: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
Name string: Target name
OracleServiceName string: Oracle db service name
OracleWalletLoginType string: Oracle Wallet login type (password/mtls)
OracleWalletP12FileData string: Oracle wallet p12 file data in base64
OracleWalletSsoFileData string: Oracle wallet sso file data in base64
ParentTargetName string: Name of the parent target, relevant only when connection-type is parent-target
Port string: Database port
Pwd string: Database password
SnowflakeAccount string: Snowflake account name
SnowflakeApiPrivateKey string: RSA Private key (base64 encoded)
SnowflakeApiPrivateKeyPassword string: The Private key passphrase
Ssl bool: Enable/Disable SSL [true/false]
SslCertificate string: SSL connection certificate
TargetDbId string: The ID of this resource.
UserName string: Database user name

azure_client_id string: (Optional) Client id (relevant for "cloud-service-provider" only)
azure_client_secret string: (Optional) Client secret (relevant for "cloud-service-provider" only)
azure_tenant_id string: (Optional) Tenant id (relevant for "cloud-service-provider" only)
cloud_service_provider string: (Optional) Cloud service provider (currently only supports Azure)
cluster_mode bool: Cluster Mode
connection_type string: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
db_name string: Database name
db_server_certificates string: (Optional) DB server certificates
db_server_name string: (Optional) Server name for certificate verification
db_type string: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
description string: Description of the object
host string: Database host
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions string: Set the maximum number of versions, limited by the account settings defaults.
mongodb_atlas bool: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
mongodb_atlas_api_private_key string: MongoDB Atlas private key
mongodb_atlas_api_public_key string: MongoDB Atlas public key
mongodb_atlas_project_id string: MongoDB Atlas project ID
mongodb_default_auth_db string: MongoDB server default authentication database
mongodb_uri_options string: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
name string: Target name
oracle_service_name string: Oracle db service name
oracle_wallet_login_type string: Oracle Wallet login type (password/mtls)
oracle_wallet_p12_file_data string: Oracle wallet p12 file data in base64
oracle_wallet_sso_file_data string: Oracle wallet sso file data in base64
parent_target_name string: Name of the parent target, relevant only when connection-type is parent-target
port string: Database port
pwd string: Database password
snowflake_account string: Snowflake account name
snowflake_api_private_key string: RSA Private key (base64 encoded)
snowflake_api_private_key_password string: The Private key passphrase
ssl bool: Enable/Disable SSL [true/false]
ssl_certificate string: SSL connection certificate
target_db_id string: The ID of this resource.
user_name string: Database user name

azureClientId String: (Optional) Client id (relevant for "cloud-service-provider" only)
azureClientSecret String: (Optional) Client secret (relevant for "cloud-service-provider" only)
azureTenantId String: (Optional) Tenant id (relevant for "cloud-service-provider" only)
cloudServiceProvider String: (Optional) Cloud service provider (currently only supports Azure)
clusterMode Boolean: Cluster Mode
connectionType String: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
dbName String: Database name
dbServerCertificates String: (Optional) DB server certificates
dbServerName String: (Optional) Server name for certificate verification
dbType String: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
description String: Description of the object
host String: Database host
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
mongodbAtlas Boolean: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
mongodbAtlasApiPrivateKey String: MongoDB Atlas private key
mongodbAtlasApiPublicKey String: MongoDB Atlas public key
mongodbAtlasProjectId String: MongoDB Atlas project ID
mongodbDefaultAuthDb String: MongoDB server default authentication database
mongodbUriOptions String: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
name String: Target name
oracleServiceName String: Oracle db service name
oracleWalletLoginType String: Oracle Wallet login type (password/mtls)
oracleWalletP12FileData String: Oracle wallet p12 file data in base64
oracleWalletSsoFileData String: Oracle wallet sso file data in base64
parentTargetName String: Name of the parent target, relevant only when connection-type is parent-target
port String: Database port
pwd String: Database password
snowflakeAccount String: Snowflake account name
snowflakeApiPrivateKey String: RSA Private key (base64 encoded)
snowflakeApiPrivateKeyPassword String: The Private key passphrase
ssl Boolean: Enable/Disable SSL [true/false]
sslCertificate String: SSL connection certificate
targetDbId String: The ID of this resource.
userName String: Database user name

azureClientId string: (Optional) Client id (relevant for "cloud-service-provider" only)
azureClientSecret string: (Optional) Client secret (relevant for "cloud-service-provider" only)
azureTenantId string: (Optional) Tenant id (relevant for "cloud-service-provider" only)
cloudServiceProvider string: (Optional) Cloud service provider (currently only supports Azure)
clusterMode boolean: Cluster Mode
connectionType string: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
dbName string: Database name
dbServerCertificates string: (Optional) DB server certificates
dbServerName string: (Optional) Server name for certificate verification
dbType string: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
description string: Description of the object
host string: Database host
key string: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
mongodbAtlas boolean: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
mongodbAtlasApiPrivateKey string: MongoDB Atlas private key
mongodbAtlasApiPublicKey string: MongoDB Atlas public key
mongodbAtlasProjectId string: MongoDB Atlas project ID
mongodbDefaultAuthDb string: MongoDB server default authentication database
mongodbUriOptions string: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
name string: Target name
oracleServiceName string: Oracle db service name
oracleWalletLoginType string: Oracle Wallet login type (password/mtls)
oracleWalletP12FileData string: Oracle wallet p12 file data in base64
oracleWalletSsoFileData string: Oracle wallet sso file data in base64
parentTargetName string: Name of the parent target, relevant only when connection-type is parent-target
port string: Database port
pwd string: Database password
snowflakeAccount string: Snowflake account name
snowflakeApiPrivateKey string: RSA Private key (base64 encoded)
snowflakeApiPrivateKeyPassword string: The Private key passphrase
ssl boolean: Enable/Disable SSL [true/false]
sslCertificate string: SSL connection certificate
targetDbId string: The ID of this resource.
userName string: Database user name

azure_client_id str: (Optional) Client id (relevant for "cloud-service-provider" only)
azure_client_secret str: (Optional) Client secret (relevant for "cloud-service-provider" only)
azure_tenant_id str: (Optional) Tenant id (relevant for "cloud-service-provider" only)
cloud_service_provider str: (Optional) Cloud service provider (currently only supports Azure)
cluster_mode bool: Cluster Mode
connection_type str: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
db_name str: Database name
db_server_certificates str: (Optional) DB server certificates
db_server_name str: (Optional) Server name for certificate verification
db_type str: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
description str: Description of the object
host str: Database host
key str: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
mongodb_atlas bool: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
mongodb_atlas_api_private_key str: MongoDB Atlas private key
mongodb_atlas_api_public_key str: MongoDB Atlas public key
mongodb_atlas_project_id str: MongoDB Atlas project ID
mongodb_default_auth_db str: MongoDB server default authentication database
mongodb_uri_options str: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
name str: Target name
oracle_service_name str: Oracle db service name
oracle_wallet_login_type str: Oracle Wallet login type (password/mtls)
oracle_wallet_p12_file_data str: Oracle wallet p12 file data in base64
oracle_wallet_sso_file_data str: Oracle wallet sso file data in base64
parent_target_name str: Name of the parent target, relevant only when connection-type is parent-target
port str: Database port
pwd str: Database password
snowflake_account str: Snowflake account name
snowflake_api_private_key str: RSA Private key (base64 encoded)
snowflake_api_private_key_password str: The Private key passphrase
ssl bool: Enable/Disable SSL [true/false]
ssl_certificate str: SSL connection certificate
target_db_id str: The ID of this resource.
user_name str: Database user name

azureClientId String: (Optional) Client id (relevant for "cloud-service-provider" only)
azureClientSecret String: (Optional) Client secret (relevant for "cloud-service-provider" only)
azureTenantId String: (Optional) Tenant id (relevant for "cloud-service-provider" only)
cloudServiceProvider String: (Optional) Cloud service provider (currently only supports Azure)
clusterMode Boolean: Cluster Mode
connectionType String: Type of connection to mssql database [credentials/cloud-identity/wallet/parent-target]
dbName String: Database name
dbServerCertificates String: (Optional) DB server certificates
dbServerName String: (Optional) Server name for certificate verification
dbType String: Database type: mysql/mssql/postgres/mongodb/snowflake/oracle/cassandra/redshift
description String: Description of the object
host String: Database host
key String: The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
mongodbAtlas Boolean: Flag, set database type to mongodb and the flag to true to create Mongo Atlas target
mongodbAtlasApiPrivateKey String: MongoDB Atlas private key
mongodbAtlasApiPublicKey String: MongoDB Atlas public key
mongodbAtlasProjectId String: MongoDB Atlas project ID
mongodbDefaultAuthDb String: MongoDB server default authentication database
mongodbUriOptions String: MongoDB server URI options (e.g. replicaSet=mySet&authSource=authDB)
name String: Target name
oracleServiceName String: Oracle db service name
oracleWalletLoginType String: Oracle Wallet login type (password/mtls)
oracleWalletP12FileData String: Oracle wallet p12 file data in base64
oracleWalletSsoFileData String: Oracle wallet sso file data in base64
parentTargetName String: Name of the parent target, relevant only when connection-type is parent-target
port String: Database port
pwd String: Database password
snowflakeAccount String: Snowflake account name
snowflakeApiPrivateKey String: RSA Private key (base64 encoded)
snowflakeApiPrivateKeyPassword String: The Private key passphrase
ssl Boolean: Enable/Disable SSL [true/false]
sslCertificate String: SSL connection certificate
targetDbId String: The ID of this resource.
userName String: Database user name