Database Targets
You can define a database target to be used with Database Dynamic Secrets.
Available database targets:
-
MySQL
-
PostgreSQL
-
Redshift
-
MSSQL
-
MongoDB
-
Snowflake
-
Oracle
-
Cassandra
-
HanaDB
-
Redis
Tip
To create a database target from Akeyless CLI, choose the database type within the
create-db-target
command
In order to create database targets you can define the following fields on Akeyless Console UI or using Akeyless CLI:
akeyless create-db-target
--name <Target name>
--db-type <Database type> # mysql/mssql/hanadb/postgres/mongodb/snowflake/oracle/cassandra/redshift
--user-name <Database user name>
--host <Database host>
--pwd <Database password>
--port <Database port>
Depending on your Database type, please provide the relevant settings accordingly:
MySql
Name: A unique name for the target. The name can include the path to the virtual folder in which you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
DB Type - Database type - mysql
.
DB Username - Privilege database user name with sufficient rights to create users.
DB Password- Password of the database privilege user name.
DB Hostname- Target database hostname or IP address.
DB Port- Target database port.
DB Name - Target database name.
Use SSL - To enable SSL,requires SSL certificate.
Advanced:
DB Server Certificate - Set of root certificate authorities in base64 encoding used by clients to verify server certificates.
DB Server Name - The server name is used to verify the hostname on the returned certificates unless InsecureSkipVerify is provided. It is also included in the client's handshake to support virtual hosting unless it is an IP address
PostgreSQL
Name: A unique name for the target. The name can include the path to the virtual folder in which you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
DB Type - Database type - postgres
.
DB Username - Privilege database user name with sufficient rights to create users.
DB Password- Password of the database privilege user name.
DB Hostname- Target database hostname or IP address.
DB Port- Target database port.
DB Name - Target database name.
MSSQL
Name: A unique name for the target. The name can include the path to the virtual folder in which you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
DB Type - Database type - mssql
.
DB Username - Privilege database user name with sufficient rights to create users.
DB Password- Password of the database privilege user name.
DB Hostname- Target database hostname or IP address.
DB Port- Target database port.
DB Name - Target database name.
Redshift
Name: A unique name for the target. The name can include the path to the virtual folder where you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
DB Type - Database type - redshift
.
DB Username - Privilege database user name with sufficient rights to create users.
DB Password- Password of the database privilege user name.
DB Hostname- Target database hostname or IP address.
DB Port- Target database port.
DB Name - Target database name.
SSL - Check to enable SSL.
Oracle
-Name: A unique name for the target. The name can include the path to the virtual folder in which you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
DB Type - Database type - oracle
.
DB Username - Privilege database user name with sufficient rights to create users.
DB Password- Password of the database privilege user name.
DB Hostname- Target database hostname or IP address.
DB Port- Target database port.
Service Name - Target database name.
MongoDB
Name: A unique name for the target. The name can include the path to the virtual folder in which you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
DB Type - Database type - mongodb
.
DB Username - Privilege database user name with sufficient rights to create users.
DB Password- Password of the database privilege user name.
Host and Port- Target database hostname or IP address with port.
Advanced:
Default Authentication DB - MongoDB default authentication database.
Options - URI options (e.g. replicaSet=mySet&authSource=authDB)
Mongo Atlas
Name: A unique name for the target. The name can include the path to the virtual folder in which you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
DB Type - Database type - mongodb
.
DB Name - Target database name.
Project ID - MongoDB Atlas project ID
API public key - MongoDB Atlas public key
API private key - MongoDB Atlas private key
Snowflake
Name: A unique name for the target. The name can include the path to the virtual folder in which you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
Authentication Type - Select your authentication type, User-Password or RSA Private Key.
Account Username - Username for a Snowflake user administrator (with the USERADMIN role or higher).
Account Password - Password for the Snowflake user administrator account.
RSA Key - RSA Private key (base64 encoded), associated with the public key defined in Snowflake connection. For more information on how to get this key, check this guide.
Key Passphrase - The Private key passphrase.
DB Name - Target database name within your Snowflake account.
Account Name - Snowflake account name in xy12345.region.cloud_provider
format. Please note that you can find this string in your Snowflake URL.
Cassandra
Name: A unique name for the target. The name can include the path to the virtual folder in which you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
DB Type - Database type - cassandra
.
DB Username - Privilege database user name with sufficient rights to create users.
DB Password- Password of the database privilege user name.
DB Hostname- Target database hostname or IP address.
DB Port- Target database port.
DB Name - Target database name.
HanaDB
-Name: A unique name for the target. The name can include the path to the virtual folder in which you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
DB Type - Database type - hanadb
.
DB Username - Privilege database user name with sufficient rights to create users.
DB Password- Password of the database privilege user name.
DB Hostname- Target database hostname or IP address.
DB Port- Target database port.
DB Name - Target database name.
Use SSL - To enable SSL,requires SSL certificate.
Redis
Name: A unique name for the target. The name can include the path to the virtual folder in which you want to create the new target, using slash /
separators. If the folder does not exist, it will be created together with the target.
DB Type - Database type - redis
.
DB Username - Privilege database user name with sufficient rights to create users.
DB Password- Password of the database privilege user name.
DB Hostname- Target database hostname or IP address.
DB Port- Target database port.
DB Name - Target database name.
Use SSL - To enable SSL,requires SSL certificate.
Usage
akeyless create-db-target
command includes all available databases targets, please follow the relevant database section for the relevant fields.
You can find the complete list of parameters for this command in the CLI Reference - Akeyless Database Targets section.
Updated about 1 month ago