1. Pulumi Registry
  2. HashiCorp Vault
  3. API Docs
  4. database
  5. SecretBackendConnection
vault logo
HashiCorp Vault v5.10.0, Mar 21 23

vault.database.SecretBackendConnection

Import

Database secret backend connections can be imported using the backend, /config/, and the name e.g.

 $ pulumi import vault:database/secretBackendConnection:SecretBackendConnection example postgres/config/postgres

Example Usage

using System.Collections.Generic;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var db = new Vault.Mount("db", new()
    {
        Path = "postgres",
        Type = "database",
    });

    var postgres = new Vault.Database.SecretBackendConnection("postgres", new()
    {
        Backend = db.Path,
        AllowedRoles = new[]
        {
            "dev",
            "prod",
        },
        Postgresql = new Vault.Database.Inputs.SecretBackendConnectionPostgresqlArgs
        {
            ConnectionUrl = "postgres://username:password@host:port/database",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v5/go/vault"
	"github.com/pulumi/pulumi-vault/sdk/v5/go/vault/database"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		db, err := vault.NewMount(ctx, "db", &vault.MountArgs{
			Path: pulumi.String("postgres"),
			Type: pulumi.String("database"),
		})
		if err != nil {
			return err
		}
		_, err = database.NewSecretBackendConnection(ctx, "postgres", &database.SecretBackendConnectionArgs{
			Backend: db.Path,
			AllowedRoles: pulumi.StringArray{
				pulumi.String("dev"),
				pulumi.String("prod"),
			},
			Postgresql: &database.SecretBackendConnectionPostgresqlArgs{
				ConnectionUrl: pulumi.String("postgres://username:password@host:port/database"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.Mount;
import com.pulumi.vault.MountArgs;
import com.pulumi.vault.database.SecretBackendConnection;
import com.pulumi.vault.database.SecretBackendConnectionArgs;
import com.pulumi.vault.database.inputs.SecretBackendConnectionPostgresqlArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var db = new Mount("db", MountArgs.builder()        
            .path("postgres")
            .type("database")
            .build());

        var postgres = new SecretBackendConnection("postgres", SecretBackendConnectionArgs.builder()        
            .backend(db.path())
            .allowedRoles(            
                "dev",
                "prod")
            .postgresql(SecretBackendConnectionPostgresqlArgs.builder()
                .connectionUrl("postgres://username:password@host:port/database")
                .build())
            .build());

    }
}

import pulumi
import pulumi_vault as vault

db = vault.Mount("db",
    path="postgres",
    type="database")
postgres = vault.database.SecretBackendConnection("postgres",
    backend=db.path,
    allowed_roles=[
        "dev",
        "prod",
    ],
    postgresql=vault.database.SecretBackendConnectionPostgresqlArgs(
        connection_url="postgres://username:password@host:port/database",
    ))

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

const db = new vault.Mount("db", {
    path: "postgres",
    type: "database",
});
const postgres = new vault.database.SecretBackendConnection("postgres", {
    backend: db.path,
    allowedRoles: [
        "dev",
        "prod",
    ],
    postgresql: {
        connectionUrl: "postgres://username:password@host:port/database",
    },
});

resources:
  db:
    type: vault:Mount
    properties:
      path: postgres
      type: database
  postgres:
    type: vault:database:SecretBackendConnection
    properties:
      backend: ${db.path}
      allowedRoles:
        - dev
        - prod
      postgresql:
        connectionUrl: postgres://username:password@host:port/database

Create SecretBackendConnection Resource

new SecretBackendConnection(name: string, args: SecretBackendConnectionArgs, opts?: CustomResourceOptions);
@overload
def SecretBackendConnection(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            allowed_roles: Optional[Sequence[str]] = None,
                            backend: Optional[str] = None,
                            cassandra: Optional[SecretBackendConnectionCassandraArgs] = None,
                            couchbase: Optional[SecretBackendConnectionCouchbaseArgs] = None,
                            data: Optional[Mapping[str, Any]] = None,
                            elasticsearch: Optional[SecretBackendConnectionElasticsearchArgs] = None,
                            hana: Optional[SecretBackendConnectionHanaArgs] = None,
                            influxdb: Optional[SecretBackendConnectionInfluxdbArgs] = None,
                            mongodb: Optional[SecretBackendConnectionMongodbArgs] = None,
                            mongodbatlas: Optional[SecretBackendConnectionMongodbatlasArgs] = None,
                            mssql: Optional[SecretBackendConnectionMssqlArgs] = None,
                            mysql: Optional[SecretBackendConnectionMysqlArgs] = None,
                            mysql_aurora: Optional[SecretBackendConnectionMysqlAuroraArgs] = None,
                            mysql_legacy: Optional[SecretBackendConnectionMysqlLegacyArgs] = None,
                            mysql_rds: Optional[SecretBackendConnectionMysqlRdsArgs] = None,
                            name: Optional[str] = None,
                            namespace: Optional[str] = None,
                            oracle: Optional[SecretBackendConnectionOracleArgs] = None,
                            plugin_name: Optional[str] = None,
                            postgresql: Optional[SecretBackendConnectionPostgresqlArgs] = None,
                            redis: Optional[SecretBackendConnectionRedisArgs] = None,
                            redis_elasticache: Optional[SecretBackendConnectionRedisElasticacheArgs] = None,
                            redshift: Optional[SecretBackendConnectionRedshiftArgs] = None,
                            root_rotation_statements: Optional[Sequence[str]] = None,
                            snowflake: Optional[SecretBackendConnectionSnowflakeArgs] = None,
                            verify_connection: Optional[bool] = None)
@overload
def SecretBackendConnection(resource_name: str,
                            args: SecretBackendConnectionArgs,
                            opts: Optional[ResourceOptions] = None)
func NewSecretBackendConnection(ctx *Context, name string, args SecretBackendConnectionArgs, opts ...ResourceOption) (*SecretBackendConnection, error)
public SecretBackendConnection(string name, SecretBackendConnectionArgs args, CustomResourceOptions? opts = null)
public SecretBackendConnection(String name, SecretBackendConnectionArgs args)
public SecretBackendConnection(String name, SecretBackendConnectionArgs args, CustomResourceOptions options)

type: vault:database:SecretBackendConnection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SecretBackendConnectionArgs
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 SecretBackendConnectionArgs
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 SecretBackendConnectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args SecretBackendConnectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args SecretBackendConnectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

SecretBackendConnection Resource Properties

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

Inputs

The SecretBackendConnection resource accepts the following input properties:

Backend string

The unique name of the Vault mount to configure.

AllowedRoles List<string>

A list of roles that are allowed to use this connection.

Cassandra SecretBackendConnectionCassandraArgs

A nested block containing configuration options for Cassandra connections.

Couchbase SecretBackendConnectionCouchbaseArgs

A nested block containing configuration options for Couchbase connections.

Data Dictionary<string, object>

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

Elasticsearch SecretBackendConnectionElasticsearchArgs

A nested block containing configuration options for Elasticsearch connections.

Hana SecretBackendConnectionHanaArgs

A nested block containing configuration options for SAP HanaDB connections.

Influxdb SecretBackendConnectionInfluxdbArgs

A nested block containing configuration options for InfluxDB connections.

Mongodb SecretBackendConnectionMongodbArgs

A nested block containing configuration options for MongoDB connections.

Mongodbatlas SecretBackendConnectionMongodbatlasArgs

A nested block containing configuration options for MongoDB Atlas connections.

Mssql SecretBackendConnectionMssqlArgs

A nested block containing configuration options for MSSQL connections.

Mysql SecretBackendConnectionMysqlArgs

A nested block containing configuration options for MySQL connections.

MysqlAurora SecretBackendConnectionMysqlAuroraArgs

A nested block containing configuration options for Aurora MySQL connections.

MysqlLegacy SecretBackendConnectionMysqlLegacyArgs

A nested block containing configuration options for legacy MySQL connections.

MysqlRds SecretBackendConnectionMysqlRdsArgs

A nested block containing configuration options for RDS MySQL connections.

Name string

A unique name to give the database connection.

Namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

Oracle SecretBackendConnectionOracleArgs

A nested block containing configuration options for Oracle connections.

PluginName string

Specifies the name of the plugin to use.

Postgresql SecretBackendConnectionPostgresqlArgs

A nested block containing configuration options for PostgreSQL connections.

Redis SecretBackendConnectionRedisArgs

A nested block containing configuration options for Redis connections.

RedisElasticache SecretBackendConnectionRedisElasticacheArgs

A nested block containing configuration options for Redis ElastiCache connections.

Redshift SecretBackendConnectionRedshiftArgs

Connection parameters for the redshift-database-plugin plugin.

RootRotationStatements List<string>

A list of database statements to be executed to rotate the root user's credentials.

Snowflake SecretBackendConnectionSnowflakeArgs

A nested block containing configuration options for Snowflake connections.

VerifyConnection bool

Whether the connection should be verified on initial configuration or not.

Backend string

The unique name of the Vault mount to configure.

AllowedRoles []string

A list of roles that are allowed to use this connection.

Cassandra SecretBackendConnectionCassandraArgs

A nested block containing configuration options for Cassandra connections.

Couchbase SecretBackendConnectionCouchbaseArgs

A nested block containing configuration options for Couchbase connections.

Data map[string]interface{}

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

Elasticsearch SecretBackendConnectionElasticsearchArgs

A nested block containing configuration options for Elasticsearch connections.

Hana SecretBackendConnectionHanaArgs

A nested block containing configuration options for SAP HanaDB connections.

Influxdb SecretBackendConnectionInfluxdbArgs

A nested block containing configuration options for InfluxDB connections.

Mongodb SecretBackendConnectionMongodbArgs

A nested block containing configuration options for MongoDB connections.

Mongodbatlas SecretBackendConnectionMongodbatlasArgs

A nested block containing configuration options for MongoDB Atlas connections.

Mssql SecretBackendConnectionMssqlArgs

A nested block containing configuration options for MSSQL connections.

Mysql SecretBackendConnectionMysqlArgs

A nested block containing configuration options for MySQL connections.

MysqlAurora SecretBackendConnectionMysqlAuroraArgs

A nested block containing configuration options for Aurora MySQL connections.

MysqlLegacy SecretBackendConnectionMysqlLegacyArgs

A nested block containing configuration options for legacy MySQL connections.

MysqlRds SecretBackendConnectionMysqlRdsArgs

A nested block containing configuration options for RDS MySQL connections.

Name string

A unique name to give the database connection.

Namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

Oracle SecretBackendConnectionOracleArgs

A nested block containing configuration options for Oracle connections.

PluginName string

Specifies the name of the plugin to use.

Postgresql SecretBackendConnectionPostgresqlArgs

A nested block containing configuration options for PostgreSQL connections.

Redis SecretBackendConnectionRedisArgs

A nested block containing configuration options for Redis connections.

RedisElasticache SecretBackendConnectionRedisElasticacheArgs

A nested block containing configuration options for Redis ElastiCache connections.

Redshift SecretBackendConnectionRedshiftArgs

Connection parameters for the redshift-database-plugin plugin.

RootRotationStatements []string

A list of database statements to be executed to rotate the root user's credentials.

Snowflake SecretBackendConnectionSnowflakeArgs

A nested block containing configuration options for Snowflake connections.

VerifyConnection bool

Whether the connection should be verified on initial configuration or not.

backend String

The unique name of the Vault mount to configure.

allowedRoles List<String>

A list of roles that are allowed to use this connection.

cassandra SecretBackendConnectionCassandraArgs

A nested block containing configuration options for Cassandra connections.

couchbase SecretBackendConnectionCouchbaseArgs

A nested block containing configuration options for Couchbase connections.

data Map<String,Object>

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

elasticsearch SecretBackendConnectionElasticsearchArgs

A nested block containing configuration options for Elasticsearch connections.

hana SecretBackendConnectionHanaArgs

A nested block containing configuration options for SAP HanaDB connections.

influxdb SecretBackendConnectionInfluxdbArgs

A nested block containing configuration options for InfluxDB connections.

mongodb SecretBackendConnectionMongodbArgs

A nested block containing configuration options for MongoDB connections.

mongodbatlas SecretBackendConnectionMongodbatlasArgs

A nested block containing configuration options for MongoDB Atlas connections.

mssql SecretBackendConnectionMssqlArgs

A nested block containing configuration options for MSSQL connections.

mysql SecretBackendConnectionMysqlArgs

A nested block containing configuration options for MySQL connections.

mysqlAurora SecretBackendConnectionMysqlAuroraArgs

A nested block containing configuration options for Aurora MySQL connections.

mysqlLegacy SecretBackendConnectionMysqlLegacyArgs

A nested block containing configuration options for legacy MySQL connections.

mysqlRds SecretBackendConnectionMysqlRdsArgs

A nested block containing configuration options for RDS MySQL connections.

name String

A unique name to give the database connection.

namespace String

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

oracle SecretBackendConnectionOracleArgs

A nested block containing configuration options for Oracle connections.

pluginName String

Specifies the name of the plugin to use.

postgresql SecretBackendConnectionPostgresqlArgs

A nested block containing configuration options for PostgreSQL connections.

redis SecretBackendConnectionRedisArgs

A nested block containing configuration options for Redis connections.

redisElasticache SecretBackendConnectionRedisElasticacheArgs

A nested block containing configuration options for Redis ElastiCache connections.

redshift SecretBackendConnectionRedshiftArgs

Connection parameters for the redshift-database-plugin plugin.

rootRotationStatements List<String>

A list of database statements to be executed to rotate the root user's credentials.

snowflake SecretBackendConnectionSnowflakeArgs

A nested block containing configuration options for Snowflake connections.

verifyConnection Boolean

Whether the connection should be verified on initial configuration or not.

backend string

The unique name of the Vault mount to configure.

allowedRoles string[]

A list of roles that are allowed to use this connection.

cassandra SecretBackendConnectionCassandraArgs

A nested block containing configuration options for Cassandra connections.

couchbase SecretBackendConnectionCouchbaseArgs

A nested block containing configuration options for Couchbase connections.

data {[key: string]: any}

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

elasticsearch SecretBackendConnectionElasticsearchArgs

A nested block containing configuration options for Elasticsearch connections.

hana SecretBackendConnectionHanaArgs

A nested block containing configuration options for SAP HanaDB connections.

influxdb SecretBackendConnectionInfluxdbArgs

A nested block containing configuration options for InfluxDB connections.

mongodb SecretBackendConnectionMongodbArgs

A nested block containing configuration options for MongoDB connections.

mongodbatlas SecretBackendConnectionMongodbatlasArgs

A nested block containing configuration options for MongoDB Atlas connections.

mssql SecretBackendConnectionMssqlArgs

A nested block containing configuration options for MSSQL connections.

mysql SecretBackendConnectionMysqlArgs

A nested block containing configuration options for MySQL connections.

mysqlAurora SecretBackendConnectionMysqlAuroraArgs

A nested block containing configuration options for Aurora MySQL connections.

mysqlLegacy SecretBackendConnectionMysqlLegacyArgs

A nested block containing configuration options for legacy MySQL connections.

mysqlRds SecretBackendConnectionMysqlRdsArgs

A nested block containing configuration options for RDS MySQL connections.

name string

A unique name to give the database connection.

namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

oracle SecretBackendConnectionOracleArgs

A nested block containing configuration options for Oracle connections.

pluginName string

Specifies the name of the plugin to use.

postgresql SecretBackendConnectionPostgresqlArgs

A nested block containing configuration options for PostgreSQL connections.

redis SecretBackendConnectionRedisArgs

A nested block containing configuration options for Redis connections.

redisElasticache SecretBackendConnectionRedisElasticacheArgs

A nested block containing configuration options for Redis ElastiCache connections.

redshift SecretBackendConnectionRedshiftArgs

Connection parameters for the redshift-database-plugin plugin.

rootRotationStatements string[]

A list of database statements to be executed to rotate the root user's credentials.

snowflake SecretBackendConnectionSnowflakeArgs

A nested block containing configuration options for Snowflake connections.

verifyConnection boolean

Whether the connection should be verified on initial configuration or not.

backend str

The unique name of the Vault mount to configure.

allowed_roles Sequence[str]

A list of roles that are allowed to use this connection.

cassandra SecretBackendConnectionCassandraArgs

A nested block containing configuration options for Cassandra connections.

couchbase SecretBackendConnectionCouchbaseArgs

A nested block containing configuration options for Couchbase connections.

data Mapping[str, Any]

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

elasticsearch SecretBackendConnectionElasticsearchArgs

A nested block containing configuration options for Elasticsearch connections.

hana SecretBackendConnectionHanaArgs

A nested block containing configuration options for SAP HanaDB connections.

influxdb SecretBackendConnectionInfluxdbArgs

A nested block containing configuration options for InfluxDB connections.

mongodb SecretBackendConnectionMongodbArgs

A nested block containing configuration options for MongoDB connections.

mongodbatlas SecretBackendConnectionMongodbatlasArgs

A nested block containing configuration options for MongoDB Atlas connections.

mssql SecretBackendConnectionMssqlArgs

A nested block containing configuration options for MSSQL connections.

mysql SecretBackendConnectionMysqlArgs

A nested block containing configuration options for MySQL connections.

mysql_aurora SecretBackendConnectionMysqlAuroraArgs

A nested block containing configuration options for Aurora MySQL connections.

mysql_legacy SecretBackendConnectionMysqlLegacyArgs

A nested block containing configuration options for legacy MySQL connections.

mysql_rds SecretBackendConnectionMysqlRdsArgs

A nested block containing configuration options for RDS MySQL connections.

name str

A unique name to give the database connection.

namespace str

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

oracle SecretBackendConnectionOracleArgs

A nested block containing configuration options for Oracle connections.

plugin_name str

Specifies the name of the plugin to use.

postgresql SecretBackendConnectionPostgresqlArgs

A nested block containing configuration options for PostgreSQL connections.

redis SecretBackendConnectionRedisArgs

A nested block containing configuration options for Redis connections.

redis_elasticache SecretBackendConnectionRedisElasticacheArgs

A nested block containing configuration options for Redis ElastiCache connections.

redshift SecretBackendConnectionRedshiftArgs

Connection parameters for the redshift-database-plugin plugin.

root_rotation_statements Sequence[str]

A list of database statements to be executed to rotate the root user's credentials.

snowflake SecretBackendConnectionSnowflakeArgs

A nested block containing configuration options for Snowflake connections.

verify_connection bool

Whether the connection should be verified on initial configuration or not.

backend String

The unique name of the Vault mount to configure.

allowedRoles List<String>

A list of roles that are allowed to use this connection.

cassandra Property Map

A nested block containing configuration options for Cassandra connections.

couchbase Property Map

A nested block containing configuration options for Couchbase connections.

data Map<Any>

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

elasticsearch Property Map

A nested block containing configuration options for Elasticsearch connections.

hana Property Map

A nested block containing configuration options for SAP HanaDB connections.

influxdb Property Map

A nested block containing configuration options for InfluxDB connections.

mongodb Property Map

A nested block containing configuration options for MongoDB connections.

mongodbatlas Property Map

A nested block containing configuration options for MongoDB Atlas connections.

mssql Property Map

A nested block containing configuration options for MSSQL connections.

mysql Property Map

A nested block containing configuration options for MySQL connections.

mysqlAurora Property Map

A nested block containing configuration options for Aurora MySQL connections.

mysqlLegacy Property Map

A nested block containing configuration options for legacy MySQL connections.

mysqlRds Property Map

A nested block containing configuration options for RDS MySQL connections.

name String

A unique name to give the database connection.

namespace String

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

oracle Property Map

A nested block containing configuration options for Oracle connections.

pluginName String

Specifies the name of the plugin to use.

postgresql Property Map

A nested block containing configuration options for PostgreSQL connections.

redis Property Map

A nested block containing configuration options for Redis connections.

redisElasticache Property Map

A nested block containing configuration options for Redis ElastiCache connections.

redshift Property Map

Connection parameters for the redshift-database-plugin plugin.

rootRotationStatements List<String>

A list of database statements to be executed to rotate the root user's credentials.

snowflake Property Map

A nested block containing configuration options for Snowflake connections.

verifyConnection Boolean

Whether the connection should be verified on initial configuration or not.

Outputs

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

Get an existing SecretBackendConnection 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?: SecretBackendConnectionState, opts?: CustomResourceOptions): SecretBackendConnection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_roles: Optional[Sequence[str]] = None,
        backend: Optional[str] = None,
        cassandra: Optional[SecretBackendConnectionCassandraArgs] = None,
        couchbase: Optional[SecretBackendConnectionCouchbaseArgs] = None,
        data: Optional[Mapping[str, Any]] = None,
        elasticsearch: Optional[SecretBackendConnectionElasticsearchArgs] = None,
        hana: Optional[SecretBackendConnectionHanaArgs] = None,
        influxdb: Optional[SecretBackendConnectionInfluxdbArgs] = None,
        mongodb: Optional[SecretBackendConnectionMongodbArgs] = None,
        mongodbatlas: Optional[SecretBackendConnectionMongodbatlasArgs] = None,
        mssql: Optional[SecretBackendConnectionMssqlArgs] = None,
        mysql: Optional[SecretBackendConnectionMysqlArgs] = None,
        mysql_aurora: Optional[SecretBackendConnectionMysqlAuroraArgs] = None,
        mysql_legacy: Optional[SecretBackendConnectionMysqlLegacyArgs] = None,
        mysql_rds: Optional[SecretBackendConnectionMysqlRdsArgs] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        oracle: Optional[SecretBackendConnectionOracleArgs] = None,
        plugin_name: Optional[str] = None,
        postgresql: Optional[SecretBackendConnectionPostgresqlArgs] = None,
        redis: Optional[SecretBackendConnectionRedisArgs] = None,
        redis_elasticache: Optional[SecretBackendConnectionRedisElasticacheArgs] = None,
        redshift: Optional[SecretBackendConnectionRedshiftArgs] = None,
        root_rotation_statements: Optional[Sequence[str]] = None,
        snowflake: Optional[SecretBackendConnectionSnowflakeArgs] = None,
        verify_connection: Optional[bool] = None) -> SecretBackendConnection
func GetSecretBackendConnection(ctx *Context, name string, id IDInput, state *SecretBackendConnectionState, opts ...ResourceOption) (*SecretBackendConnection, error)
public static SecretBackendConnection Get(string name, Input<string> id, SecretBackendConnectionState? state, CustomResourceOptions? opts = null)
public static SecretBackendConnection get(String name, Output<String> id, SecretBackendConnectionState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AllowedRoles List<string>

A list of roles that are allowed to use this connection.

Backend string

The unique name of the Vault mount to configure.

Cassandra SecretBackendConnectionCassandraArgs

A nested block containing configuration options for Cassandra connections.

Couchbase SecretBackendConnectionCouchbaseArgs

A nested block containing configuration options for Couchbase connections.

Data Dictionary<string, object>

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

Elasticsearch SecretBackendConnectionElasticsearchArgs

A nested block containing configuration options for Elasticsearch connections.

Hana SecretBackendConnectionHanaArgs

A nested block containing configuration options for SAP HanaDB connections.

Influxdb SecretBackendConnectionInfluxdbArgs

A nested block containing configuration options for InfluxDB connections.

Mongodb SecretBackendConnectionMongodbArgs

A nested block containing configuration options for MongoDB connections.

Mongodbatlas SecretBackendConnectionMongodbatlasArgs

A nested block containing configuration options for MongoDB Atlas connections.

Mssql SecretBackendConnectionMssqlArgs

A nested block containing configuration options for MSSQL connections.

Mysql SecretBackendConnectionMysqlArgs

A nested block containing configuration options for MySQL connections.

MysqlAurora SecretBackendConnectionMysqlAuroraArgs

A nested block containing configuration options for Aurora MySQL connections.

MysqlLegacy SecretBackendConnectionMysqlLegacyArgs

A nested block containing configuration options for legacy MySQL connections.

MysqlRds SecretBackendConnectionMysqlRdsArgs

A nested block containing configuration options for RDS MySQL connections.

Name string

A unique name to give the database connection.

Namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

Oracle SecretBackendConnectionOracleArgs

A nested block containing configuration options for Oracle connections.

PluginName string

Specifies the name of the plugin to use.

Postgresql SecretBackendConnectionPostgresqlArgs

A nested block containing configuration options for PostgreSQL connections.

Redis SecretBackendConnectionRedisArgs

A nested block containing configuration options for Redis connections.

RedisElasticache SecretBackendConnectionRedisElasticacheArgs

A nested block containing configuration options for Redis ElastiCache connections.

Redshift SecretBackendConnectionRedshiftArgs

Connection parameters for the redshift-database-plugin plugin.

RootRotationStatements List<string>

A list of database statements to be executed to rotate the root user's credentials.

Snowflake SecretBackendConnectionSnowflakeArgs

A nested block containing configuration options for Snowflake connections.

VerifyConnection bool

Whether the connection should be verified on initial configuration or not.

AllowedRoles []string

A list of roles that are allowed to use this connection.

Backend string

The unique name of the Vault mount to configure.

Cassandra SecretBackendConnectionCassandraArgs

A nested block containing configuration options for Cassandra connections.

Couchbase SecretBackendConnectionCouchbaseArgs

A nested block containing configuration options for Couchbase connections.

Data map[string]interface{}

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

Elasticsearch SecretBackendConnectionElasticsearchArgs

A nested block containing configuration options for Elasticsearch connections.

Hana SecretBackendConnectionHanaArgs

A nested block containing configuration options for SAP HanaDB connections.

Influxdb SecretBackendConnectionInfluxdbArgs

A nested block containing configuration options for InfluxDB connections.

Mongodb SecretBackendConnectionMongodbArgs

A nested block containing configuration options for MongoDB connections.

Mongodbatlas SecretBackendConnectionMongodbatlasArgs

A nested block containing configuration options for MongoDB Atlas connections.

Mssql SecretBackendConnectionMssqlArgs

A nested block containing configuration options for MSSQL connections.

Mysql SecretBackendConnectionMysqlArgs

A nested block containing configuration options for MySQL connections.

MysqlAurora SecretBackendConnectionMysqlAuroraArgs

A nested block containing configuration options for Aurora MySQL connections.

MysqlLegacy SecretBackendConnectionMysqlLegacyArgs

A nested block containing configuration options for legacy MySQL connections.

MysqlRds SecretBackendConnectionMysqlRdsArgs

A nested block containing configuration options for RDS MySQL connections.

Name string

A unique name to give the database connection.

Namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

Oracle SecretBackendConnectionOracleArgs

A nested block containing configuration options for Oracle connections.

PluginName string

Specifies the name of the plugin to use.

Postgresql SecretBackendConnectionPostgresqlArgs

A nested block containing configuration options for PostgreSQL connections.

Redis SecretBackendConnectionRedisArgs

A nested block containing configuration options for Redis connections.

RedisElasticache SecretBackendConnectionRedisElasticacheArgs

A nested block containing configuration options for Redis ElastiCache connections.

Redshift SecretBackendConnectionRedshiftArgs

Connection parameters for the redshift-database-plugin plugin.

RootRotationStatements []string

A list of database statements to be executed to rotate the root user's credentials.

Snowflake SecretBackendConnectionSnowflakeArgs

A nested block containing configuration options for Snowflake connections.

VerifyConnection bool

Whether the connection should be verified on initial configuration or not.

allowedRoles List<String>

A list of roles that are allowed to use this connection.

backend String

The unique name of the Vault mount to configure.

cassandra SecretBackendConnectionCassandraArgs

A nested block containing configuration options for Cassandra connections.

couchbase SecretBackendConnectionCouchbaseArgs

A nested block containing configuration options for Couchbase connections.

data Map<String,Object>

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

elasticsearch SecretBackendConnectionElasticsearchArgs

A nested block containing configuration options for Elasticsearch connections.

hana SecretBackendConnectionHanaArgs

A nested block containing configuration options for SAP HanaDB connections.

influxdb SecretBackendConnectionInfluxdbArgs

A nested block containing configuration options for InfluxDB connections.

mongodb SecretBackendConnectionMongodbArgs

A nested block containing configuration options for MongoDB connections.

mongodbatlas SecretBackendConnectionMongodbatlasArgs

A nested block containing configuration options for MongoDB Atlas connections.

mssql SecretBackendConnectionMssqlArgs

A nested block containing configuration options for MSSQL connections.

mysql SecretBackendConnectionMysqlArgs

A nested block containing configuration options for MySQL connections.

mysqlAurora SecretBackendConnectionMysqlAuroraArgs

A nested block containing configuration options for Aurora MySQL connections.

mysqlLegacy SecretBackendConnectionMysqlLegacyArgs

A nested block containing configuration options for legacy MySQL connections.

mysqlRds SecretBackendConnectionMysqlRdsArgs

A nested block containing configuration options for RDS MySQL connections.

name String

A unique name to give the database connection.

namespace String

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

oracle SecretBackendConnectionOracleArgs

A nested block containing configuration options for Oracle connections.

pluginName String

Specifies the name of the plugin to use.

postgresql SecretBackendConnectionPostgresqlArgs

A nested block containing configuration options for PostgreSQL connections.

redis SecretBackendConnectionRedisArgs

A nested block containing configuration options for Redis connections.

redisElasticache SecretBackendConnectionRedisElasticacheArgs

A nested block containing configuration options for Redis ElastiCache connections.

redshift SecretBackendConnectionRedshiftArgs

Connection parameters for the redshift-database-plugin plugin.

rootRotationStatements List<String>

A list of database statements to be executed to rotate the root user's credentials.

snowflake SecretBackendConnectionSnowflakeArgs

A nested block containing configuration options for Snowflake connections.

verifyConnection Boolean

Whether the connection should be verified on initial configuration or not.

allowedRoles string[]

A list of roles that are allowed to use this connection.

backend string

The unique name of the Vault mount to configure.

cassandra SecretBackendConnectionCassandraArgs

A nested block containing configuration options for Cassandra connections.

couchbase SecretBackendConnectionCouchbaseArgs

A nested block containing configuration options for Couchbase connections.

data {[key: string]: any}

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

elasticsearch SecretBackendConnectionElasticsearchArgs

A nested block containing configuration options for Elasticsearch connections.

hana SecretBackendConnectionHanaArgs

A nested block containing configuration options for SAP HanaDB connections.

influxdb SecretBackendConnectionInfluxdbArgs

A nested block containing configuration options for InfluxDB connections.

mongodb SecretBackendConnectionMongodbArgs

A nested block containing configuration options for MongoDB connections.

mongodbatlas SecretBackendConnectionMongodbatlasArgs

A nested block containing configuration options for MongoDB Atlas connections.

mssql SecretBackendConnectionMssqlArgs

A nested block containing configuration options for MSSQL connections.

mysql SecretBackendConnectionMysqlArgs

A nested block containing configuration options for MySQL connections.

mysqlAurora SecretBackendConnectionMysqlAuroraArgs

A nested block containing configuration options for Aurora MySQL connections.

mysqlLegacy SecretBackendConnectionMysqlLegacyArgs

A nested block containing configuration options for legacy MySQL connections.

mysqlRds SecretBackendConnectionMysqlRdsArgs

A nested block containing configuration options for RDS MySQL connections.

name string

A unique name to give the database connection.

namespace string

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

oracle SecretBackendConnectionOracleArgs

A nested block containing configuration options for Oracle connections.

pluginName string

Specifies the name of the plugin to use.

postgresql SecretBackendConnectionPostgresqlArgs

A nested block containing configuration options for PostgreSQL connections.

redis SecretBackendConnectionRedisArgs

A nested block containing configuration options for Redis connections.

redisElasticache SecretBackendConnectionRedisElasticacheArgs

A nested block containing configuration options for Redis ElastiCache connections.

redshift SecretBackendConnectionRedshiftArgs

Connection parameters for the redshift-database-plugin plugin.

rootRotationStatements string[]

A list of database statements to be executed to rotate the root user's credentials.

snowflake SecretBackendConnectionSnowflakeArgs

A nested block containing configuration options for Snowflake connections.

verifyConnection boolean

Whether the connection should be verified on initial configuration or not.

allowed_roles Sequence[str]

A list of roles that are allowed to use this connection.

backend str

The unique name of the Vault mount to configure.

cassandra SecretBackendConnectionCassandraArgs

A nested block containing configuration options for Cassandra connections.

couchbase SecretBackendConnectionCouchbaseArgs

A nested block containing configuration options for Couchbase connections.

data Mapping[str, Any]

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

elasticsearch SecretBackendConnectionElasticsearchArgs

A nested block containing configuration options for Elasticsearch connections.

hana SecretBackendConnectionHanaArgs

A nested block containing configuration options for SAP HanaDB connections.

influxdb SecretBackendConnectionInfluxdbArgs

A nested block containing configuration options for InfluxDB connections.

mongodb SecretBackendConnectionMongodbArgs

A nested block containing configuration options for MongoDB connections.

mongodbatlas SecretBackendConnectionMongodbatlasArgs

A nested block containing configuration options for MongoDB Atlas connections.

mssql SecretBackendConnectionMssqlArgs

A nested block containing configuration options for MSSQL connections.

mysql SecretBackendConnectionMysqlArgs

A nested block containing configuration options for MySQL connections.

mysql_aurora SecretBackendConnectionMysqlAuroraArgs

A nested block containing configuration options for Aurora MySQL connections.

mysql_legacy SecretBackendConnectionMysqlLegacyArgs

A nested block containing configuration options for legacy MySQL connections.

mysql_rds SecretBackendConnectionMysqlRdsArgs

A nested block containing configuration options for RDS MySQL connections.

name str

A unique name to give the database connection.

namespace str

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

oracle SecretBackendConnectionOracleArgs

A nested block containing configuration options for Oracle connections.

plugin_name str

Specifies the name of the plugin to use.

postgresql SecretBackendConnectionPostgresqlArgs

A nested block containing configuration options for PostgreSQL connections.

redis SecretBackendConnectionRedisArgs

A nested block containing configuration options for Redis connections.

redis_elasticache SecretBackendConnectionRedisElasticacheArgs

A nested block containing configuration options for Redis ElastiCache connections.

redshift SecretBackendConnectionRedshiftArgs

Connection parameters for the redshift-database-plugin plugin.

root_rotation_statements Sequence[str]

A list of database statements to be executed to rotate the root user's credentials.

snowflake SecretBackendConnectionSnowflakeArgs

A nested block containing configuration options for Snowflake connections.

verify_connection bool

Whether the connection should be verified on initial configuration or not.

allowedRoles List<String>

A list of roles that are allowed to use this connection.

backend String

The unique name of the Vault mount to configure.

cassandra Property Map

A nested block containing configuration options for Cassandra connections.

couchbase Property Map

A nested block containing configuration options for Couchbase connections.

data Map<Any>

A map of sensitive data to pass to the endpoint. Useful for templated connection strings.

elasticsearch Property Map

A nested block containing configuration options for Elasticsearch connections.

hana Property Map

A nested block containing configuration options for SAP HanaDB connections.

influxdb Property Map

A nested block containing configuration options for InfluxDB connections.

mongodb Property Map

A nested block containing configuration options for MongoDB connections.

mongodbatlas Property Map

A nested block containing configuration options for MongoDB Atlas connections.

mssql Property Map

A nested block containing configuration options for MSSQL connections.

mysql Property Map

A nested block containing configuration options for MySQL connections.

mysqlAurora Property Map

A nested block containing configuration options for Aurora MySQL connections.

mysqlLegacy Property Map

A nested block containing configuration options for legacy MySQL connections.

mysqlRds Property Map

A nested block containing configuration options for RDS MySQL connections.

name String

A unique name to give the database connection.

namespace String

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

oracle Property Map

A nested block containing configuration options for Oracle connections.

pluginName String

Specifies the name of the plugin to use.

postgresql Property Map

A nested block containing configuration options for PostgreSQL connections.

redis Property Map

A nested block containing configuration options for Redis connections.

redisElasticache Property Map

A nested block containing configuration options for Redis ElastiCache connections.

redshift Property Map

Connection parameters for the redshift-database-plugin plugin.

rootRotationStatements List<String>

A list of database statements to be executed to rotate the root user's credentials.

snowflake Property Map

A nested block containing configuration options for Snowflake connections.

verifyConnection Boolean

Whether the connection should be verified on initial configuration or not.

Supporting Types

SecretBackendConnectionCassandra

ConnectTimeout int

The number of seconds to use as a connection timeout.

Hosts List<string>

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

InsecureTls bool

Whether to skip verification of the server certificate when using TLS.

Password string

The root credential password used in the connection URL.

PemBundle string

Concatenated PEM blocks configuring the certificate chain.

PemJson string

A JSON structure configuring the certificate chain.

Port int

The default port to connect to if no port is specified as part of the host.

ProtocolVersion int

The CQL protocol version to use.

Tls bool

Whether to use TLS when connecting to Redis.

Username string

The root credential username used in the connection URL.

ConnectTimeout int

The number of seconds to use as a connection timeout.

Hosts []string

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

InsecureTls bool

Whether to skip verification of the server certificate when using TLS.

Password string

The root credential password used in the connection URL.

PemBundle string

Concatenated PEM blocks configuring the certificate chain.

PemJson string

A JSON structure configuring the certificate chain.

Port int

The default port to connect to if no port is specified as part of the host.

ProtocolVersion int

The CQL protocol version to use.

Tls bool

Whether to use TLS when connecting to Redis.

Username string

The root credential username used in the connection URL.

connectTimeout Integer

The number of seconds to use as a connection timeout.

hosts List<String>

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

insecureTls Boolean

Whether to skip verification of the server certificate when using TLS.

password String

The root credential password used in the connection URL.

pemBundle String

Concatenated PEM blocks configuring the certificate chain.

pemJson String

A JSON structure configuring the certificate chain.

port Integer

The default port to connect to if no port is specified as part of the host.

protocolVersion Integer

The CQL protocol version to use.

tls Boolean

Whether to use TLS when connecting to Redis.

username String

The root credential username used in the connection URL.

connectTimeout number

The number of seconds to use as a connection timeout.

hosts string[]

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

insecureTls boolean

Whether to skip verification of the server certificate when using TLS.

password string

The root credential password used in the connection URL.

pemBundle string

Concatenated PEM blocks configuring the certificate chain.

pemJson string

A JSON structure configuring the certificate chain.

port number

The default port to connect to if no port is specified as part of the host.

protocolVersion number

The CQL protocol version to use.

tls boolean

Whether to use TLS when connecting to Redis.

username string

The root credential username used in the connection URL.

connect_timeout int

The number of seconds to use as a connection timeout.

hosts Sequence[str]

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

insecure_tls bool

Whether to skip verification of the server certificate when using TLS.

password str

The root credential password used in the connection URL.

pem_bundle str

Concatenated PEM blocks configuring the certificate chain.

pem_json str

A JSON structure configuring the certificate chain.

port int

The default port to connect to if no port is specified as part of the host.

protocol_version int

The CQL protocol version to use.

tls bool

Whether to use TLS when connecting to Redis.

username str

The root credential username used in the connection URL.

connectTimeout Number

The number of seconds to use as a connection timeout.

hosts List<String>

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

insecureTls Boolean

Whether to skip verification of the server certificate when using TLS.

password String

The root credential password used in the connection URL.

pemBundle String

Concatenated PEM blocks configuring the certificate chain.

pemJson String

A JSON structure configuring the certificate chain.

port Number

The default port to connect to if no port is specified as part of the host.

protocolVersion Number

The CQL protocol version to use.

tls Boolean

Whether to use TLS when connecting to Redis.

username String

The root credential username used in the connection URL.

SecretBackendConnectionCouchbase

Hosts List<string>

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

Base64Pem string

Required if tls is true. Specifies the certificate authority of the Couchbase server, as a PEM certificate that has been base64 encoded.

BucketName string

Required for Couchbase versions prior to 6.5.0. This is only used to verify vault's connection to the server.

InsecureTls bool

Whether to skip verification of the server certificate when using TLS.

Tls bool

Whether to use TLS when connecting to Redis.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
Hosts []string

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

Base64Pem string

Required if tls is true. Specifies the certificate authority of the Couchbase server, as a PEM certificate that has been base64 encoded.

BucketName string

Required for Couchbase versions prior to 6.5.0. This is only used to verify vault's connection to the server.

InsecureTls bool

Whether to skip verification of the server certificate when using TLS.

Tls bool

Whether to use TLS when connecting to Redis.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
hosts List<String>

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

base64Pem String

Required if tls is true. Specifies the certificate authority of the Couchbase server, as a PEM certificate that has been base64 encoded.

bucketName String

Required for Couchbase versions prior to 6.5.0. This is only used to verify vault's connection to the server.

insecureTls Boolean

Whether to skip verification of the server certificate when using TLS.

tls Boolean

Whether to use TLS when connecting to Redis.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
hosts string[]

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

base64Pem string

Required if tls is true. Specifies the certificate authority of the Couchbase server, as a PEM certificate that has been base64 encoded.

bucketName string

Required for Couchbase versions prior to 6.5.0. This is only used to verify vault's connection to the server.

insecureTls boolean

Whether to skip verification of the server certificate when using TLS.

tls boolean

Whether to use TLS when connecting to Redis.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
hosts Sequence[str]

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

base64_pem str

Required if tls is true. Specifies the certificate authority of the Couchbase server, as a PEM certificate that has been base64 encoded.

bucket_name str

Required for Couchbase versions prior to 6.5.0. This is only used to verify vault's connection to the server.

insecure_tls bool

Whether to skip verification of the server certificate when using TLS.

tls bool

Whether to use TLS when connecting to Redis.

username_template str
  • Template describing how dynamic usernames are generated.
hosts List<String>

A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

base64Pem String

Required if tls is true. Specifies the certificate authority of the Couchbase server, as a PEM certificate that has been base64 encoded.

bucketName String

Required for Couchbase versions prior to 6.5.0. This is only used to verify vault's connection to the server.

insecureTls Boolean

Whether to skip verification of the server certificate when using TLS.

tls Boolean

Whether to use TLS when connecting to Redis.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionElasticsearch

Password string

The root credential password used in the connection URL.

Url string

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

Username string

The root credential username used in the connection URL.

CaCert string

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

CaPath string

The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity.

ClientCert string

The path to the certificate for the Elasticsearch client to present for communication.

ClientKey string

The path to the key for the Elasticsearch client to use for communication.

Insecure bool

Whether to disable certificate verification.

TlsServerName string

This, if set, is used to set the SNI host when connecting via TLS.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
Password string

The root credential password used in the connection URL.

Url string

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

Username string

The root credential username used in the connection URL.

CaCert string

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

CaPath string

The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity.

ClientCert string

The path to the certificate for the Elasticsearch client to present for communication.

ClientKey string

The path to the key for the Elasticsearch client to use for communication.

Insecure bool

Whether to disable certificate verification.

TlsServerName string

This, if set, is used to set the SNI host when connecting via TLS.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
password String

The root credential password used in the connection URL.

url String

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

username String

The root credential username used in the connection URL.

caCert String

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

caPath String

The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity.

clientCert String

The path to the certificate for the Elasticsearch client to present for communication.

clientKey String

The path to the key for the Elasticsearch client to use for communication.

insecure Boolean

Whether to disable certificate verification.

tlsServerName String

This, if set, is used to set the SNI host when connecting via TLS.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
password string

The root credential password used in the connection URL.

url string

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

username string

The root credential username used in the connection URL.

caCert string

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

caPath string

The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity.

clientCert string

The path to the certificate for the Elasticsearch client to present for communication.

clientKey string

The path to the key for the Elasticsearch client to use for communication.

insecure boolean

Whether to disable certificate verification.

tlsServerName string

This, if set, is used to set the SNI host when connecting via TLS.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
password str

The root credential password used in the connection URL.

url str

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

username str

The root credential username used in the connection URL.

ca_cert str

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

ca_path str

The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity.

client_cert str

The path to the certificate for the Elasticsearch client to present for communication.

client_key str

The path to the key for the Elasticsearch client to use for communication.

insecure bool

Whether to disable certificate verification.

tls_server_name str

This, if set, is used to set the SNI host when connecting via TLS.

username_template str
  • Template describing how dynamic usernames are generated.
password String

The root credential password used in the connection URL.

url String

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

username String

The root credential username used in the connection URL.

caCert String

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

caPath String

The path to a directory of PEM-encoded CA cert files to use to verify the Elasticsearch server's identity.

clientCert String

The path to the certificate for the Elasticsearch client to present for communication.

clientKey String

The path to the key for the Elasticsearch client to use for communication.

insecure Boolean

Whether to disable certificate verification.

tlsServerName String

This, if set, is used to set the SNI host when connecting via TLS.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionHana

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

DisableEscaping bool

Disable special character escaping in username and password.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

DisableEscaping bool

Disable special character escaping in username and password.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

disableEscaping Boolean

Disable special character escaping in username and password.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

disableEscaping boolean

Disable special character escaping in username and password.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

disable_escaping bool

Disable special character escaping in username and password.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

disableEscaping Boolean

Disable special character escaping in username and password.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

SecretBackendConnectionInfluxdb

Host string

The host to connect to.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

ConnectTimeout int

The number of seconds to use as a connection timeout.

InsecureTls bool

Whether to skip verification of the server certificate when using TLS.

PemBundle string

Concatenated PEM blocks configuring the certificate chain.

PemJson string

A JSON structure configuring the certificate chain.

Port int

The default port to connect to if no port is specified as part of the host.

Tls bool

Whether to use TLS when connecting to Redis.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
Host string

The host to connect to.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

ConnectTimeout int

The number of seconds to use as a connection timeout.

InsecureTls bool

Whether to skip verification of the server certificate when using TLS.

PemBundle string

Concatenated PEM blocks configuring the certificate chain.

PemJson string

A JSON structure configuring the certificate chain.

Port int

The default port to connect to if no port is specified as part of the host.

Tls bool

Whether to use TLS when connecting to Redis.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
host String

The host to connect to.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

connectTimeout Integer

The number of seconds to use as a connection timeout.

insecureTls Boolean

Whether to skip verification of the server certificate when using TLS.

pemBundle String

Concatenated PEM blocks configuring the certificate chain.

pemJson String

A JSON structure configuring the certificate chain.

port Integer

The default port to connect to if no port is specified as part of the host.

tls Boolean

Whether to use TLS when connecting to Redis.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
host string

The host to connect to.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

connectTimeout number

The number of seconds to use as a connection timeout.

insecureTls boolean

Whether to skip verification of the server certificate when using TLS.

pemBundle string

Concatenated PEM blocks configuring the certificate chain.

pemJson string

A JSON structure configuring the certificate chain.

port number

The default port to connect to if no port is specified as part of the host.

tls boolean

Whether to use TLS when connecting to Redis.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
host str

The host to connect to.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

connect_timeout int

The number of seconds to use as a connection timeout.

insecure_tls bool

Whether to skip verification of the server certificate when using TLS.

pem_bundle str

Concatenated PEM blocks configuring the certificate chain.

pem_json str

A JSON structure configuring the certificate chain.

port int

The default port to connect to if no port is specified as part of the host.

tls bool

Whether to use TLS when connecting to Redis.

username_template str
  • Template describing how dynamic usernames are generated.
host String

The host to connect to.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

connectTimeout Number

The number of seconds to use as a connection timeout.

insecureTls Boolean

Whether to skip verification of the server certificate when using TLS.

pemBundle String

Concatenated PEM blocks configuring the certificate chain.

pemJson String

A JSON structure configuring the certificate chain.

port Number

The default port to connect to if no port is specified as part of the host.

tls Boolean

Whether to use TLS when connecting to Redis.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionMongodb

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

username_template str
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionMongodbatlas

PrivateKey string

The Private Programmatic API Key used to connect with MongoDB Atlas API.

ProjectId string

The Project ID the Database User should be created within.

PublicKey string

The Public Programmatic API Key used to authenticate with the MongoDB Atlas API.

PrivateKey string

The Private Programmatic API Key used to connect with MongoDB Atlas API.

ProjectId string

The Project ID the Database User should be created within.

PublicKey string

The Public Programmatic API Key used to authenticate with the MongoDB Atlas API.

privateKey String

The Private Programmatic API Key used to connect with MongoDB Atlas API.

projectId String

The Project ID the Database User should be created within.

publicKey String

The Public Programmatic API Key used to authenticate with the MongoDB Atlas API.

privateKey string

The Private Programmatic API Key used to connect with MongoDB Atlas API.

projectId string

The Project ID the Database User should be created within.

publicKey string

The Public Programmatic API Key used to authenticate with the MongoDB Atlas API.

private_key str

The Private Programmatic API Key used to connect with MongoDB Atlas API.

project_id str

The Project ID the Database User should be created within.

public_key str

The Public Programmatic API Key used to authenticate with the MongoDB Atlas API.

privateKey String

The Private Programmatic API Key used to connect with MongoDB Atlas API.

projectId String

The Project ID the Database User should be created within.

publicKey String

The Public Programmatic API Key used to authenticate with the MongoDB Atlas API.

SecretBackendConnectionMssql

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

ContainedDb bool

For Vault v1.9+. Set to true when the target is a Contained Database, e.g. AzureSQL. See the Vault docs

DisableEscaping bool

Disable special character escaping in username and password.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

ContainedDb bool

For Vault v1.9+. Set to true when the target is a Contained Database, e.g. AzureSQL. See the Vault docs

DisableEscaping bool

Disable special character escaping in username and password.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

containedDb Boolean

For Vault v1.9+. Set to true when the target is a Contained Database, e.g. AzureSQL. See the Vault docs

disableEscaping Boolean

Disable special character escaping in username and password.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

containedDb boolean

For Vault v1.9+. Set to true when the target is a Contained Database, e.g. AzureSQL. See the Vault docs

disableEscaping boolean

Disable special character escaping in username and password.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

contained_db bool

For Vault v1.9+. Set to true when the target is a Contained Database, e.g. AzureSQL. See the Vault docs

disable_escaping bool

Disable special character escaping in username and password.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

username_template str
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

containedDb Boolean

For Vault v1.9+. Set to true when the target is a Contained Database, e.g. AzureSQL. See the Vault docs

disableEscaping Boolean

Disable special character escaping in username and password.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionMysql

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

TlsCa string

x509 CA file for validating the certificate presented by the MySQL server. Must be PEM encoded.

TlsCertificateKey string

x509 certificate for connecting to the database. This must be a PEM encoded version of the private key and the certificate combined.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

TlsCa string

x509 CA file for validating the certificate presented by the MySQL server. Must be PEM encoded.

TlsCertificateKey string

x509 certificate for connecting to the database. This must be a PEM encoded version of the private key and the certificate combined.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

tlsCa String

x509 CA file for validating the certificate presented by the MySQL server. Must be PEM encoded.

tlsCertificateKey String

x509 certificate for connecting to the database. This must be a PEM encoded version of the private key and the certificate combined.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

tlsCa string

x509 CA file for validating the certificate presented by the MySQL server. Must be PEM encoded.

tlsCertificateKey string

x509 certificate for connecting to the database. This must be a PEM encoded version of the private key and the certificate combined.

username string

The root credential username used in the connection URL.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

tls_ca str

x509 CA file for validating the certificate presented by the MySQL server. Must be PEM encoded.

tls_certificate_key str

x509 certificate for connecting to the database. This must be a PEM encoded version of the private key and the certificate combined.

username str

The root credential username used in the connection URL.

username_template str
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

tlsCa String

x509 CA file for validating the certificate presented by the MySQL server. Must be PEM encoded.

tlsCertificateKey String

x509 certificate for connecting to the database. This must be a PEM encoded version of the private key and the certificate combined.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionMysqlAurora

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

username_template str
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionMysqlLegacy

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

username_template str
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionMysqlRds

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

username_template str
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionOracle

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

username_template str
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionPostgresql

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

DisableEscaping bool

Disable special character escaping in username and password.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

DisableEscaping bool

Disable special character escaping in username and password.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

disableEscaping Boolean

Disable special character escaping in username and password.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

disableEscaping boolean

Disable special character escaping in username and password.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

disable_escaping bool

Disable special character escaping in username and password.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

username_template str
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

disableEscaping Boolean

Disable special character escaping in username and password.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionRedis

Host string

The host to connect to.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

CaCert string

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

InsecureTls bool

Whether to skip verification of the server certificate when using TLS.

Port int

The default port to connect to if no port is specified as part of the host.

Tls bool

Whether to use TLS when connecting to Redis.

Host string

The host to connect to.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

CaCert string

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

InsecureTls bool

Whether to skip verification of the server certificate when using TLS.

Port int

The default port to connect to if no port is specified as part of the host.

Tls bool

Whether to use TLS when connecting to Redis.

host String

The host to connect to.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

caCert String

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

insecureTls Boolean

Whether to skip verification of the server certificate when using TLS.

port Integer

The default port to connect to if no port is specified as part of the host.

tls Boolean

Whether to use TLS when connecting to Redis.

host string

The host to connect to.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

caCert string

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

insecureTls boolean

Whether to skip verification of the server certificate when using TLS.

port number

The default port to connect to if no port is specified as part of the host.

tls boolean

Whether to use TLS when connecting to Redis.

host str

The host to connect to.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

ca_cert str

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

insecure_tls bool

Whether to skip verification of the server certificate when using TLS.

port int

The default port to connect to if no port is specified as part of the host.

tls bool

Whether to use TLS when connecting to Redis.

host String

The host to connect to.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

caCert String

The path to a PEM-encoded CA cert file to use to verify the Elasticsearch server's identity.

insecureTls Boolean

Whether to skip verification of the server certificate when using TLS.

port Number

The default port to connect to if no port is specified as part of the host.

tls Boolean

Whether to use TLS when connecting to Redis.

SecretBackendConnectionRedisElasticache

Url string

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

Password string

The root credential password used in the connection URL.

Region string

The region where the ElastiCache cluster is hosted. If omitted Vault tries to infer from the environment instead.

Username string

The root credential username used in the connection URL.

Url string

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

Password string

The root credential password used in the connection URL.

Region string

The region where the ElastiCache cluster is hosted. If omitted Vault tries to infer from the environment instead.

Username string

The root credential username used in the connection URL.

url String

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

password String

The root credential password used in the connection URL.

region String

The region where the ElastiCache cluster is hosted. If omitted Vault tries to infer from the environment instead.

username String

The root credential username used in the connection URL.

url string

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

password string

The root credential password used in the connection URL.

region string

The region where the ElastiCache cluster is hosted. If omitted Vault tries to infer from the environment instead.

username string

The root credential username used in the connection URL.

url str

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

password str

The root credential password used in the connection URL.

region str

The region where the ElastiCache cluster is hosted. If omitted Vault tries to infer from the environment instead.

username str

The root credential username used in the connection URL.

url String

The URL for Elasticsearch's API. https requires certificate by trusted CA if used.

password String

The root credential password used in the connection URL.

region String

The region where the ElastiCache cluster is hosted. If omitted Vault tries to infer from the environment instead.

username String

The root credential username used in the connection URL.

SecretBackendConnectionRedshift

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

DisableEscaping bool

Disable special character escaping in username and password.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

DisableEscaping bool

Disable special character escaping in username and password.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

disableEscaping Boolean

Disable special character escaping in username and password.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

disableEscaping boolean

Disable special character escaping in username and password.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

disable_escaping bool

Disable special character escaping in username and password.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

username_template str
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

disableEscaping Boolean

Disable special character escaping in username and password.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

SecretBackendConnectionSnowflake

ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
ConnectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

MaxConnectionLifetime int

The maximum amount of time a connection may be reused.

MaxIdleConnections int

The maximum number of idle connections to the database.

MaxOpenConnections int

The maximum number of open connections to the database.

Password string

The root credential password used in the connection URL.

Username string

The root credential username used in the connection URL.

UsernameTemplate string
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Integer

The maximum amount of time a connection may be reused.

maxIdleConnections Integer

The maximum number of idle connections to the database.

maxOpenConnections Integer

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.
connectionUrl string

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime number

The maximum amount of time a connection may be reused.

maxIdleConnections number

The maximum number of idle connections to the database.

maxOpenConnections number

The maximum number of open connections to the database.

password string

The root credential password used in the connection URL.

username string

The root credential username used in the connection URL.

usernameTemplate string
  • Template describing how dynamic usernames are generated.
connection_url str

Specifies the Redshift DSN. See the Vault docs for an example.

max_connection_lifetime int

The maximum amount of time a connection may be reused.

max_idle_connections int

The maximum number of idle connections to the database.

max_open_connections int

The maximum number of open connections to the database.

password str

The root credential password used in the connection URL.

username str

The root credential username used in the connection URL.

username_template str
  • Template describing how dynamic usernames are generated.
connectionUrl String

Specifies the Redshift DSN. See the Vault docs for an example.

maxConnectionLifetime Number

The maximum amount of time a connection may be reused.

maxIdleConnections Number

The maximum number of idle connections to the database.

maxOpenConnections Number

The maximum number of open connections to the database.

password String

The root credential password used in the connection URL.

username String

The root credential username used in the connection URL.

usernameTemplate String
  • Template describing how dynamic usernames are generated.

Package Details

Repository
Vault pulumi/pulumi-vault
License
Apache-2.0
Notes

This Pulumi package is based on the vault Terraform Provider.