pulumi-azure-kotlin/com.pulumi.azure.cosmosdb.kotlin/PostgresqlCluster

PostgresqlCluster

class PostgresqlCluster : KotlinCustomResource

Manages an Azure Cosmos DB for PostgreSQL Cluster.

Example Usage

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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
            .location("West Europe")
            .build());
        var examplePostgresqlCluster = new PostgresqlCluster("examplePostgresqlCluster", PostgresqlClusterArgs.builder()
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .administratorLoginPassword("H@Sh1CoR3!")
            .coordinatorStorageQuotaInMb(131072)
            .coordinatorVcoreCount(2)
            .nodeCount(0)
            .build());
    }
}

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

administratorLoginPassword

val administratorLoginPassword: Output<String>

The password of the administrator login.

citusVersion

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.

coordinatorPublicIpAccessEnabled

val coordinatorPublicIpAccessEnabled: Output<Boolean>?

Is public access enabled on coordinator? Defaults to true.

coordinatorServerEdition

val coordinatorServerEdition: Output<String>?

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

coordinatorStorageQuotaInMb

val coordinatorStorageQuotaInMb: Output<Int>

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.

coordinatorVcoreCount

val coordinatorVcoreCount: Output<Int>

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

earliestRestoreTime

val earliestRestoreTime: Output<String>

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

haEnabled

val haEnabled: Output<Boolean>?

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

val id: Output<String>

location

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.

maintenanceWindow

val maintenanceWindow: Output<PostgresqlClusterMaintenanceWindow>?

A maintenance_window block as defined below.

name

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.

nodeCount

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.

nodePublicIpAccessEnabled

val nodePublicIpAccessEnabled: Output<Boolean>?

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

nodeServerEdition

val nodeServerEdition: Output<String>?

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

nodeStorageQuotaInMb

val nodeStorageQuotaInMb: Output<Int>

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

nodeVcores

val nodeVcores: Output<Int>

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

pointInTimeInUtc

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.

preferredPrimaryZone

val preferredPrimaryZone: Output<String>?

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

resourceGroupName

val resourceGroupName: Output<String>

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.

shardsOnCoordinatorEnabled

val shardsOnCoordinatorEnabled: Output<Boolean>

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

sourceLocation

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.

sourceResourceId

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.

sqlVersion

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.