Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vultr
  3. API Docs
  4. DatabaseConnectionPool
Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien
dirien/pulumi-vultr

vultr.DatabaseConnectionPool

Explore with Pulumi AI

Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien
dirien/pulumi-vultr

Provides a Vultr database connection pool resource. This can be used to create, read, modify, and delete connection pools for a PostgreSQL managed database on your Vultr account.

Example Usage

Create a new database connection pool:

import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@ediri/vultr";

const myDatabaseConnectionPool = new vultr.DatabaseConnectionPool("myDatabaseConnectionPool", {
    databaseId: vultr_database.my_database.id,
    database: "defaultdb",
    username: "vultradmin",
    mode: "transaction",
    size: 3,
});
Copy
import pulumi
import ediri_vultr as vultr

my_database_connection_pool = vultr.DatabaseConnectionPool("myDatabaseConnectionPool",
    database_id=vultr_database["my_database"]["id"],
    database="defaultdb",
    username="vultradmin",
    mode="transaction",
    size=3)
Copy
package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.NewDatabaseConnectionPool(ctx, "myDatabaseConnectionPool", &vultr.DatabaseConnectionPoolArgs{
			DatabaseId: pulumi.Any(vultr_database.My_database.Id),
			Database:   pulumi.String("defaultdb"),
			Username:   pulumi.String("vultradmin"),
			Mode:       pulumi.String("transaction"),
			Size:       pulumi.Int(3),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = ediri.Vultr;

return await Deployment.RunAsync(() => 
{
    var myDatabaseConnectionPool = new Vultr.DatabaseConnectionPool("myDatabaseConnectionPool", new()
    {
        DatabaseId = vultr_database.My_database.Id,
        Database = "defaultdb",
        Username = "vultradmin",
        Mode = "transaction",
        Size = 3,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.DatabaseConnectionPool;
import com.pulumi.vultr.DatabaseConnectionPoolArgs;
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 myDatabaseConnectionPool = new DatabaseConnectionPool("myDatabaseConnectionPool", DatabaseConnectionPoolArgs.builder()
            .databaseId(vultr_database.my_database().id())
            .database("defaultdb")
            .username("vultradmin")
            .mode("transaction")
            .size("3")
            .build());

    }
}
Copy
resources:
  myDatabaseConnectionPool:
    type: vultr:DatabaseConnectionPool
    properties:
      databaseId: ${vultr_database.my_database.id}
      database: defaultdb
      username: vultradmin
      mode: transaction
      size: '3'
Copy

Create DatabaseConnectionPool Resource

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

Constructor syntax

new DatabaseConnectionPool(name: string, args: DatabaseConnectionPoolArgs, opts?: CustomResourceOptions);
@overload
def DatabaseConnectionPool(resource_name: str,
                           args: DatabaseConnectionPoolArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def DatabaseConnectionPool(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           database: Optional[str] = None,
                           database_id: Optional[str] = None,
                           mode: Optional[str] = None,
                           size: Optional[int] = None,
                           username: Optional[str] = None,
                           name: Optional[str] = None)
func NewDatabaseConnectionPool(ctx *Context, name string, args DatabaseConnectionPoolArgs, opts ...ResourceOption) (*DatabaseConnectionPool, error)
public DatabaseConnectionPool(string name, DatabaseConnectionPoolArgs args, CustomResourceOptions? opts = null)
public DatabaseConnectionPool(String name, DatabaseConnectionPoolArgs args)
public DatabaseConnectionPool(String name, DatabaseConnectionPoolArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DatabaseConnectionPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. DatabaseConnectionPoolArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseConnectionPoolArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DatabaseConnectionPoolArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DatabaseConnectionPoolArgs
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 databaseConnectionPoolResource = new Vultr.DatabaseConnectionPool("databaseConnectionPoolResource", new()
{
    Database = "string",
    DatabaseId = "string",
    Mode = "string",
    Size = 0,
    Username = "string",
    Name = "string",
});
Copy
example, err := vultr.NewDatabaseConnectionPool(ctx, "databaseConnectionPoolResource", &vultr.DatabaseConnectionPoolArgs{
	Database:   pulumi.String("string"),
	DatabaseId: pulumi.String("string"),
	Mode:       pulumi.String("string"),
	Size:       pulumi.Int(0),
	Username:   pulumi.String("string"),
	Name:       pulumi.String("string"),
})
Copy
var databaseConnectionPoolResource = new DatabaseConnectionPool("databaseConnectionPoolResource", DatabaseConnectionPoolArgs.builder()
    .database("string")
    .databaseId("string")
    .mode("string")
    .size(0)
    .username("string")
    .name("string")
    .build());
Copy
database_connection_pool_resource = vultr.DatabaseConnectionPool("databaseConnectionPoolResource",
    database="string",
    database_id="string",
    mode="string",
    size=0,
    username="string",
    name="string")
Copy
const databaseConnectionPoolResource = new vultr.DatabaseConnectionPool("databaseConnectionPoolResource", {
    database: "string",
    databaseId: "string",
    mode: "string",
    size: 0,
    username: "string",
    name: "string",
});
Copy
type: vultr:DatabaseConnectionPool
properties:
    database: string
    databaseId: string
    mode: string
    name: string
    size: 0
    username: string
Copy

DatabaseConnectionPool Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DatabaseConnectionPool resource accepts the following input properties:

Database This property is required. string
The logical database to use for the new managed database connection pool.
DatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The managed database ID you want to attach this connection pool to.
Mode This property is required. string
The mode to configure for the new managed database connection pool (session, transaction, statement).
Size This property is required. int
The size of the new managed database connection pool.
Username This property is required. string
The database user to use for the new managed database connection pool.
Name Changes to this property will trigger replacement. string
The name of the new managed database connection pool.
Database This property is required. string
The logical database to use for the new managed database connection pool.
DatabaseId
This property is required.
Changes to this property will trigger replacement.
string
The managed database ID you want to attach this connection pool to.
Mode This property is required. string
The mode to configure for the new managed database connection pool (session, transaction, statement).
Size This property is required. int
The size of the new managed database connection pool.
Username This property is required. string
The database user to use for the new managed database connection pool.
Name Changes to this property will trigger replacement. string
The name of the new managed database connection pool.
database This property is required. String
The logical database to use for the new managed database connection pool.
databaseId
This property is required.
Changes to this property will trigger replacement.
String
The managed database ID you want to attach this connection pool to.
mode This property is required. String
The mode to configure for the new managed database connection pool (session, transaction, statement).
size This property is required. Integer
The size of the new managed database connection pool.
username This property is required. String
The database user to use for the new managed database connection pool.
name Changes to this property will trigger replacement. String
The name of the new managed database connection pool.
database This property is required. string
The logical database to use for the new managed database connection pool.
databaseId
This property is required.
Changes to this property will trigger replacement.
string
The managed database ID you want to attach this connection pool to.
mode This property is required. string
The mode to configure for the new managed database connection pool (session, transaction, statement).
size This property is required. number
The size of the new managed database connection pool.
username This property is required. string
The database user to use for the new managed database connection pool.
name Changes to this property will trigger replacement. string
The name of the new managed database connection pool.
database This property is required. str
The logical database to use for the new managed database connection pool.
database_id
This property is required.
Changes to this property will trigger replacement.
str
The managed database ID you want to attach this connection pool to.
mode This property is required. str
The mode to configure for the new managed database connection pool (session, transaction, statement).
size This property is required. int
The size of the new managed database connection pool.
username This property is required. str
The database user to use for the new managed database connection pool.
name Changes to this property will trigger replacement. str
The name of the new managed database connection pool.
database This property is required. String
The logical database to use for the new managed database connection pool.
databaseId
This property is required.
Changes to this property will trigger replacement.
String
The managed database ID you want to attach this connection pool to.
mode This property is required. String
The mode to configure for the new managed database connection pool (session, transaction, statement).
size This property is required. Number
The size of the new managed database connection pool.
username This property is required. String
The database user to use for the new managed database connection pool.
name Changes to this property will trigger replacement. String
The name of the new managed database connection pool.

Outputs

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

Get an existing DatabaseConnectionPool 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?: DatabaseConnectionPoolState, opts?: CustomResourceOptions): DatabaseConnectionPool
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        database: Optional[str] = None,
        database_id: Optional[str] = None,
        mode: Optional[str] = None,
        name: Optional[str] = None,
        size: Optional[int] = None,
        username: Optional[str] = None) -> DatabaseConnectionPool
func GetDatabaseConnectionPool(ctx *Context, name string, id IDInput, state *DatabaseConnectionPoolState, opts ...ResourceOption) (*DatabaseConnectionPool, error)
public static DatabaseConnectionPool Get(string name, Input<string> id, DatabaseConnectionPoolState? state, CustomResourceOptions? opts = null)
public static DatabaseConnectionPool get(String name, Output<String> id, DatabaseConnectionPoolState state, CustomResourceOptions options)
resources:  _:    type: vultr:DatabaseConnectionPool    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Database string
The logical database to use for the new managed database connection pool.
DatabaseId Changes to this property will trigger replacement. string
The managed database ID you want to attach this connection pool to.
Mode string
The mode to configure for the new managed database connection pool (session, transaction, statement).
Name Changes to this property will trigger replacement. string
The name of the new managed database connection pool.
Size int
The size of the new managed database connection pool.
Username string
The database user to use for the new managed database connection pool.
Database string
The logical database to use for the new managed database connection pool.
DatabaseId Changes to this property will trigger replacement. string
The managed database ID you want to attach this connection pool to.
Mode string
The mode to configure for the new managed database connection pool (session, transaction, statement).
Name Changes to this property will trigger replacement. string
The name of the new managed database connection pool.
Size int
The size of the new managed database connection pool.
Username string
The database user to use for the new managed database connection pool.
database String
The logical database to use for the new managed database connection pool.
databaseId Changes to this property will trigger replacement. String
The managed database ID you want to attach this connection pool to.
mode String
The mode to configure for the new managed database connection pool (session, transaction, statement).
name Changes to this property will trigger replacement. String
The name of the new managed database connection pool.
size Integer
The size of the new managed database connection pool.
username String
The database user to use for the new managed database connection pool.
database string
The logical database to use for the new managed database connection pool.
databaseId Changes to this property will trigger replacement. string
The managed database ID you want to attach this connection pool to.
mode string
The mode to configure for the new managed database connection pool (session, transaction, statement).
name Changes to this property will trigger replacement. string
The name of the new managed database connection pool.
size number
The size of the new managed database connection pool.
username string
The database user to use for the new managed database connection pool.
database str
The logical database to use for the new managed database connection pool.
database_id Changes to this property will trigger replacement. str
The managed database ID you want to attach this connection pool to.
mode str
The mode to configure for the new managed database connection pool (session, transaction, statement).
name Changes to this property will trigger replacement. str
The name of the new managed database connection pool.
size int
The size of the new managed database connection pool.
username str
The database user to use for the new managed database connection pool.
database String
The logical database to use for the new managed database connection pool.
databaseId Changes to this property will trigger replacement. String
The managed database ID you want to attach this connection pool to.
mode String
The mode to configure for the new managed database connection pool (session, transaction, statement).
name Changes to this property will trigger replacement. String
The name of the new managed database connection pool.
size Number
The size of the new managed database connection pool.
username String
The database user to use for the new managed database connection pool.

Package Details

Repository
vultr dirien/pulumi-vultr
License
Apache-2.0
Notes
This Pulumi package is based on the vultr Terraform Provider.
Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien
dirien/pulumi-vultr