GetDatabaseCluster

Provides information on a DigitalOcean database cluster resource.

Example Usage

using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(DigitalOcean.GetDatabaseCluster.InvokeAsync(new DigitalOcean.GetDatabaseClusterArgs
        {
            Name = "example-cluster",
        }));
        this.DatabaseOutput = example.Apply(example => example.Uri);
    }

    [Output("databaseOutput")]
    public Output<string> DatabaseOutput { get; set; }
}

Coming soon!

import pulumi
import pulumi_digitalocean as digitalocean

example = digitalocean.get_database_cluster(name="example-cluster")
pulumi.export("databaseOutput", example.uri)

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

const example = digitalocean.getDatabaseCluster({
    name: "example-cluster",
});
export const databaseOutput = example.then(example => example.uri);

Using GetDatabaseCluster

function getDatabaseCluster(args: GetDatabaseClusterArgs, opts?: InvokeOptions): Promise<GetDatabaseClusterResult>

function  get_database_cluster(name=None, tags=None, opts=None)

func LookupDatabaseCluster(ctx *Context, args *LookupDatabaseClusterArgs, opts ...InvokeOption) (*LookupDatabaseClusterResult, error)

Note: This function is named LookupDatabaseCluster in the Go SDK.

public static class GetDatabaseCluster {
    public static Task<GetDatabaseClusterResult> InvokeAsync(GetDatabaseClusterArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: The name of the database cluster.
Tags List<string>

Name string: The name of the database cluster.
Tags []string

name string: The name of the database cluster.
tags string[]

name str: The name of the database cluster.
tags List[str]

GetDatabaseCluster Result

The following output properties are available:

Database string: Name of the cluster’s default database.
Engine string: Database engine used by the cluster (ex. pg for PostreSQL).
Host string: Database cluster’s hostname.
Id string: The provider-assigned unique ID for this managed resource.
MaintenanceWindows List<Pulumi.DigitalOcean.Outputs.GetDatabaseClusterMaintenanceWindow>: Defines when the automatic maintenance should be performed for the database cluster.
Name string
NodeCount int: Number of nodes that will be included in the cluster.
Password string: Password for the cluster’s default user.
Port int: Network port that the database cluster is listening on.
PrivateHost string: Same as host, but only accessible from resources within the account and in the same region.
PrivateNetworkUuid string: The ID of the VPC where the database cluster is located.
PrivateUri string: Same as uri, but only accessible from resources within the account and in the same region.
Region string: DigitalOcean region where the cluster will reside.
Size string: Database droplet size associated with the cluster (ex. db-s-1vcpu-1gb).
Uri string: The full URI for connecting to the database cluster.
Urn string: The uniform resource name of the database cluster.
User string: Username for the cluster’s default user.
Version string: Engine version used by the cluster (ex. 11 for PostgreSQL 11).
Tags List<string>

Database string: Name of the cluster’s default database.
Engine string: Database engine used by the cluster (ex. pg for PostreSQL).
Host string: Database cluster’s hostname.
Id string: The provider-assigned unique ID for this managed resource.
MaintenanceWindows []GetDatabaseClusterMaintenanceWindow: Defines when the automatic maintenance should be performed for the database cluster.
Name string
NodeCount int: Number of nodes that will be included in the cluster.
Password string: Password for the cluster’s default user.
Port int: Network port that the database cluster is listening on.
PrivateHost string: Same as host, but only accessible from resources within the account and in the same region.
PrivateNetworkUuid string: The ID of the VPC where the database cluster is located.
PrivateUri string: Same as uri, but only accessible from resources within the account and in the same region.
Region string: DigitalOcean region where the cluster will reside.
Size string: Database droplet size associated with the cluster (ex. db-s-1vcpu-1gb).
Uri string: The full URI for connecting to the database cluster.
Urn string: The uniform resource name of the database cluster.
User string: Username for the cluster’s default user.
Version string: Engine version used by the cluster (ex. 11 for PostgreSQL 11).
Tags []string

database string: Name of the cluster’s default database.
engine string: Database engine used by the cluster (ex. pg for PostreSQL).
host string: Database cluster’s hostname.
id string: The provider-assigned unique ID for this managed resource.
maintenanceWindows GetDatabaseClusterMaintenanceWindow[]: Defines when the automatic maintenance should be performed for the database cluster.
name string
nodeCount number: Number of nodes that will be included in the cluster.
password string: Password for the cluster’s default user.
port number: Network port that the database cluster is listening on.
privateHost string: Same as host, but only accessible from resources within the account and in the same region.
privateNetworkUuid string: The ID of the VPC where the database cluster is located.
privateUri string: Same as uri, but only accessible from resources within the account and in the same region.
region string: DigitalOcean region where the cluster will reside.
size string: Database droplet size associated with the cluster (ex. db-s-1vcpu-1gb).
uri string: The full URI for connecting to the database cluster.
urn string: The uniform resource name of the database cluster.
user string: Username for the cluster’s default user.
version string: Engine version used by the cluster (ex. 11 for PostgreSQL 11).
tags string[]

database str: Name of the cluster’s default database.
engine str: Database engine used by the cluster (ex. pg for PostreSQL).
host str: Database cluster’s hostname.
id str: The provider-assigned unique ID for this managed resource.
maintenance_windows List[GetDatabaseClusterMaintenanceWindow]: Defines when the automatic maintenance should be performed for the database cluster.
name str
node_count float: Number of nodes that will be included in the cluster.
password str: Password for the cluster’s default user.
port float: Network port that the database cluster is listening on.
private_host str: Same as host, but only accessible from resources within the account and in the same region.
private_network_uuid str: The ID of the VPC where the database cluster is located.
private_uri str: Same as uri, but only accessible from resources within the account and in the same region.
region str: DigitalOcean region where the cluster will reside.
size str: Database droplet size associated with the cluster (ex. db-s-1vcpu-1gb).
uri str: The full URI for connecting to the database cluster.
urn str: The uniform resource name of the database cluster.
user str: Username for the cluster’s default user.
version str: Engine version used by the cluster (ex. 11 for PostgreSQL 11).
tags List[str]

Supporting Types

GetDatabaseClusterMaintenanceWindow

See the output API doc for this type.

Day string: The day of the week on which to apply maintenance updates.
Hour string: The hour in UTC at which maintenance updates will be applied in 24 hour format.

Day string: The day of the week on which to apply maintenance updates.
Hour string: The hour in UTC at which maintenance updates will be applied in 24 hour format.

day string: The day of the week on which to apply maintenance updates.
hour string: The hour in UTC at which maintenance updates will be applied in 24 hour format.

day str: The day of the week on which to apply maintenance updates.
hour str: The hour in UTC at which maintenance updates will be applied in 24 hour format.

Package Details

Repository: https://github.com/pulumi/pulumi-digitalocean
License: Apache-2.0
Notes: This Pulumi package is based on the digitalocean Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetDatabaseCluster

Example Usage

Using GetDatabaseCluster

GetDatabaseCluster Result

Supporting Types

GetDatabaseClusterMaintenanceWindow

Package Details

On This Page