PostgresqlCluster

class PostgresqlCluster : KotlinCustomResource

Manages an Azure Cosmos DB for PostgreSQL Cluster.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const examplePostgresqlCluster = new azure.cosmosdb.PostgresqlCluster("example", {
name: "example-cluster",
resourceGroupName: example.name,
location: example.location,
administratorLoginPassword: "H@Sh1CoR3!",
coordinatorStorageQuotaInMb: 131072,
coordinatorVcoreCount: 2,
nodeCount: 0,
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_postgresql_cluster = azure.cosmosdb.PostgresqlCluster("example",
name="example-cluster",
resource_group_name=example.name,
location=example.location,
administrator_login_password="H@Sh1CoR3!",
coordinator_storage_quota_in_mb=131072,
coordinator_vcore_count=2,
node_count=0)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var examplePostgresqlCluster = new Azure.CosmosDB.PostgresqlCluster("example", new()
{
Name = "example-cluster",
ResourceGroupName = example.Name,
Location = example.Location,
AdministratorLoginPassword = "H@Sh1CoR3!",
CoordinatorStorageQuotaInMb = 131072,
CoordinatorVcoreCount = 2,
NodeCount = 0,
});
});
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/cosmosdb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = cosmosdb.NewPostgresqlCluster(ctx, "example", &cosmosdb.PostgresqlClusterArgs{
Name: pulumi.String("example-cluster"),
ResourceGroupName: example.Name,
Location: example.Location,
AdministratorLoginPassword: pulumi.String("H@Sh1CoR3!"),
CoordinatorStorageQuotaInMb: pulumi.Int(131072),
CoordinatorVcoreCount: pulumi.Int(2),
NodeCount: pulumi.Int(0),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.cosmosdb.PostgresqlCluster;
import com.pulumi.azure.cosmosdb.PostgresqlClusterArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var examplePostgresqlCluster = new PostgresqlCluster("examplePostgresqlCluster", PostgresqlClusterArgs.builder()
.name("example-cluster")
.resourceGroupName(example.name())
.location(example.location())
.administratorLoginPassword("H@Sh1CoR3!")
.coordinatorStorageQuotaInMb(131072)
.coordinatorVcoreCount(2)
.nodeCount(0)
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
examplePostgresqlCluster:
type: azure:cosmosdb:PostgresqlCluster
name: example
properties:
name: example-cluster
resourceGroupName: ${example.name}
location: ${example.location}
administratorLoginPassword: H@Sh1CoR3!
coordinatorStorageQuotaInMb: 131072
coordinatorVcoreCount: 2
nodeCount: 0

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.DBforPostgreSQL: 2022-11-08

Import

Azure Cosmos DB for PostgreSQL Clusters can be imported using the resource id, e.g.

$ pulumi import azure:cosmosdb/postgresqlCluster:PostgresqlCluster example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/cluster1

Properties

Link copied to clipboard

The password of the administrator login. This is required when source_resource_id is not set.

Link copied to clipboard
val citusVersion: Output<String>

The citus extension version on the Azure Cosmos DB for PostgreSQL Cluster. Possible values are 8.3, 9.0, 9.1, 9.2, 9.3, 9.4, 9.5, 10.0, 10.1, 10.2, 11.0, 11.1, 11.2, 11.3 and 12.1.

Link copied to clipboard

Is public access enabled on coordinator? Defaults to true.

Link copied to clipboard

The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.

Link copied to clipboard

The coordinator storage allowed for the Azure Cosmos DB for PostgreSQL Cluster. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, 16777216, and 33554432.

Link copied to clipboard

The coordinator vCore count for the Azure Cosmos DB for PostgreSQL Cluster. Possible values are 1, 2, 4, 8, 16, 32, 64 and 96.

Link copied to clipboard

The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.

Link copied to clipboard
val haEnabled: Output<Boolean>?

Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>

The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.

Link copied to clipboard

A maintenance_window block as defined below.

Link copied to clipboard
val name: Output<String>

The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.

Link copied to clipboard
val nodeCount: Output<Int>

The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.

Link copied to clipboard

Is public access enabled on worker nodes. Defaults to false.

Link copied to clipboard

The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.

Link copied to clipboard

The storage quota in MB on each worker node. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608 and 16777216.

Link copied to clipboard
val nodeVcores: Output<Int>

The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.

Link copied to clipboard
val pointInTimeInUtc: Output<String>?

The date and time in UTC (ISO8601 format) for the Azure Cosmos DB for PostgreSQL cluster restore. Changing this forces a new resource to be created.

Link copied to clipboard

The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The name of the Resource Group where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.

Link copied to clipboard

A servers block as defined below.

Link copied to clipboard

Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.

Link copied to clipboard
val sourceLocation: Output<String>?

The Azure region of the source Azure Cosmos DB for PostgreSQL cluster for read replica clusters. Changing this forces a new resource to be created.

Link copied to clipboard
val sourceResourceId: Output<String>?

The resource ID of the source Azure Cosmos DB for PostgreSQL cluster for read replica clusters. Changing this forces a new resource to be created.

Link copied to clipboard
val sqlVersion: Output<String>

The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.

Link copied to clipboard
val tags: Output<Map<String, String>>?

A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.

Link copied to clipboard
val urn: Output<String>