HashiCorp Vault v6.2.0, Jun 21 24

HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi

vault.database.SecretBackendConnection

Explore with Pulumi AI

HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi

Example Usage

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,
    name: "postgres",
    allowedRoles: [
        "dev",
        "prod",
    ],
    postgresql: {
        connectionUrl: "postgres://username:password@host:port/database",
    },
});

import pulumi
import pulumi_vault as vault

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

package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
	"github.com/pulumi/pulumi-vault/sdk/v6/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,
			Name:    pulumi.String("postgres"),
			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
	})
}

using System.Collections.Generic;
using System.Linq;
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,
        Name = "postgres",
        AllowedRoles = new[]
        {
            "dev",
            "prod",
        },
        Postgresql = new Vault.Database.Inputs.SecretBackendConnectionPostgresqlArgs
        {
            ConnectionUrl = "postgres://username:password@host:port/database",
        },
    });

});

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())
            .name("postgres")
            .allowedRoles(            
                "dev",
                "prod")
            .postgresql(SecretBackendConnectionPostgresqlArgs.builder()
                .connectionUrl("postgres://username:password@host:port/database")
                .build())
            .build());

    }
}

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

Create SecretBackendConnection Resource

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

Constructor syntax

new SecretBackendConnection(name: string, args: SecretBackendConnectionArgs, opts?: CustomResourceOptions);

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

@overload
def SecretBackendConnection(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            backend: Optional[str] = None,
                            mysql_aurora: Optional[SecretBackendConnectionMysqlAuroraArgs] = None,
                            elasticsearch: Optional[SecretBackendConnectionElasticsearchArgs] = None,
                            mysql_legacy: Optional[SecretBackendConnectionMysqlLegacyArgs] = None,
                            data: Optional[Mapping[str, Any]] = None,
                            mysql_rds: Optional[SecretBackendConnectionMysqlRdsArgs] = None,
                            hana: Optional[SecretBackendConnectionHanaArgs] = None,
                            influxdb: Optional[SecretBackendConnectionInfluxdbArgs] = None,
                            name: Optional[str] = None,
                            mongodbatlas: Optional[SecretBackendConnectionMongodbatlasArgs] = None,
                            mssql: Optional[SecretBackendConnectionMssqlArgs] = None,
                            mysql: Optional[SecretBackendConnectionMysqlArgs] = None,
                            allowed_roles: Optional[Sequence[str]] = None,
                            couchbase: Optional[SecretBackendConnectionCouchbaseArgs] = None,
                            cassandra: Optional[SecretBackendConnectionCassandraArgs] = None,
                            mongodb: Optional[SecretBackendConnectionMongodbArgs] = 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)

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.

Parameters

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.

Constructor example

The following reference example uses placeholder values for all input properties.

var secretBackendConnectionResource = new Vault.Database.SecretBackendConnection("secretBackendConnectionResource", new()
{
    Backend = "string",
    MysqlAurora = new Vault.Database.Inputs.SecretBackendConnectionMysqlAuroraArgs
    {
        AuthType = "string",
        ConnectionUrl = "string",
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        ServiceAccountJson = "string",
        TlsCa = "string",
        TlsCertificateKey = "string",
        Username = "string",
        UsernameTemplate = "string",
    },
    Elasticsearch = new Vault.Database.Inputs.SecretBackendConnectionElasticsearchArgs
    {
        Password = "string",
        Url = "string",
        Username = "string",
        CaCert = "string",
        CaPath = "string",
        ClientCert = "string",
        ClientKey = "string",
        Insecure = false,
        TlsServerName = "string",
        UsernameTemplate = "string",
    },
    MysqlLegacy = new Vault.Database.Inputs.SecretBackendConnectionMysqlLegacyArgs
    {
        AuthType = "string",
        ConnectionUrl = "string",
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        ServiceAccountJson = "string",
        TlsCa = "string",
        TlsCertificateKey = "string",
        Username = "string",
        UsernameTemplate = "string",
    },
    Data = 
    {
        { "string", "any" },
    },
    MysqlRds = new Vault.Database.Inputs.SecretBackendConnectionMysqlRdsArgs
    {
        AuthType = "string",
        ConnectionUrl = "string",
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        ServiceAccountJson = "string",
        TlsCa = "string",
        TlsCertificateKey = "string",
        Username = "string",
        UsernameTemplate = "string",
    },
    Hana = new Vault.Database.Inputs.SecretBackendConnectionHanaArgs
    {
        ConnectionUrl = "string",
        DisableEscaping = false,
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        Username = "string",
    },
    Influxdb = new Vault.Database.Inputs.SecretBackendConnectionInfluxdbArgs
    {
        Host = "string",
        Password = "string",
        Username = "string",
        ConnectTimeout = 0,
        InsecureTls = false,
        PemBundle = "string",
        PemJson = "string",
        Port = 0,
        Tls = false,
        UsernameTemplate = "string",
    },
    Name = "string",
    Mongodbatlas = new Vault.Database.Inputs.SecretBackendConnectionMongodbatlasArgs
    {
        PrivateKey = "string",
        ProjectId = "string",
        PublicKey = "string",
    },
    Mssql = new Vault.Database.Inputs.SecretBackendConnectionMssqlArgs
    {
        ConnectionUrl = "string",
        ContainedDb = false,
        DisableEscaping = false,
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        Username = "string",
        UsernameTemplate = "string",
    },
    Mysql = new Vault.Database.Inputs.SecretBackendConnectionMysqlArgs
    {
        AuthType = "string",
        ConnectionUrl = "string",
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        ServiceAccountJson = "string",
        TlsCa = "string",
        TlsCertificateKey = "string",
        Username = "string",
        UsernameTemplate = "string",
    },
    AllowedRoles = new[]
    {
        "string",
    },
    Couchbase = new Vault.Database.Inputs.SecretBackendConnectionCouchbaseArgs
    {
        Hosts = new[]
        {
            "string",
        },
        Password = "string",
        Username = "string",
        Base64Pem = "string",
        BucketName = "string",
        InsecureTls = false,
        Tls = false,
        UsernameTemplate = "string",
    },
    Cassandra = new Vault.Database.Inputs.SecretBackendConnectionCassandraArgs
    {
        ConnectTimeout = 0,
        Hosts = new[]
        {
            "string",
        },
        InsecureTls = false,
        Password = "string",
        PemBundle = "string",
        PemJson = "string",
        Port = 0,
        ProtocolVersion = 0,
        Tls = false,
        Username = "string",
    },
    Mongodb = new Vault.Database.Inputs.SecretBackendConnectionMongodbArgs
    {
        ConnectionUrl = "string",
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        Username = "string",
        UsernameTemplate = "string",
    },
    Namespace = "string",
    Oracle = new Vault.Database.Inputs.SecretBackendConnectionOracleArgs
    {
        ConnectionUrl = "string",
        DisconnectSessions = false,
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        SplitStatements = false,
        Username = "string",
        UsernameTemplate = "string",
    },
    PluginName = "string",
    Postgresql = new Vault.Database.Inputs.SecretBackendConnectionPostgresqlArgs
    {
        AuthType = "string",
        ConnectionUrl = "string",
        DisableEscaping = false,
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        ServiceAccountJson = "string",
        Username = "string",
        UsernameTemplate = "string",
    },
    Redis = new Vault.Database.Inputs.SecretBackendConnectionRedisArgs
    {
        Host = "string",
        Password = "string",
        Username = "string",
        CaCert = "string",
        InsecureTls = false,
        Port = 0,
        Tls = false,
    },
    RedisElasticache = new Vault.Database.Inputs.SecretBackendConnectionRedisElasticacheArgs
    {
        Url = "string",
        Password = "string",
        Region = "string",
        Username = "string",
    },
    Redshift = new Vault.Database.Inputs.SecretBackendConnectionRedshiftArgs
    {
        ConnectionUrl = "string",
        DisableEscaping = false,
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        Username = "string",
        UsernameTemplate = "string",
    },
    RootRotationStatements = new[]
    {
        "string",
    },
    Snowflake = new Vault.Database.Inputs.SecretBackendConnectionSnowflakeArgs
    {
        ConnectionUrl = "string",
        MaxConnectionLifetime = 0,
        MaxIdleConnections = 0,
        MaxOpenConnections = 0,
        Password = "string",
        Username = "string",
        UsernameTemplate = "string",
    },
    VerifyConnection = false,
});

example, err := database.NewSecretBackendConnection(ctx, "secretBackendConnectionResource", &database.SecretBackendConnectionArgs{
	Backend: pulumi.String("string"),
	MysqlAurora: &database.SecretBackendConnectionMysqlAuroraArgs{
		AuthType:              pulumi.String("string"),
		ConnectionUrl:         pulumi.String("string"),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		ServiceAccountJson:    pulumi.String("string"),
		TlsCa:                 pulumi.String("string"),
		TlsCertificateKey:     pulumi.String("string"),
		Username:              pulumi.String("string"),
		UsernameTemplate:      pulumi.String("string"),
	},
	Elasticsearch: &database.SecretBackendConnectionElasticsearchArgs{
		Password:         pulumi.String("string"),
		Url:              pulumi.String("string"),
		Username:         pulumi.String("string"),
		CaCert:           pulumi.String("string"),
		CaPath:           pulumi.String("string"),
		ClientCert:       pulumi.String("string"),
		ClientKey:        pulumi.String("string"),
		Insecure:         pulumi.Bool(false),
		TlsServerName:    pulumi.String("string"),
		UsernameTemplate: pulumi.String("string"),
	},
	MysqlLegacy: &database.SecretBackendConnectionMysqlLegacyArgs{
		AuthType:              pulumi.String("string"),
		ConnectionUrl:         pulumi.String("string"),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		ServiceAccountJson:    pulumi.String("string"),
		TlsCa:                 pulumi.String("string"),
		TlsCertificateKey:     pulumi.String("string"),
		Username:              pulumi.String("string"),
		UsernameTemplate:      pulumi.String("string"),
	},
	Data: pulumi.Map{
		"string": pulumi.Any("any"),
	},
	MysqlRds: &database.SecretBackendConnectionMysqlRdsArgs{
		AuthType:              pulumi.String("string"),
		ConnectionUrl:         pulumi.String("string"),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		ServiceAccountJson:    pulumi.String("string"),
		TlsCa:                 pulumi.String("string"),
		TlsCertificateKey:     pulumi.String("string"),
		Username:              pulumi.String("string"),
		UsernameTemplate:      pulumi.String("string"),
	},
	Hana: &database.SecretBackendConnectionHanaArgs{
		ConnectionUrl:         pulumi.String("string"),
		DisableEscaping:       pulumi.Bool(false),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		Username:              pulumi.String("string"),
	},
	Influxdb: &database.SecretBackendConnectionInfluxdbArgs{
		Host:             pulumi.String("string"),
		Password:         pulumi.String("string"),
		Username:         pulumi.String("string"),
		ConnectTimeout:   pulumi.Int(0),
		InsecureTls:      pulumi.Bool(false),
		PemBundle:        pulumi.String("string"),
		PemJson:          pulumi.String("string"),
		Port:             pulumi.Int(0),
		Tls:              pulumi.Bool(false),
		UsernameTemplate: pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Mongodbatlas: &database.SecretBackendConnectionMongodbatlasArgs{
		PrivateKey: pulumi.String("string"),
		ProjectId:  pulumi.String("string"),
		PublicKey:  pulumi.String("string"),
	},
	Mssql: &database.SecretBackendConnectionMssqlArgs{
		ConnectionUrl:         pulumi.String("string"),
		ContainedDb:           pulumi.Bool(false),
		DisableEscaping:       pulumi.Bool(false),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		Username:              pulumi.String("string"),
		UsernameTemplate:      pulumi.String("string"),
	},
	Mysql: &database.SecretBackendConnectionMysqlArgs{
		AuthType:              pulumi.String("string"),
		ConnectionUrl:         pulumi.String("string"),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		ServiceAccountJson:    pulumi.String("string"),
		TlsCa:                 pulumi.String("string"),
		TlsCertificateKey:     pulumi.String("string"),
		Username:              pulumi.String("string"),
		UsernameTemplate:      pulumi.String("string"),
	},
	AllowedRoles: pulumi.StringArray{
		pulumi.String("string"),
	},
	Couchbase: &database.SecretBackendConnectionCouchbaseArgs{
		Hosts: pulumi.StringArray{
			pulumi.String("string"),
		},
		Password:         pulumi.String("string"),
		Username:         pulumi.String("string"),
		Base64Pem:        pulumi.String("string"),
		BucketName:       pulumi.String("string"),
		InsecureTls:      pulumi.Bool(false),
		Tls:              pulumi.Bool(false),
		UsernameTemplate: pulumi.String("string"),
	},
	Cassandra: &database.SecretBackendConnectionCassandraArgs{
		ConnectTimeout: pulumi.Int(0),
		Hosts: pulumi.StringArray{
			pulumi.String("string"),
		},
		InsecureTls:     pulumi.Bool(false),
		Password:        pulumi.String("string"),
		PemBundle:       pulumi.String("string"),
		PemJson:         pulumi.String("string"),
		Port:            pulumi.Int(0),
		ProtocolVersion: pulumi.Int(0),
		Tls:             pulumi.Bool(false),
		Username:        pulumi.String("string"),
	},
	Mongodb: &database.SecretBackendConnectionMongodbArgs{
		ConnectionUrl:         pulumi.String("string"),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		Username:              pulumi.String("string"),
		UsernameTemplate:      pulumi.String("string"),
	},
	Namespace: pulumi.String("string"),
	Oracle: &database.SecretBackendConnectionOracleArgs{
		ConnectionUrl:         pulumi.String("string"),
		DisconnectSessions:    pulumi.Bool(false),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		SplitStatements:       pulumi.Bool(false),
		Username:              pulumi.String("string"),
		UsernameTemplate:      pulumi.String("string"),
	},
	PluginName: pulumi.String("string"),
	Postgresql: &database.SecretBackendConnectionPostgresqlArgs{
		AuthType:              pulumi.String("string"),
		ConnectionUrl:         pulumi.String("string"),
		DisableEscaping:       pulumi.Bool(false),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		ServiceAccountJson:    pulumi.String("string"),
		Username:              pulumi.String("string"),
		UsernameTemplate:      pulumi.String("string"),
	},
	Redis: &database.SecretBackendConnectionRedisArgs{
		Host:        pulumi.String("string"),
		Password:    pulumi.String("string"),
		Username:    pulumi.String("string"),
		CaCert:      pulumi.String("string"),
		InsecureTls: pulumi.Bool(false),
		Port:        pulumi.Int(0),
		Tls:         pulumi.Bool(false),
	},
	RedisElasticache: &database.SecretBackendConnectionRedisElasticacheArgs{
		Url:      pulumi.String("string"),
		Password: pulumi.String("string"),
		Region:   pulumi.String("string"),
		Username: pulumi.String("string"),
	},
	Redshift: &database.SecretBackendConnectionRedshiftArgs{
		ConnectionUrl:         pulumi.String("string"),
		DisableEscaping:       pulumi.Bool(false),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		Username:              pulumi.String("string"),
		UsernameTemplate:      pulumi.String("string"),
	},
	RootRotationStatements: pulumi.StringArray{
		pulumi.String("string"),
	},
	Snowflake: &database.SecretBackendConnectionSnowflakeArgs{
		ConnectionUrl:         pulumi.String("string"),
		MaxConnectionLifetime: pulumi.Int(0),
		MaxIdleConnections:    pulumi.Int(0),
		MaxOpenConnections:    pulumi.Int(0),
		Password:              pulumi.String("string"),
		Username:              pulumi.String("string"),
		UsernameTemplate:      pulumi.String("string"),
	},
	VerifyConnection: pulumi.Bool(false),
})

var secretBackendConnectionResource = new SecretBackendConnection("secretBackendConnectionResource", SecretBackendConnectionArgs.builder()
    .backend("string")
    .mysqlAurora(SecretBackendConnectionMysqlAuroraArgs.builder()
        .authType("string")
        .connectionUrl("string")
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .serviceAccountJson("string")
        .tlsCa("string")
        .tlsCertificateKey("string")
        .username("string")
        .usernameTemplate("string")
        .build())
    .elasticsearch(SecretBackendConnectionElasticsearchArgs.builder()
        .password("string")
        .url("string")
        .username("string")
        .caCert("string")
        .caPath("string")
        .clientCert("string")
        .clientKey("string")
        .insecure(false)
        .tlsServerName("string")
        .usernameTemplate("string")
        .build())
    .mysqlLegacy(SecretBackendConnectionMysqlLegacyArgs.builder()
        .authType("string")
        .connectionUrl("string")
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .serviceAccountJson("string")
        .tlsCa("string")
        .tlsCertificateKey("string")
        .username("string")
        .usernameTemplate("string")
        .build())
    .data(Map.of("string", "any"))
    .mysqlRds(SecretBackendConnectionMysqlRdsArgs.builder()
        .authType("string")
        .connectionUrl("string")
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .serviceAccountJson("string")
        .tlsCa("string")
        .tlsCertificateKey("string")
        .username("string")
        .usernameTemplate("string")
        .build())
    .hana(SecretBackendConnectionHanaArgs.builder()
        .connectionUrl("string")
        .disableEscaping(false)
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .username("string")
        .build())
    .influxdb(SecretBackendConnectionInfluxdbArgs.builder()
        .host("string")
        .password("string")
        .username("string")
        .connectTimeout(0)
        .insecureTls(false)
        .pemBundle("string")
        .pemJson("string")
        .port(0)
        .tls(false)
        .usernameTemplate("string")
        .build())
    .name("string")
    .mongodbatlas(SecretBackendConnectionMongodbatlasArgs.builder()
        .privateKey("string")
        .projectId("string")
        .publicKey("string")
        .build())
    .mssql(SecretBackendConnectionMssqlArgs.builder()
        .connectionUrl("string")
        .containedDb(false)
        .disableEscaping(false)
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .username("string")
        .usernameTemplate("string")
        .build())
    .mysql(SecretBackendConnectionMysqlArgs.builder()
        .authType("string")
        .connectionUrl("string")
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .serviceAccountJson("string")
        .tlsCa("string")
        .tlsCertificateKey("string")
        .username("string")
        .usernameTemplate("string")
        .build())
    .allowedRoles("string")
    .couchbase(SecretBackendConnectionCouchbaseArgs.builder()
        .hosts("string")
        .password("string")
        .username("string")
        .base64Pem("string")
        .bucketName("string")
        .insecureTls(false)
        .tls(false)
        .usernameTemplate("string")
        .build())
    .cassandra(SecretBackendConnectionCassandraArgs.builder()
        .connectTimeout(0)
        .hosts("string")
        .insecureTls(false)
        .password("string")
        .pemBundle("string")
        .pemJson("string")
        .port(0)
        .protocolVersion(0)
        .tls(false)
        .username("string")
        .build())
    .mongodb(SecretBackendConnectionMongodbArgs.builder()
        .connectionUrl("string")
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .username("string")
        .usernameTemplate("string")
        .build())
    .namespace("string")
    .oracle(SecretBackendConnectionOracleArgs.builder()
        .connectionUrl("string")
        .disconnectSessions(false)
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .splitStatements(false)
        .username("string")
        .usernameTemplate("string")
        .build())
    .pluginName("string")
    .postgresql(SecretBackendConnectionPostgresqlArgs.builder()
        .authType("string")
        .connectionUrl("string")
        .disableEscaping(false)
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .serviceAccountJson("string")
        .username("string")
        .usernameTemplate("string")
        .build())
    .redis(SecretBackendConnectionRedisArgs.builder()
        .host("string")
        .password("string")
        .username("string")
        .caCert("string")
        .insecureTls(false)
        .port(0)
        .tls(false)
        .build())
    .redisElasticache(SecretBackendConnectionRedisElasticacheArgs.builder()
        .url("string")
        .password("string")
        .region("string")
        .username("string")
        .build())
    .redshift(SecretBackendConnectionRedshiftArgs.builder()
        .connectionUrl("string")
        .disableEscaping(false)
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .username("string")
        .usernameTemplate("string")
        .build())
    .rootRotationStatements("string")
    .snowflake(SecretBackendConnectionSnowflakeArgs.builder()
        .connectionUrl("string")
        .maxConnectionLifetime(0)
        .maxIdleConnections(0)
        .maxOpenConnections(0)
        .password("string")
        .username("string")
        .usernameTemplate("string")
        .build())
    .verifyConnection(false)
    .build());

secret_backend_connection_resource = vault.database.SecretBackendConnection("secretBackendConnectionResource",
    backend="string",
    mysql_aurora=vault.database.SecretBackendConnectionMysqlAuroraArgs(
        auth_type="string",
        connection_url="string",
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        service_account_json="string",
        tls_ca="string",
        tls_certificate_key="string",
        username="string",
        username_template="string",
    ),
    elasticsearch=vault.database.SecretBackendConnectionElasticsearchArgs(
        password="string",
        url="string",
        username="string",
        ca_cert="string",
        ca_path="string",
        client_cert="string",
        client_key="string",
        insecure=False,
        tls_server_name="string",
        username_template="string",
    ),
    mysql_legacy=vault.database.SecretBackendConnectionMysqlLegacyArgs(
        auth_type="string",
        connection_url="string",
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        service_account_json="string",
        tls_ca="string",
        tls_certificate_key="string",
        username="string",
        username_template="string",
    ),
    data={
        "string": "any",
    },
    mysql_rds=vault.database.SecretBackendConnectionMysqlRdsArgs(
        auth_type="string",
        connection_url="string",
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        service_account_json="string",
        tls_ca="string",
        tls_certificate_key="string",
        username="string",
        username_template="string",
    ),
    hana=vault.database.SecretBackendConnectionHanaArgs(
        connection_url="string",
        disable_escaping=False,
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        username="string",
    ),
    influxdb=vault.database.SecretBackendConnectionInfluxdbArgs(
        host="string",
        password="string",
        username="string",
        connect_timeout=0,
        insecure_tls=False,
        pem_bundle="string",
        pem_json="string",
        port=0,
        tls=False,
        username_template="string",
    ),
    name="string",
    mongodbatlas=vault.database.SecretBackendConnectionMongodbatlasArgs(
        private_key="string",
        project_id="string",
        public_key="string",
    ),
    mssql=vault.database.SecretBackendConnectionMssqlArgs(
        connection_url="string",
        contained_db=False,
        disable_escaping=False,
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        username="string",
        username_template="string",
    ),
    mysql=vault.database.SecretBackendConnectionMysqlArgs(
        auth_type="string",
        connection_url="string",
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        service_account_json="string",
        tls_ca="string",
        tls_certificate_key="string",
        username="string",
        username_template="string",
    ),
    allowed_roles=["string"],
    couchbase=vault.database.SecretBackendConnectionCouchbaseArgs(
        hosts=["string"],
        password="string",
        username="string",
        base64_pem="string",
        bucket_name="string",
        insecure_tls=False,
        tls=False,
        username_template="string",
    ),
    cassandra=vault.database.SecretBackendConnectionCassandraArgs(
        connect_timeout=0,
        hosts=["string"],
        insecure_tls=False,
        password="string",
        pem_bundle="string",
        pem_json="string",
        port=0,
        protocol_version=0,
        tls=False,
        username="string",
    ),
    mongodb=vault.database.SecretBackendConnectionMongodbArgs(
        connection_url="string",
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        username="string",
        username_template="string",
    ),
    namespace="string",
    oracle=vault.database.SecretBackendConnectionOracleArgs(
        connection_url="string",
        disconnect_sessions=False,
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        split_statements=False,
        username="string",
        username_template="string",
    ),
    plugin_name="string",
    postgresql=vault.database.SecretBackendConnectionPostgresqlArgs(
        auth_type="string",
        connection_url="string",
        disable_escaping=False,
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        service_account_json="string",
        username="string",
        username_template="string",
    ),
    redis=vault.database.SecretBackendConnectionRedisArgs(
        host="string",
        password="string",
        username="string",
        ca_cert="string",
        insecure_tls=False,
        port=0,
        tls=False,
    ),
    redis_elasticache=vault.database.SecretBackendConnectionRedisElasticacheArgs(
        url="string",
        password="string",
        region="string",
        username="string",
    ),
    redshift=vault.database.SecretBackendConnectionRedshiftArgs(
        connection_url="string",
        disable_escaping=False,
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        username="string",
        username_template="string",
    ),
    root_rotation_statements=["string"],
    snowflake=vault.database.SecretBackendConnectionSnowflakeArgs(
        connection_url="string",
        max_connection_lifetime=0,
        max_idle_connections=0,
        max_open_connections=0,
        password="string",
        username="string",
        username_template="string",
    ),
    verify_connection=False)

const secretBackendConnectionResource = new vault.database.SecretBackendConnection("secretBackendConnectionResource", {
    backend: "string",
    mysqlAurora: {
        authType: "string",
        connectionUrl: "string",
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        serviceAccountJson: "string",
        tlsCa: "string",
        tlsCertificateKey: "string",
        username: "string",
        usernameTemplate: "string",
    },
    elasticsearch: {
        password: "string",
        url: "string",
        username: "string",
        caCert: "string",
        caPath: "string",
        clientCert: "string",
        clientKey: "string",
        insecure: false,
        tlsServerName: "string",
        usernameTemplate: "string",
    },
    mysqlLegacy: {
        authType: "string",
        connectionUrl: "string",
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        serviceAccountJson: "string",
        tlsCa: "string",
        tlsCertificateKey: "string",
        username: "string",
        usernameTemplate: "string",
    },
    data: {
        string: "any",
    },
    mysqlRds: {
        authType: "string",
        connectionUrl: "string",
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        serviceAccountJson: "string",
        tlsCa: "string",
        tlsCertificateKey: "string",
        username: "string",
        usernameTemplate: "string",
    },
    hana: {
        connectionUrl: "string",
        disableEscaping: false,
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        username: "string",
    },
    influxdb: {
        host: "string",
        password: "string",
        username: "string",
        connectTimeout: 0,
        insecureTls: false,
        pemBundle: "string",
        pemJson: "string",
        port: 0,
        tls: false,
        usernameTemplate: "string",
    },
    name: "string",
    mongodbatlas: {
        privateKey: "string",
        projectId: "string",
        publicKey: "string",
    },
    mssql: {
        connectionUrl: "string",
        containedDb: false,
        disableEscaping: false,
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        username: "string",
        usernameTemplate: "string",
    },
    mysql: {
        authType: "string",
        connectionUrl: "string",
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        serviceAccountJson: "string",
        tlsCa: "string",
        tlsCertificateKey: "string",
        username: "string",
        usernameTemplate: "string",
    },
    allowedRoles: ["string"],
    couchbase: {
        hosts: ["string"],
        password: "string",
        username: "string",
        base64Pem: "string",
        bucketName: "string",
        insecureTls: false,
        tls: false,
        usernameTemplate: "string",
    },
    cassandra: {
        connectTimeout: 0,
        hosts: ["string"],
        insecureTls: false,
        password: "string",
        pemBundle: "string",
        pemJson: "string",
        port: 0,
        protocolVersion: 0,
        tls: false,
        username: "string",
    },
    mongodb: {
        connectionUrl: "string",
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        username: "string",
        usernameTemplate: "string",
    },
    namespace: "string",
    oracle: {
        connectionUrl: "string",
        disconnectSessions: false,
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        splitStatements: false,
        username: "string",
        usernameTemplate: "string",
    },
    pluginName: "string",
    postgresql: {
        authType: "string",
        connectionUrl: "string",
        disableEscaping: false,
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        serviceAccountJson: "string",
        username: "string",
        usernameTemplate: "string",
    },
    redis: {
        host: "string",
        password: "string",
        username: "string",
        caCert: "string",
        insecureTls: false,
        port: 0,
        tls: false,
    },
    redisElasticache: {
        url: "string",
        password: "string",
        region: "string",
        username: "string",
    },
    redshift: {
        connectionUrl: "string",
        disableEscaping: false,
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        username: "string",
        usernameTemplate: "string",
    },
    rootRotationStatements: ["string"],
    snowflake: {
        connectionUrl: "string",
        maxConnectionLifetime: 0,
        maxIdleConnections: 0,
        maxOpenConnections: 0,
        password: "string",
        username: "string",
        usernameTemplate: "string",
    },
    verifyConnection: false,
});

type: vault:database:SecretBackendConnection
properties:
    allowedRoles:
        - string
    backend: string
    cassandra:
        connectTimeout: 0
        hosts:
            - string
        insecureTls: false
        password: string
        pemBundle: string
        pemJson: string
        port: 0
        protocolVersion: 0
        tls: false
        username: string
    couchbase:
        base64Pem: string
        bucketName: string
        hosts:
            - string
        insecureTls: false
        password: string
        tls: false
        username: string
        usernameTemplate: string
    data:
        string: any
    elasticsearch:
        caCert: string
        caPath: string
        clientCert: string
        clientKey: string
        insecure: false
        password: string
        tlsServerName: string
        url: string
        username: string
        usernameTemplate: string
    hana:
        connectionUrl: string
        disableEscaping: false
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        username: string
    influxdb:
        connectTimeout: 0
        host: string
        insecureTls: false
        password: string
        pemBundle: string
        pemJson: string
        port: 0
        tls: false
        username: string
        usernameTemplate: string
    mongodb:
        connectionUrl: string
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        username: string
        usernameTemplate: string
    mongodbatlas:
        privateKey: string
        projectId: string
        publicKey: string
    mssql:
        connectionUrl: string
        containedDb: false
        disableEscaping: false
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        username: string
        usernameTemplate: string
    mysql:
        authType: string
        connectionUrl: string
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        serviceAccountJson: string
        tlsCa: string
        tlsCertificateKey: string
        username: string
        usernameTemplate: string
    mysqlAurora:
        authType: string
        connectionUrl: string
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        serviceAccountJson: string
        tlsCa: string
        tlsCertificateKey: string
        username: string
        usernameTemplate: string
    mysqlLegacy:
        authType: string
        connectionUrl: string
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        serviceAccountJson: string
        tlsCa: string
        tlsCertificateKey: string
        username: string
        usernameTemplate: string
    mysqlRds:
        authType: string
        connectionUrl: string
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        serviceAccountJson: string
        tlsCa: string
        tlsCertificateKey: string
        username: string
        usernameTemplate: string
    name: string
    namespace: string
    oracle:
        connectionUrl: string
        disconnectSessions: false
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        splitStatements: false
        username: string
        usernameTemplate: string
    pluginName: string
    postgresql:
        authType: string
        connectionUrl: string
        disableEscaping: false
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        serviceAccountJson: string
        username: string
        usernameTemplate: string
    redis:
        caCert: string
        host: string
        insecureTls: false
        password: string
        port: 0
        tls: false
        username: string
    redisElasticache:
        password: string
        region: string
        url: string
        username: string
    redshift:
        connectionUrl: string
        disableEscaping: false
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        username: string
        usernameTemplate: string
    rootRotationStatements:
        - string
    snowflake:
        connectionUrl: string
        maxConnectionLifetime: 0
        maxIdleConnections: 0
        maxOpenConnections: 0
        password: string
        username: string
        usernameTemplate: string
    verifyConnection: false

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 SecretBackendConnectionCassandra

A nested block containing configuration options for Cassandra connections.

Couchbase SecretBackendConnectionCouchbase

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 SecretBackendConnectionElasticsearch

A nested block containing configuration options for Elasticsearch connections.

Hana SecretBackendConnectionHana

A nested block containing configuration options for SAP HanaDB connections.

Influxdb SecretBackendConnectionInfluxdb

A nested block containing configuration options for InfluxDB connections.

Mongodb SecretBackendConnectionMongodb

A nested block containing configuration options for MongoDB connections.

Mongodbatlas SecretBackendConnectionMongodbatlas

A nested block containing configuration options for MongoDB Atlas connections.

Mssql SecretBackendConnectionMssql

A nested block containing configuration options for MSSQL connections.

Mysql SecretBackendConnectionMysql

A nested block containing configuration options for MySQL connections.

MysqlAurora SecretBackendConnectionMysqlAurora

A nested block containing configuration options for Aurora MySQL connections.

MysqlLegacy SecretBackendConnectionMysqlLegacy

A nested block containing configuration options for legacy MySQL connections.

MysqlRds SecretBackendConnectionMysqlRds

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 SecretBackendConnectionOracle

A nested block containing configuration options for Oracle connections.

PluginName string

Specifies the name of the plugin to use.

Postgresql SecretBackendConnectionPostgresql

A nested block containing configuration options for PostgreSQL connections.

Redis SecretBackendConnectionRedis

A nested block containing configuration options for Redis connections.

RedisElasticache SecretBackendConnectionRedisElasticache

A nested block containing configuration options for Redis ElastiCache connections.

Exactly one of the nested blocks of configuration options must be supplied.

Redshift SecretBackendConnectionRedshift

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 SecretBackendConnectionSnowflake

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

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.

Exactly one of the nested blocks of configuration options must be supplied.

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 SecretBackendConnectionCassandra

A nested block containing configuration options for Cassandra connections.

couchbase SecretBackendConnectionCouchbase

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 SecretBackendConnectionElasticsearch

A nested block containing configuration options for Elasticsearch connections.

hana SecretBackendConnectionHana

A nested block containing configuration options for SAP HanaDB connections.

influxdb SecretBackendConnectionInfluxdb

A nested block containing configuration options for InfluxDB connections.

mongodb SecretBackendConnectionMongodb

A nested block containing configuration options for MongoDB connections.

mongodbatlas SecretBackendConnectionMongodbatlas

A nested block containing configuration options for MongoDB Atlas connections.

mssql SecretBackendConnectionMssql

A nested block containing configuration options for MSSQL connections.

mysql SecretBackendConnectionMysql

A nested block containing configuration options for MySQL connections.

mysqlAurora SecretBackendConnectionMysqlAurora

A nested block containing configuration options for Aurora MySQL connections.

mysqlLegacy SecretBackendConnectionMysqlLegacy

A nested block containing configuration options for legacy MySQL connections.

mysqlRds SecretBackendConnectionMysqlRds

A nested block containing configuration options for RDS MySQL connections.

name String

A unique name to give the database connection.

namespace String

oracle SecretBackendConnectionOracle

A nested block containing configuration options for Oracle connections.

pluginName String

Specifies the name of the plugin to use.

postgresql SecretBackendConnectionPostgresql

A nested block containing configuration options for PostgreSQL connections.

redis SecretBackendConnectionRedis

A nested block containing configuration options for Redis connections.

redisElasticache SecretBackendConnectionRedisElasticache

A nested block containing configuration options for Redis ElastiCache connections.

Exactly one of the nested blocks of configuration options must be supplied.

redshift SecretBackendConnectionRedshift

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 SecretBackendConnectionSnowflake

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 SecretBackendConnectionCassandra

A nested block containing configuration options for Cassandra connections.

couchbase SecretBackendConnectionCouchbase

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 SecretBackendConnectionElasticsearch

A nested block containing configuration options for Elasticsearch connections.

hana SecretBackendConnectionHana

A nested block containing configuration options for SAP HanaDB connections.

influxdb SecretBackendConnectionInfluxdb

A nested block containing configuration options for InfluxDB connections.

mongodb SecretBackendConnectionMongodb

A nested block containing configuration options for MongoDB connections.

mongodbatlas SecretBackendConnectionMongodbatlas

A nested block containing configuration options for MongoDB Atlas connections.

mssql SecretBackendConnectionMssql

A nested block containing configuration options for MSSQL connections.

mysql SecretBackendConnectionMysql

A nested block containing configuration options for MySQL connections.

mysqlAurora SecretBackendConnectionMysqlAurora

A nested block containing configuration options for Aurora MySQL connections.

mysqlLegacy SecretBackendConnectionMysqlLegacy

A nested block containing configuration options for legacy MySQL connections.

mysqlRds SecretBackendConnectionMysqlRds

A nested block containing configuration options for RDS MySQL connections.

name string

A unique name to give the database connection.

namespace string

oracle SecretBackendConnectionOracle

A nested block containing configuration options for Oracle connections.

pluginName string

Specifies the name of the plugin to use.

postgresql SecretBackendConnectionPostgresql

A nested block containing configuration options for PostgreSQL connections.

redis SecretBackendConnectionRedis

A nested block containing configuration options for Redis connections.

redisElasticache SecretBackendConnectionRedisElasticache

A nested block containing configuration options for Redis ElastiCache connections.

Exactly one of the nested blocks of configuration options must be supplied.

redshift SecretBackendConnectionRedshift

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 SecretBackendConnectionSnowflake

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

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.

Exactly one of the nested blocks of configuration options must be supplied.

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

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.

Exactly one of the nested blocks of configuration options must be supplied.

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 SecretBackendConnectionCassandra

A nested block containing configuration options for Cassandra connections.

Couchbase SecretBackendConnectionCouchbase

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 SecretBackendConnectionElasticsearch

A nested block containing configuration options for Elasticsearch connections.

Hana SecretBackendConnectionHana

A nested block containing configuration options for SAP HanaDB connections.

Influxdb SecretBackendConnectionInfluxdb

A nested block containing configuration options for InfluxDB connections.

Mongodb SecretBackendConnectionMongodb

A nested block containing configuration options for MongoDB connections.

Mongodbatlas SecretBackendConnectionMongodbatlas

A nested block containing configuration options for MongoDB Atlas connections.

Mssql SecretBackendConnectionMssql

A nested block containing configuration options for MSSQL connections.

Mysql SecretBackendConnectionMysql

A nested block containing configuration options for MySQL connections.

MysqlAurora SecretBackendConnectionMysqlAurora

A nested block containing configuration options for Aurora MySQL connections.

MysqlLegacy SecretBackendConnectionMysqlLegacy

A nested block containing configuration options for legacy MySQL connections.

MysqlRds SecretBackendConnectionMysqlRds

A nested block containing configuration options for RDS MySQL connections.

Name string

A unique name to give the database connection.

Namespace string

Oracle SecretBackendConnectionOracle

A nested block containing configuration options for Oracle connections.

PluginName string

Specifies the name of the plugin to use.

Postgresql SecretBackendConnectionPostgresql

A nested block containing configuration options for PostgreSQL connections.

Redis SecretBackendConnectionRedis

A nested block containing configuration options for Redis connections.

RedisElasticache SecretBackendConnectionRedisElasticache

A nested block containing configuration options for Redis ElastiCache connections.

Exactly one of the nested blocks of configuration options must be supplied.

Redshift SecretBackendConnectionRedshift

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 SecretBackendConnectionSnowflake

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

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.

Exactly one of the nested blocks of configuration options must be supplied.

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 SecretBackendConnectionCassandra

A nested block containing configuration options for Cassandra connections.

couchbase SecretBackendConnectionCouchbase

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 SecretBackendConnectionElasticsearch

A nested block containing configuration options for Elasticsearch connections.

hana SecretBackendConnectionHana

A nested block containing configuration options for SAP HanaDB connections.

influxdb SecretBackendConnectionInfluxdb

A nested block containing configuration options for InfluxDB connections.

mongodb SecretBackendConnectionMongodb

A nested block containing configuration options for MongoDB connections.

mongodbatlas SecretBackendConnectionMongodbatlas

A nested block containing configuration options for MongoDB Atlas connections.

mssql SecretBackendConnectionMssql

A nested block containing configuration options for MSSQL connections.

mysql SecretBackendConnectionMysql

A nested block containing configuration options for MySQL connections.

mysqlAurora SecretBackendConnectionMysqlAurora

A nested block containing configuration options for Aurora MySQL connections.

mysqlLegacy SecretBackendConnectionMysqlLegacy

A nested block containing configuration options for legacy MySQL connections.

mysqlRds SecretBackendConnectionMysqlRds

A nested block containing configuration options for RDS MySQL connections.

name String

A unique name to give the database connection.

namespace String

oracle SecretBackendConnectionOracle

A nested block containing configuration options for Oracle connections.

pluginName String

Specifies the name of the plugin to use.

postgresql SecretBackendConnectionPostgresql

A nested block containing configuration options for PostgreSQL connections.

redis SecretBackendConnectionRedis

A nested block containing configuration options for Redis connections.

redisElasticache SecretBackendConnectionRedisElasticache

A nested block containing configuration options for Redis ElastiCache connections.

Exactly one of the nested blocks of configuration options must be supplied.

redshift SecretBackendConnectionRedshift

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 SecretBackendConnectionSnowflake

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 SecretBackendConnectionCassandra

A nested block containing configuration options for Cassandra connections.

couchbase SecretBackendConnectionCouchbase

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 SecretBackendConnectionElasticsearch

A nested block containing configuration options for Elasticsearch connections.

hana SecretBackendConnectionHana

A nested block containing configuration options for SAP HanaDB connections.

influxdb SecretBackendConnectionInfluxdb

A nested block containing configuration options for InfluxDB connections.

mongodb SecretBackendConnectionMongodb

A nested block containing configuration options for MongoDB connections.

mongodbatlas SecretBackendConnectionMongodbatlas

A nested block containing configuration options for MongoDB Atlas connections.

mssql SecretBackendConnectionMssql

A nested block containing configuration options for MSSQL connections.

mysql SecretBackendConnectionMysql

A nested block containing configuration options for MySQL connections.

mysqlAurora SecretBackendConnectionMysqlAurora

A nested block containing configuration options for Aurora MySQL connections.

mysqlLegacy SecretBackendConnectionMysqlLegacy

A nested block containing configuration options for legacy MySQL connections.

mysqlRds SecretBackendConnectionMysqlRds

A nested block containing configuration options for RDS MySQL connections.

name string

A unique name to give the database connection.

namespace string

oracle SecretBackendConnectionOracle

A nested block containing configuration options for Oracle connections.

pluginName string

Specifies the name of the plugin to use.

postgresql SecretBackendConnectionPostgresql

A nested block containing configuration options for PostgreSQL connections.

redis SecretBackendConnectionRedis

A nested block containing configuration options for Redis connections.

redisElasticache SecretBackendConnectionRedisElasticache

A nested block containing configuration options for Redis ElastiCache connections.

Exactly one of the nested blocks of configuration options must be supplied.

redshift SecretBackendConnectionRedshift

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 SecretBackendConnectionSnowflake

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

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.

Exactly one of the nested blocks of configuration options must be supplied.

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

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.

Exactly one of the nested blocks of configuration options must be supplied.

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, SecretBackendConnectionCassandraArgs

ConnectTimeout int: The number of seconds to use as a connection timeout.
Hosts List<string>: Cassandra hosts to connect to.
InsecureTls bool: Whether to skip verification of the server certificate when using TLS.
Password string: The password to use when authenticating with Cassandra.
PemBundle string: Concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
PemJson string: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
Port int: The transport port to use to connect to Cassandra.
ProtocolVersion int: The CQL protocol version to use.
Tls bool: Whether to use TLS when connecting to Cassandra.
Username string: The username to use when authenticating with Cassandra.

ConnectTimeout int: The number of seconds to use as a connection timeout.
Hosts []string: Cassandra hosts to connect to.
InsecureTls bool: Whether to skip verification of the server certificate when using TLS.
Password string: The password to use when authenticating with Cassandra.
PemBundle string: Concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
PemJson string: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
Port int: The transport port to use to connect to Cassandra.
ProtocolVersion int: The CQL protocol version to use.
Tls bool: Whether to use TLS when connecting to Cassandra.
Username string: The username to use when authenticating with Cassandra.

connectTimeout Integer: The number of seconds to use as a connection timeout.
hosts List<String>: Cassandra hosts to connect to.
insecureTls Boolean: Whether to skip verification of the server certificate when using TLS.
password String: The password to use when authenticating with Cassandra.
pemBundle String: Concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
pemJson String: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
port Integer: The transport port to use to connect to Cassandra.
protocolVersion Integer: The CQL protocol version to use.
tls Boolean: Whether to use TLS when connecting to Cassandra.
username String: The username to use when authenticating with Cassandra.

connectTimeout number: The number of seconds to use as a connection timeout.
hosts string[]: Cassandra hosts to connect to.
insecureTls boolean: Whether to skip verification of the server certificate when using TLS.
password string: The password to use when authenticating with Cassandra.
pemBundle string: Concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
pemJson string: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
port number: The transport port to use to connect to Cassandra.
protocolVersion number: The CQL protocol version to use.
tls boolean: Whether to use TLS when connecting to Cassandra.
username string: The username to use when authenticating with Cassandra.

connect_timeout int: The number of seconds to use as a connection timeout.
hosts Sequence[str]: Cassandra hosts to connect to.
insecure_tls bool: Whether to skip verification of the server certificate when using TLS.
password str: The password to use when authenticating with Cassandra.
pem_bundle str: Concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
pem_json str: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
port int: The transport port to use to connect to Cassandra.
protocol_version int: The CQL protocol version to use.
tls bool: Whether to use TLS when connecting to Cassandra.
username str: The username to use when authenticating with Cassandra.

connectTimeout Number: The number of seconds to use as a connection timeout.
hosts List<String>: Cassandra hosts to connect to.
insecureTls Boolean: Whether to skip verification of the server certificate when using TLS.
password String: The password to use when authenticating with Cassandra.
pemBundle String: Concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
pemJson String: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
port Number: The transport port to use to connect to Cassandra.
protocolVersion Number: The CQL protocol version to use.
tls Boolean: Whether to use TLS when connecting to Cassandra.
username String: The username to use when authenticating with Cassandra.

SecretBackendConnectionCouchbase, SecretBackendConnectionCouchbaseArgs

Hosts List<string>: A set of Couchbase URIs to connect to. Must use couchbases:// scheme if tls is true.
Password string: Specifies the password corresponding to the given username.
Username string: Specifies the username for Vault to use.
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: Specifies whether to skip verification of the server certificate when using TLS.
Tls bool: Specifies whether to use TLS when connecting to Couchbase.
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: Specifies the password corresponding to the given username.
Username string: Specifies the username for Vault to use.
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: Specifies whether to skip verification of the server certificate when using TLS.
Tls bool: Specifies whether to use TLS when connecting to Couchbase.
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: Specifies the password corresponding to the given username.
username String: Specifies the username for Vault to use.
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: Specifies whether to skip verification of the server certificate when using TLS.
tls Boolean: Specifies whether to use TLS when connecting to Couchbase.
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: Specifies the password corresponding to the given username.
username string: Specifies the username for Vault to use.
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: Specifies whether to skip verification of the server certificate when using TLS.
tls boolean: Specifies whether to use TLS when connecting to Couchbase.
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: Specifies the password corresponding to the given username.
username str: Specifies the username for Vault to use.
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: Specifies whether to skip verification of the server certificate when using TLS.
tls bool: Specifies whether to use TLS when connecting to Couchbase.
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: Specifies the password corresponding to the given username.
username String: Specifies the username for Vault to use.
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: Specifies whether to skip verification of the server certificate when using TLS.
tls Boolean: Specifies whether to use TLS when connecting to Couchbase.
usernameTemplate String: Template describing how dynamic usernames are generated.

SecretBackendConnectionElasticsearch, SecretBackendConnectionElasticsearchArgs

Password string: The password to be used in the connection URL
Url string: The URL for Elasticsearch's API
Username string: The username to be 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 password to be used in the connection URL
Url string: The URL for Elasticsearch's API
Username string: The username to be 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 password to be used in the connection URL
url String: The URL for Elasticsearch's API
username String: The username to be 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 password to be used in the connection URL
url string: The URL for Elasticsearch's API
username string: The username to be 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 password to be used in the connection URL
url str: The URL for Elasticsearch's API
username str: The username to be 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 password to be used in the connection URL
url String: The URL for Elasticsearch's API
username String: The username to be 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, SecretBackendConnectionHanaArgs

ConnectionUrl string: Connection string to use to connect to the database.
DisableEscaping bool: Disable special character escaping in username and password
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: 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: Connection string to use to connect to the database.
DisableEscaping bool: Disable special character escaping in username and password
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: 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: Connection string to use to connect to the database.
disableEscaping Boolean: Disable special character escaping in username and password
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: 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: Connection string to use to connect to the database.
disableEscaping boolean: Disable special character escaping in username and password
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: 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: Connection string to use to connect to the database.
disable_escaping bool: Disable special character escaping in username and password
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: 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: Connection string to use to connect to the database.
disableEscaping Boolean: Disable special character escaping in username and password
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: 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, SecretBackendConnectionInfluxdbArgs

Host string: Influxdb host to connect to.
Password string: Specifies the password corresponding to the given username.
Username string: Specifies the username to use for superuser access.
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 containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
PemJson string: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
Port int: The transport port to use to connect to Influxdb.
Tls bool: Whether to use TLS when connecting to Influxdb.
UsernameTemplate string: Template describing how dynamic usernames are generated.

Host string: Influxdb host to connect to.
Password string: Specifies the password corresponding to the given username.
Username string: Specifies the username to use for superuser access.
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 containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
PemJson string: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
Port int: The transport port to use to connect to Influxdb.
Tls bool: Whether to use TLS when connecting to Influxdb.
UsernameTemplate string: Template describing how dynamic usernames are generated.

host String: Influxdb host to connect to.
password String: Specifies the password corresponding to the given username.
username String: Specifies the username to use for superuser access.
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 containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
pemJson String: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
port Integer: The transport port to use to connect to Influxdb.
tls Boolean: Whether to use TLS when connecting to Influxdb.
usernameTemplate String: Template describing how dynamic usernames are generated.

host string: Influxdb host to connect to.
password string: Specifies the password corresponding to the given username.
username string: Specifies the username to use for superuser access.
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 containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
pemJson string: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
port number: The transport port to use to connect to Influxdb.
tls boolean: Whether to use TLS when connecting to Influxdb.
usernameTemplate string: Template describing how dynamic usernames are generated.

host str: Influxdb host to connect to.
password str: Specifies the password corresponding to the given username.
username str: Specifies the username to use for superuser access.
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 containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
pem_json str: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
port int: The transport port to use to connect to Influxdb.
tls bool: Whether to use TLS when connecting to Influxdb.
username_template str: Template describing how dynamic usernames are generated.

host String: Influxdb host to connect to.
password String: Specifies the password corresponding to the given username.
username String: Specifies the username to use for superuser access.
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 containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
pemJson String: Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
port Number: The transport port to use to connect to Influxdb.
tls Boolean: Whether to use TLS when connecting to Influxdb.
usernameTemplate String: Template describing how dynamic usernames are generated.

SecretBackendConnectionMongodb, SecretBackendConnectionMongodbArgs

ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: 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: Username generation template.

ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: 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: Username generation template.

connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: 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: Username generation template.

connectionUrl string: Connection string to use to connect to the database.
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: 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: Username generation template.

connection_url str: Connection string to use to connect to the database.
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: 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: Username generation template.

connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: 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: Username generation template.

SecretBackendConnectionMongodbatlas, SecretBackendConnectionMongodbatlasArgs

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, SecretBackendConnectionMssqlArgs

ConnectionUrl string: Connection string to use to connect to the database.
ContainedDb bool: Set to true when the target is a Contained Database, e.g. AzureSQL.
DisableEscaping bool: Disable special character escaping in username and password
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: 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: Username generation template.

ConnectionUrl string: Connection string to use to connect to the database.
ContainedDb bool: Set to true when the target is a Contained Database, e.g. AzureSQL.
DisableEscaping bool: Disable special character escaping in username and password
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: 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: Username generation template.

connectionUrl String: Connection string to use to connect to the database.
containedDb Boolean: Set to true when the target is a Contained Database, e.g. AzureSQL.
disableEscaping Boolean: Disable special character escaping in username and password
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: 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: Username generation template.

connectionUrl string: Connection string to use to connect to the database.
containedDb boolean: Set to true when the target is a Contained Database, e.g. AzureSQL.
disableEscaping boolean: Disable special character escaping in username and password
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: 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: Username generation template.

connection_url str: Connection string to use to connect to the database.
contained_db bool: Set to true when the target is a Contained Database, e.g. AzureSQL.
disable_escaping bool: Disable special character escaping in username and password
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: 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: Username generation template.

connectionUrl String: Connection string to use to connect to the database.
containedDb Boolean: Set to true when the target is a Contained Database, e.g. AzureSQL.
disableEscaping Boolean: Disable special character escaping in username and password
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: 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: Username generation template.

SecretBackendConnectionMysql, SecretBackendConnectionMysqlArgs

AuthType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
ServiceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

AuthType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
ServiceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType String: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
serviceAccountJson String: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl string: Connection string to use to connect to the database.
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: Maximum number of open connections to the database.
password string: The root credential password used in the connection URL
serviceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

auth_type str: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connection_url str: Connection string to use to connect to the database.
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: Maximum number of open connections to the database.
password str: The root credential password used in the connection URL
service_account_json str: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType String: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
serviceAccountJson String: A JSON encoded credential for use with IAM authorization
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: Username generation template.

SecretBackendConnectionMysqlAurora, SecretBackendConnectionMysqlAuroraArgs

AuthType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
ServiceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

AuthType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
ServiceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType String: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
serviceAccountJson String: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl string: Connection string to use to connect to the database.
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: Maximum number of open connections to the database.
password string: The root credential password used in the connection URL
serviceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

auth_type str: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connection_url str: Connection string to use to connect to the database.
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: Maximum number of open connections to the database.
password str: The root credential password used in the connection URL
service_account_json str: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType String: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
serviceAccountJson String: A JSON encoded credential for use with IAM authorization
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: Username generation template.

SecretBackendConnectionMysqlLegacy, SecretBackendConnectionMysqlLegacyArgs

AuthType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
ServiceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

AuthType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
ServiceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType String: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
serviceAccountJson String: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl string: Connection string to use to connect to the database.
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: Maximum number of open connections to the database.
password string: The root credential password used in the connection URL
serviceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

auth_type str: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connection_url str: Connection string to use to connect to the database.
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: Maximum number of open connections to the database.
password str: The root credential password used in the connection URL
service_account_json str: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType String: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
serviceAccountJson String: A JSON encoded credential for use with IAM authorization
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: Username generation template.

SecretBackendConnectionMysqlRds, SecretBackendConnectionMysqlRdsArgs

AuthType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
ServiceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

AuthType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
ServiceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType String: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
serviceAccountJson String: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl string: Connection string to use to connect to the database.
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: Maximum number of open connections to the database.
password string: The root credential password used in the connection URL
serviceAccountJson string: A JSON encoded credential for use with IAM authorization
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: Username generation template.

auth_type str: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connection_url str: Connection string to use to connect to the database.
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: Maximum number of open connections to the database.
password str: The root credential password used in the connection URL
service_account_json str: A JSON encoded credential for use with IAM authorization
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: Username generation template.

authType String: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
serviceAccountJson String: A JSON encoded credential for use with IAM authorization
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: Username generation template.

SecretBackendConnectionOracle, SecretBackendConnectionOracleArgs

ConnectionUrl string: Connection string to use to connect to the database.
DisconnectSessions bool: Set to true to disconnect any open sessions prior to running the revocation statements.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
SplitStatements bool: Set to true in order to split statements after semi-colons.
Username string: The root credential username used in the connection URL
UsernameTemplate string: Username generation template.

ConnectionUrl string: Connection string to use to connect to the database.
DisconnectSessions bool: Set to true to disconnect any open sessions prior to running the revocation statements.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
SplitStatements bool: Set to true in order to split statements after semi-colons.
Username string: The root credential username used in the connection URL
UsernameTemplate string: Username generation template.

connectionUrl String: Connection string to use to connect to the database.
disconnectSessions Boolean: Set to true to disconnect any open sessions prior to running the revocation statements.
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
splitStatements Boolean: Set to true in order to split statements after semi-colons.
username String: The root credential username used in the connection URL
usernameTemplate String: Username generation template.

connectionUrl string: Connection string to use to connect to the database.
disconnectSessions boolean: Set to true to disconnect any open sessions prior to running the revocation statements.
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: Maximum number of open connections to the database.
password string: The root credential password used in the connection URL
splitStatements boolean: Set to true in order to split statements after semi-colons.
username string: The root credential username used in the connection URL
usernameTemplate string: Username generation template.

connection_url str: Connection string to use to connect to the database.
disconnect_sessions bool: Set to true to disconnect any open sessions prior to running the revocation statements.
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: Maximum number of open connections to the database.
password str: The root credential password used in the connection URL
split_statements bool: Set to true in order to split statements after semi-colons.
username str: The root credential username used in the connection URL
username_template str: Username generation template.

connectionUrl String: Connection string to use to connect to the database.
disconnectSessions Boolean: Set to true to disconnect any open sessions prior to running the revocation statements.
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
splitStatements Boolean: Set to true in order to split statements after semi-colons.
username String: The root credential username used in the connection URL
usernameTemplate String: Username generation template.

SecretBackendConnectionPostgresql, SecretBackendConnectionPostgresqlArgs

AuthType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
ConnectionUrl string: Connection string to use to connect to the database.
DisableEscaping bool: Disable special character escaping in username and password
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
ServiceAccountJson string: A JSON encoded credential for use with IAM authorization
Username string: The root credential username used in the connection URL
UsernameTemplate string: Username generation template.

AuthType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
ConnectionUrl string: Connection string to use to connect to the database.
DisableEscaping bool: Disable special character escaping in username and password
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: Maximum number of open connections to the database.
Password string: The root credential password used in the connection URL
ServiceAccountJson string: A JSON encoded credential for use with IAM authorization
Username string: The root credential username used in the connection URL
UsernameTemplate string: Username generation template.

authType String: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl String: Connection string to use to connect to the database.
disableEscaping Boolean: Disable special character escaping in username and password
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
serviceAccountJson String: A JSON encoded credential for use with IAM authorization
username String: The root credential username used in the connection URL
usernameTemplate String: Username generation template.

authType string: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl string: Connection string to use to connect to the database.
disableEscaping boolean: Disable special character escaping in username and password
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: Maximum number of open connections to the database.
password string: The root credential password used in the connection URL
serviceAccountJson string: A JSON encoded credential for use with IAM authorization
username string: The root credential username used in the connection URL
usernameTemplate string: Username generation template.

auth_type str: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connection_url str: Connection string to use to connect to the database.
disable_escaping bool: Disable special character escaping in username and password
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: Maximum number of open connections to the database.
password str: The root credential password used in the connection URL
service_account_json str: A JSON encoded credential for use with IAM authorization
username str: The root credential username used in the connection URL
username_template str: Username generation template.

authType String: Specify alternative authorization type. (Only 'gcp_iam' is valid currently)
connectionUrl String: Connection string to use to connect to the database.
disableEscaping Boolean: Disable special character escaping in username and password
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: Maximum number of open connections to the database.
password String: The root credential password used in the connection URL
serviceAccountJson String: A JSON encoded credential for use with IAM authorization
username String: The root credential username used in the connection URL
usernameTemplate String: Username generation template.

SecretBackendConnectionRedis, SecretBackendConnectionRedisArgs

Host string: Specifies the host to connect to
Password string: Specifies the password corresponding to the given username.
Username string: Specifies the username for Vault to use.
CaCert string: The contents of a PEM-encoded CA cert file to use to verify the Redis server's identity.
InsecureTls bool: Specifies whether to skip verification of the server certificate when using TLS.
Port int: The transport port to use to connect to Redis.
Tls bool: Specifies whether to use TLS when connecting to Redis.

Host string: Specifies the host to connect to
Password string: Specifies the password corresponding to the given username.
Username string: Specifies the username for Vault to use.
CaCert string: The contents of a PEM-encoded CA cert file to use to verify the Redis server's identity.
InsecureTls bool: Specifies whether to skip verification of the server certificate when using TLS.
Port int: The transport port to use to connect to Redis.
Tls bool: Specifies whether to use TLS when connecting to Redis.

host String: Specifies the host to connect to
password String: Specifies the password corresponding to the given username.
username String: Specifies the username for Vault to use.
caCert String: The contents of a PEM-encoded CA cert file to use to verify the Redis server's identity.
insecureTls Boolean: Specifies whether to skip verification of the server certificate when using TLS.
port Integer: The transport port to use to connect to Redis.
tls Boolean: Specifies whether to use TLS when connecting to Redis.

host string: Specifies the host to connect to
password string: Specifies the password corresponding to the given username.
username string: Specifies the username for Vault to use.
caCert string: The contents of a PEM-encoded CA cert file to use to verify the Redis server's identity.
insecureTls boolean: Specifies whether to skip verification of the server certificate when using TLS.
port number: The transport port to use to connect to Redis.
tls boolean: Specifies whether to use TLS when connecting to Redis.

host str: Specifies the host to connect to
password str: Specifies the password corresponding to the given username.
username str: Specifies the username for Vault to use.
ca_cert str: The contents of a PEM-encoded CA cert file to use to verify the Redis server's identity.
insecure_tls bool: Specifies whether to skip verification of the server certificate when using TLS.
port int: The transport port to use to connect to Redis.
tls bool: Specifies whether to use TLS when connecting to Redis.

host String: Specifies the host to connect to
password String: Specifies the password corresponding to the given username.
username String: Specifies the username for Vault to use.
caCert String: The contents of a PEM-encoded CA cert file to use to verify the Redis server's identity.
insecureTls Boolean: Specifies whether to skip verification of the server certificate when using TLS.
port Number: The transport port to use to connect to Redis.
tls Boolean: Specifies whether to use TLS when connecting to Redis.

SecretBackendConnectionRedisElasticache, SecretBackendConnectionRedisElasticacheArgs

Url string: The configuration endpoint for the ElastiCache cluster to connect to.
Password string: The AWS secret key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.
Region string: The AWS region where the ElastiCache cluster is hosted. If omitted the plugin tries to infer the region from the environment.
Username string: The AWS access key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.

Url string: The configuration endpoint for the ElastiCache cluster to connect to.
Password string: The AWS secret key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.
Region string: The AWS region where the ElastiCache cluster is hosted. If omitted the plugin tries to infer the region from the environment.
Username string: The AWS access key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.

url String: The configuration endpoint for the ElastiCache cluster to connect to.
password String: The AWS secret key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.
region String: The AWS region where the ElastiCache cluster is hosted. If omitted the plugin tries to infer the region from the environment.
username String: The AWS access key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.

url string: The configuration endpoint for the ElastiCache cluster to connect to.
password string: The AWS secret key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.
region string: The AWS region where the ElastiCache cluster is hosted. If omitted the plugin tries to infer the region from the environment.
username string: The AWS access key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.

url str: The configuration endpoint for the ElastiCache cluster to connect to.
password str: The AWS secret key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.
region str: The AWS region where the ElastiCache cluster is hosted. If omitted the plugin tries to infer the region from the environment.
username str: The AWS access key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.

url String: The configuration endpoint for the ElastiCache cluster to connect to.
password String: The AWS secret key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.
region String: The AWS region where the ElastiCache cluster is hosted. If omitted the plugin tries to infer the region from the environment.
username String: The AWS access key id to use to talk to ElastiCache. If omitted the credentials chain provider is used instead.

SecretBackendConnectionRedshift, SecretBackendConnectionRedshiftArgs

ConnectionUrl string: Connection string to use to connect to the database.
DisableEscaping bool: Disable special character escaping in username and password
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: 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: Username generation template.

ConnectionUrl string: Connection string to use to connect to the database.
DisableEscaping bool: Disable special character escaping in username and password
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: 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: Username generation template.

connectionUrl String: Connection string to use to connect to the database.
disableEscaping Boolean: Disable special character escaping in username and password
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: 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: Username generation template.

connectionUrl string: Connection string to use to connect to the database.
disableEscaping boolean: Disable special character escaping in username and password
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: 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: Username generation template.

connection_url str: Connection string to use to connect to the database.
disable_escaping bool: Disable special character escaping in username and password
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: 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: Username generation template.

connectionUrl String: Connection string to use to connect to the database.
disableEscaping Boolean: Disable special character escaping in username and password
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: 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: Username generation template.

SecretBackendConnectionSnowflake, SecretBackendConnectionSnowflakeArgs

ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: 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: Username generation template.

ConnectionUrl string: Connection string to use to connect to the database.
MaxConnectionLifetime int: Maximum number of seconds a connection may be reused.
MaxIdleConnections int: Maximum number of idle connections to the database.
MaxOpenConnections int: 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: Username generation template.

connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Integer: Maximum number of seconds a connection may be reused.
maxIdleConnections Integer: Maximum number of idle connections to the database.
maxOpenConnections Integer: 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: Username generation template.

connectionUrl string: Connection string to use to connect to the database.
maxConnectionLifetime number: Maximum number of seconds a connection may be reused.
maxIdleConnections number: Maximum number of idle connections to the database.
maxOpenConnections number: 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: Username generation template.

connection_url str: Connection string to use to connect to the database.
max_connection_lifetime int: Maximum number of seconds a connection may be reused.
max_idle_connections int: Maximum number of idle connections to the database.
max_open_connections int: 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: Username generation template.

connectionUrl String: Connection string to use to connect to the database.
maxConnectionLifetime Number: Maximum number of seconds a connection may be reused.
maxIdleConnections Number: Maximum number of idle connections to the database.
maxOpenConnections Number: 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: Username generation template.

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Vault pulumi/pulumi-vault
License: Apache-2.0
Notes: This Pulumi package is based on the vault Terraform Provider.

HashiCorp Vault v6.2.0 published on Friday, Jun 21, 2024 by Pulumi

pulumi/pulumi-vault

vault.database.SecretBackendConnection

On this page

On this page

Example Usage

Create SecretBackendConnection Resource

Constructor syntax

Parameters

Constructor example

SecretBackendConnection Resource Properties

Inputs

Outputs

Look up Existing SecretBackendConnection Resource

Supporting Types

SecretBackendConnectionCassandra, SecretBackendConnectionCassandraArgs

SecretBackendConnectionCouchbase, SecretBackendConnectionCouchbaseArgs

SecretBackendConnectionElasticsearch, SecretBackendConnectionElasticsearchArgs

SecretBackendConnectionHana, SecretBackendConnectionHanaArgs

SecretBackendConnectionInfluxdb, SecretBackendConnectionInfluxdbArgs

SecretBackendConnectionMongodb, SecretBackendConnectionMongodbArgs

SecretBackendConnectionMongodbatlas, SecretBackendConnectionMongodbatlasArgs

SecretBackendConnectionMssql, SecretBackendConnectionMssqlArgs

SecretBackendConnectionMysql, SecretBackendConnectionMysqlArgs

SecretBackendConnectionMysqlAurora, SecretBackendConnectionMysqlAuroraArgs

SecretBackendConnectionMysqlLegacy, SecretBackendConnectionMysqlLegacyArgs

SecretBackendConnectionMysqlRds, SecretBackendConnectionMysqlRdsArgs

SecretBackendConnectionOracle, SecretBackendConnectionOracleArgs

SecretBackendConnectionPostgresql, SecretBackendConnectionPostgresqlArgs

SecretBackendConnectionRedis, SecretBackendConnectionRedisArgs

SecretBackendConnectionRedisElasticache, SecretBackendConnectionRedisElasticacheArgs

SecretBackendConnectionRedshift, SecretBackendConnectionRedshiftArgs

SecretBackendConnectionSnowflake, SecretBackendConnectionSnowflakeArgs

Import

Package Details

On this page

On this page