Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. cosmosdb
  5. PostgresqlCluster

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

azure.cosmosdb.PostgresqlCluster

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-azure

    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)

    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
	})
}

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

    Create PostgresqlCluster Resource

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

    Constructor syntax

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

@overload
def PostgresqlCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      node_count: Optional[int] = None,
                      resource_group_name: Optional[str] = None,
                      coordinator_vcore_count: Optional[int] = None,
                      node_storage_quota_in_mb: Optional[int] = None,
                      coordinator_storage_quota_in_mb: Optional[int] = None,
                      administrator_login_password: Optional[str] = None,
                      ha_enabled: Optional[bool] = None,
                      location: Optional[str] = None,
                      maintenance_window: Optional[PostgresqlClusterMaintenanceWindowArgs] = None,
                      name: Optional[str] = None,
                      coordinator_public_ip_access_enabled: Optional[bool] = None,
                      node_public_ip_access_enabled: Optional[bool] = None,
                      node_server_edition: Optional[str] = None,
                      coordinator_server_edition: Optional[str] = None,
                      node_vcores: Optional[int] = None,
                      point_in_time_in_utc: Optional[str] = None,
                      preferred_primary_zone: Optional[str] = None,
                      citus_version: Optional[str] = None,
                      shards_on_coordinator_enabled: Optional[bool] = None,
                      source_location: Optional[str] = None,
                      source_resource_id: Optional[str] = None,
                      sql_version: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
    func NewPostgresqlCluster(ctx *Context, name string, args PostgresqlClusterArgs, opts ...ResourceOption) (*PostgresqlCluster, error)
    public PostgresqlCluster(string name, PostgresqlClusterArgs args, CustomResourceOptions? opts = null)
    public PostgresqlCluster(String name, PostgresqlClusterArgs args)
public PostgresqlCluster(String name, PostgresqlClusterArgs args, CustomResourceOptions options)

    type: azure:cosmosdb:PostgresqlCluster
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 PostgresqlClusterArgs
    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 PostgresqlClusterArgs
    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 PostgresqlClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PostgresqlClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PostgresqlClusterArgs
    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 postgresqlClusterResource = new Azure.CosmosDB.PostgresqlCluster("postgresqlClusterResource", new()
{
    NodeCount = 0,
    ResourceGroupName = "string",
    CoordinatorVcoreCount = 0,
    NodeStorageQuotaInMb = 0,
    CoordinatorStorageQuotaInMb = 0,
    AdministratorLoginPassword = "string",
    HaEnabled = false,
    Location = "string",
    MaintenanceWindow = new Azure.CosmosDB.Inputs.PostgresqlClusterMaintenanceWindowArgs
    {
        DayOfWeek = 0,
        StartHour = 0,
        StartMinute = 0,
    },
    Name = "string",
    CoordinatorPublicIpAccessEnabled = false,
    NodePublicIpAccessEnabled = false,
    NodeServerEdition = "string",
    CoordinatorServerEdition = "string",
    NodeVcores = 0,
    PointInTimeInUtc = "string",
    PreferredPrimaryZone = "string",
    CitusVersion = "string",
    ShardsOnCoordinatorEnabled = false,
    SourceLocation = "string",
    SourceResourceId = "string",
    SqlVersion = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cosmosdb.NewPostgresqlCluster(ctx, "postgresqlClusterResource", &cosmosdb.PostgresqlClusterArgs{
	NodeCount:                   pulumi.Int(0),
	ResourceGroupName:           pulumi.String("string"),
	CoordinatorVcoreCount:       pulumi.Int(0),
	NodeStorageQuotaInMb:        pulumi.Int(0),
	CoordinatorStorageQuotaInMb: pulumi.Int(0),
	AdministratorLoginPassword:  pulumi.String("string"),
	HaEnabled:                   pulumi.Bool(false),
	Location:                    pulumi.String("string"),
	MaintenanceWindow: &cosmosdb.PostgresqlClusterMaintenanceWindowArgs{
		DayOfWeek:   pulumi.Int(0),
		StartHour:   pulumi.Int(0),
		StartMinute: pulumi.Int(0),
	},
	Name:                             pulumi.String("string"),
	CoordinatorPublicIpAccessEnabled: pulumi.Bool(false),
	NodePublicIpAccessEnabled:        pulumi.Bool(false),
	NodeServerEdition:                pulumi.String("string"),
	CoordinatorServerEdition:         pulumi.String("string"),
	NodeVcores:                       pulumi.Int(0),
	PointInTimeInUtc:                 pulumi.String("string"),
	PreferredPrimaryZone:             pulumi.String("string"),
	CitusVersion:                     pulumi.String("string"),
	ShardsOnCoordinatorEnabled:       pulumi.Bool(false),
	SourceLocation:                   pulumi.String("string"),
	SourceResourceId:                 pulumi.String("string"),
	SqlVersion:                       pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var postgresqlClusterResource = new PostgresqlCluster("postgresqlClusterResource", PostgresqlClusterArgs.builder()
    .nodeCount(0)
    .resourceGroupName("string")
    .coordinatorVcoreCount(0)
    .nodeStorageQuotaInMb(0)
    .coordinatorStorageQuotaInMb(0)
    .administratorLoginPassword("string")
    .haEnabled(false)
    .location("string")
    .maintenanceWindow(PostgresqlClusterMaintenanceWindowArgs.builder()
        .dayOfWeek(0)
        .startHour(0)
        .startMinute(0)
        .build())
    .name("string")
    .coordinatorPublicIpAccessEnabled(false)
    .nodePublicIpAccessEnabled(false)
    .nodeServerEdition("string")
    .coordinatorServerEdition("string")
    .nodeVcores(0)
    .pointInTimeInUtc("string")
    .preferredPrimaryZone("string")
    .citusVersion("string")
    .shardsOnCoordinatorEnabled(false)
    .sourceLocation("string")
    .sourceResourceId("string")
    .sqlVersion("string")
    .tags(Map.of("string", "string"))
    .build());

    postgresql_cluster_resource = azure.cosmosdb.PostgresqlCluster("postgresqlClusterResource",
    node_count=0,
    resource_group_name="string",
    coordinator_vcore_count=0,
    node_storage_quota_in_mb=0,
    coordinator_storage_quota_in_mb=0,
    administrator_login_password="string",
    ha_enabled=False,
    location="string",
    maintenance_window={
        "dayOfWeek": 0,
        "startHour": 0,
        "startMinute": 0,
    },
    name="string",
    coordinator_public_ip_access_enabled=False,
    node_public_ip_access_enabled=False,
    node_server_edition="string",
    coordinator_server_edition="string",
    node_vcores=0,
    point_in_time_in_utc="string",
    preferred_primary_zone="string",
    citus_version="string",
    shards_on_coordinator_enabled=False,
    source_location="string",
    source_resource_id="string",
    sql_version="string",
    tags={
        "string": "string",
    })

    const postgresqlClusterResource = new azure.cosmosdb.PostgresqlCluster("postgresqlClusterResource", {
    nodeCount: 0,
    resourceGroupName: "string",
    coordinatorVcoreCount: 0,
    nodeStorageQuotaInMb: 0,
    coordinatorStorageQuotaInMb: 0,
    administratorLoginPassword: "string",
    haEnabled: false,
    location: "string",
    maintenanceWindow: {
        dayOfWeek: 0,
        startHour: 0,
        startMinute: 0,
    },
    name: "string",
    coordinatorPublicIpAccessEnabled: false,
    nodePublicIpAccessEnabled: false,
    nodeServerEdition: "string",
    coordinatorServerEdition: "string",
    nodeVcores: 0,
    pointInTimeInUtc: "string",
    preferredPrimaryZone: "string",
    citusVersion: "string",
    shardsOnCoordinatorEnabled: false,
    sourceLocation: "string",
    sourceResourceId: "string",
    sqlVersion: "string",
    tags: {
        string: "string",
    },
});

    type: azure:cosmosdb:PostgresqlCluster
properties:
    administratorLoginPassword: string
    citusVersion: string
    coordinatorPublicIpAccessEnabled: false
    coordinatorServerEdition: string
    coordinatorStorageQuotaInMb: 0
    coordinatorVcoreCount: 0
    haEnabled: false
    location: string
    maintenanceWindow:
        dayOfWeek: 0
        startHour: 0
        startMinute: 0
    name: string
    nodeCount: 0
    nodePublicIpAccessEnabled: false
    nodeServerEdition: string
    nodeStorageQuotaInMb: 0
    nodeVcores: 0
    pointInTimeInUtc: string
    preferredPrimaryZone: string
    resourceGroupName: string
    shardsOnCoordinatorEnabled: false
    sourceLocation: string
    sourceResourceId: string
    sqlVersion: string
    tags:
        string: string

    PostgresqlCluster 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 PostgresqlCluster resource accepts the following input properties:

    NodeCount int
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    ResourceGroupName 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.
    AdministratorLoginPassword string
    The password of the administrator login. This is required when source_resource_id is not set.
    CitusVersion 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 bool
    Is public access enabled on coordinator? Defaults to true.
    CoordinatorServerEdition string
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    CoordinatorStorageQuotaInMb 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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    CoordinatorVcoreCount 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.
    HaEnabled bool
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    Location string
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    MaintenanceWindow PostgresqlClusterMaintenanceWindow
    A maintenance_window block as defined below.
    Name string
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    NodePublicIpAccessEnabled bool
    Is public access enabled on worker nodes. Defaults to false.
    NodeServerEdition string
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    NodeStorageQuotaInMb 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 int
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    PointInTimeInUtc 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 string
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    ShardsOnCoordinatorEnabled bool
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    SourceLocation 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 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 string
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.
    NodeCount int
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    ResourceGroupName 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.
    AdministratorLoginPassword string
    The password of the administrator login. This is required when source_resource_id is not set.
    CitusVersion 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 bool
    Is public access enabled on coordinator? Defaults to true.
    CoordinatorServerEdition string
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    CoordinatorStorageQuotaInMb 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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    CoordinatorVcoreCount 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.
    HaEnabled bool
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    Location string
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    MaintenanceWindow PostgresqlClusterMaintenanceWindowArgs
    A maintenance_window block as defined below.
    Name string
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    NodePublicIpAccessEnabled bool
    Is public access enabled on worker nodes. Defaults to false.
    NodeServerEdition string
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    NodeStorageQuotaInMb 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 int
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    PointInTimeInUtc 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 string
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    ShardsOnCoordinatorEnabled bool
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    SourceLocation 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 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 string
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    Tags map[string]string
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.
    nodeCount Integer
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    resourceGroupName 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.
    administratorLoginPassword String
    The password of the administrator login. This is required when source_resource_id is not set.
    citusVersion 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 Boolean
    Is public access enabled on coordinator? Defaults to true.
    coordinatorServerEdition String
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    coordinatorStorageQuotaInMb Integer

    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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    coordinatorVcoreCount Integer
    The coordinator vCore count for the Azure Cosmos DB for PostgreSQL Cluster. Possible values are 1, 2, 4, 8, 16, 32, 64 and 96.
    haEnabled Boolean
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    location String
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    maintenanceWindow PostgresqlClusterMaintenanceWindow
    A maintenance_window block as defined below.
    name String
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    nodePublicIpAccessEnabled Boolean
    Is public access enabled on worker nodes. Defaults to false.
    nodeServerEdition String
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    nodeStorageQuotaInMb Integer
    The storage quota in MB on each worker node. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608 and 16777216.
    nodeVcores Integer
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    pointInTimeInUtc 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 String
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    shardsOnCoordinatorEnabled Boolean
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    sourceLocation 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 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 String
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.
    nodeCount number
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    resourceGroupName 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.
    administratorLoginPassword string
    The password of the administrator login. This is required when source_resource_id is not set.
    citusVersion 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 boolean
    Is public access enabled on coordinator? Defaults to true.
    coordinatorServerEdition string
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    coordinatorStorageQuotaInMb number

    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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    coordinatorVcoreCount number
    The coordinator vCore count for the Azure Cosmos DB for PostgreSQL Cluster. Possible values are 1, 2, 4, 8, 16, 32, 64 and 96.
    haEnabled boolean
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    location string
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    maintenanceWindow PostgresqlClusterMaintenanceWindow
    A maintenance_window block as defined below.
    name string
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    nodePublicIpAccessEnabled boolean
    Is public access enabled on worker nodes. Defaults to false.
    nodeServerEdition string
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    nodeStorageQuotaInMb number
    The storage quota in MB on each worker node. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608 and 16777216.
    nodeVcores number
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    pointInTimeInUtc 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 string
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    shardsOnCoordinatorEnabled boolean
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    sourceLocation 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 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 string
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.
    node_count int
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    resource_group_name str
    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.
    administrator_login_password str
    The password of the administrator login. This is required when source_resource_id is not set.
    citus_version str
    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.
    coordinator_public_ip_access_enabled bool
    Is public access enabled on coordinator? Defaults to true.
    coordinator_server_edition str
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    coordinator_storage_quota_in_mb 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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    coordinator_vcore_count 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.
    ha_enabled bool
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    location str
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    maintenance_window PostgresqlClusterMaintenanceWindowArgs
    A maintenance_window block as defined below.
    name str
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    node_public_ip_access_enabled bool
    Is public access enabled on worker nodes. Defaults to false.
    node_server_edition str
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    node_storage_quota_in_mb int
    The storage quota in MB on each worker node. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608 and 16777216.
    node_vcores int
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    point_in_time_in_utc str
    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.
    preferred_primary_zone str
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    shards_on_coordinator_enabled bool
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    source_location str
    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.
    source_resource_id str
    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.
    sql_version str
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.
    nodeCount Number
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    resourceGroupName 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.
    administratorLoginPassword String
    The password of the administrator login. This is required when source_resource_id is not set.
    citusVersion 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 Boolean
    Is public access enabled on coordinator? Defaults to true.
    coordinatorServerEdition String
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    coordinatorStorageQuotaInMb Number

    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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    coordinatorVcoreCount Number
    The coordinator vCore count for the Azure Cosmos DB for PostgreSQL Cluster. Possible values are 1, 2, 4, 8, 16, 32, 64 and 96.
    haEnabled Boolean
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    location String
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    maintenanceWindow Property Map
    A maintenance_window block as defined below.
    name String
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    nodePublicIpAccessEnabled Boolean
    Is public access enabled on worker nodes. Defaults to false.
    nodeServerEdition String
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    nodeStorageQuotaInMb Number
    The storage quota in MB on each worker node. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608 and 16777216.
    nodeVcores Number
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    pointInTimeInUtc 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 String
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    shardsOnCoordinatorEnabled Boolean
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    sourceLocation 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 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 String
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    tags Map<String>
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PostgresqlCluster resource produces the following output properties:

    EarliestRestoreTime string
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Servers List<PostgresqlClusterServer>
    A servers block as defined below.
    EarliestRestoreTime string
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    Servers []PostgresqlClusterServer
    A servers block as defined below.
    earliestRestoreTime String
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    servers List<PostgresqlClusterServer>
    A servers block as defined below.
    earliestRestoreTime string
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    servers PostgresqlClusterServer[]
    A servers block as defined below.
    earliest_restore_time str
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    servers Sequence[PostgresqlClusterServer]
    A servers block as defined below.
    earliestRestoreTime String
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    servers List<Property Map>
    A servers block as defined below.

    Look up Existing PostgresqlCluster Resource

    Get an existing PostgresqlCluster 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?: PostgresqlClusterState, opts?: CustomResourceOptions): PostgresqlCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        administrator_login_password: Optional[str] = None,
        citus_version: Optional[str] = None,
        coordinator_public_ip_access_enabled: Optional[bool] = None,
        coordinator_server_edition: Optional[str] = None,
        coordinator_storage_quota_in_mb: Optional[int] = None,
        coordinator_vcore_count: Optional[int] = None,
        earliest_restore_time: Optional[str] = None,
        ha_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        maintenance_window: Optional[PostgresqlClusterMaintenanceWindowArgs] = None,
        name: Optional[str] = None,
        node_count: Optional[int] = None,
        node_public_ip_access_enabled: Optional[bool] = None,
        node_server_edition: Optional[str] = None,
        node_storage_quota_in_mb: Optional[int] = None,
        node_vcores: Optional[int] = None,
        point_in_time_in_utc: Optional[str] = None,
        preferred_primary_zone: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        servers: Optional[Sequence[PostgresqlClusterServerArgs]] = None,
        shards_on_coordinator_enabled: Optional[bool] = None,
        source_location: Optional[str] = None,
        source_resource_id: Optional[str] = None,
        sql_version: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> PostgresqlCluster
    func GetPostgresqlCluster(ctx *Context, name string, id IDInput, state *PostgresqlClusterState, opts ...ResourceOption) (*PostgresqlCluster, error)
    public static PostgresqlCluster Get(string name, Input<string> id, PostgresqlClusterState? state, CustomResourceOptions? opts = null)
    public static PostgresqlCluster get(String name, Output<String> id, PostgresqlClusterState 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:
    AdministratorLoginPassword string
    The password of the administrator login. This is required when source_resource_id is not set.
    CitusVersion 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 bool
    Is public access enabled on coordinator? Defaults to true.
    CoordinatorServerEdition string
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    CoordinatorStorageQuotaInMb 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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    CoordinatorVcoreCount 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 string
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    HaEnabled bool
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    Location string
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    MaintenanceWindow PostgresqlClusterMaintenanceWindow
    A maintenance_window block as defined below.
    Name 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 int
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    NodePublicIpAccessEnabled bool
    Is public access enabled on worker nodes. Defaults to false.
    NodeServerEdition string
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    NodeStorageQuotaInMb 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 int
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    PointInTimeInUtc 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 string
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    ResourceGroupName 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.
    Servers List<PostgresqlClusterServer>
    A servers block as defined below.
    ShardsOnCoordinatorEnabled bool
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    SourceLocation 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 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 string
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.
    AdministratorLoginPassword string
    The password of the administrator login. This is required when source_resource_id is not set.
    CitusVersion 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 bool
    Is public access enabled on coordinator? Defaults to true.
    CoordinatorServerEdition string
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    CoordinatorStorageQuotaInMb 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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    CoordinatorVcoreCount 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 string
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    HaEnabled bool
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    Location string
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    MaintenanceWindow PostgresqlClusterMaintenanceWindowArgs
    A maintenance_window block as defined below.
    Name 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 int
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    NodePublicIpAccessEnabled bool
    Is public access enabled on worker nodes. Defaults to false.
    NodeServerEdition string
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    NodeStorageQuotaInMb 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 int
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    PointInTimeInUtc 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 string
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    ResourceGroupName 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.
    Servers []PostgresqlClusterServerArgs
    A servers block as defined below.
    ShardsOnCoordinatorEnabled bool
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    SourceLocation 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 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 string
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    Tags map[string]string
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.
    administratorLoginPassword String
    The password of the administrator login. This is required when source_resource_id is not set.
    citusVersion 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 Boolean
    Is public access enabled on coordinator? Defaults to true.
    coordinatorServerEdition String
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    coordinatorStorageQuotaInMb Integer

    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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    coordinatorVcoreCount Integer
    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 String
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    haEnabled Boolean
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    location String
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    maintenanceWindow PostgresqlClusterMaintenanceWindow
    A maintenance_window block as defined below.
    name 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 Integer
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    nodePublicIpAccessEnabled Boolean
    Is public access enabled on worker nodes. Defaults to false.
    nodeServerEdition String
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    nodeStorageQuotaInMb Integer
    The storage quota in MB on each worker node. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608 and 16777216.
    nodeVcores Integer
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    pointInTimeInUtc 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 String
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    resourceGroupName 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.
    servers List<PostgresqlClusterServer>
    A servers block as defined below.
    shardsOnCoordinatorEnabled Boolean
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    sourceLocation 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 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 String
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.
    administratorLoginPassword string
    The password of the administrator login. This is required when source_resource_id is not set.
    citusVersion 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 boolean
    Is public access enabled on coordinator? Defaults to true.
    coordinatorServerEdition string
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    coordinatorStorageQuotaInMb number

    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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    coordinatorVcoreCount number
    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 string
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    haEnabled boolean
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    location string
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    maintenanceWindow PostgresqlClusterMaintenanceWindow
    A maintenance_window block as defined below.
    name 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 number
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    nodePublicIpAccessEnabled boolean
    Is public access enabled on worker nodes. Defaults to false.
    nodeServerEdition string
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    nodeStorageQuotaInMb number
    The storage quota in MB on each worker node. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608 and 16777216.
    nodeVcores number
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    pointInTimeInUtc 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 string
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    resourceGroupName 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.
    servers PostgresqlClusterServer[]
    A servers block as defined below.
    shardsOnCoordinatorEnabled boolean
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    sourceLocation 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 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 string
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.
    administrator_login_password str
    The password of the administrator login. This is required when source_resource_id is not set.
    citus_version str
    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.
    coordinator_public_ip_access_enabled bool
    Is public access enabled on coordinator? Defaults to true.
    coordinator_server_edition str
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    coordinator_storage_quota_in_mb 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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    coordinator_vcore_count 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.
    earliest_restore_time str
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    ha_enabled bool
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    location str
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    maintenance_window PostgresqlClusterMaintenanceWindowArgs
    A maintenance_window block as defined below.
    name str
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    node_count int
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    node_public_ip_access_enabled bool
    Is public access enabled on worker nodes. Defaults to false.
    node_server_edition str
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    node_storage_quota_in_mb int
    The storage quota in MB on each worker node. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608 and 16777216.
    node_vcores int
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    point_in_time_in_utc str
    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.
    preferred_primary_zone str
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    resource_group_name str
    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.
    servers Sequence[PostgresqlClusterServerArgs]
    A servers block as defined below.
    shards_on_coordinator_enabled bool
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    source_location str
    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.
    source_resource_id str
    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.
    sql_version str
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.
    administratorLoginPassword String
    The password of the administrator login. This is required when source_resource_id is not set.
    citusVersion 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 Boolean
    Is public access enabled on coordinator? Defaults to true.
    coordinatorServerEdition String
    The edition of the coordinator server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to GeneralPurpose.
    coordinatorStorageQuotaInMb Number

    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.

    NOTE: More information on the types of compute resources available for CosmosDB can be found in the product documentation

    coordinatorVcoreCount Number
    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 String
    The earliest restore point time (ISO8601 format) for the Azure Cosmos DB for PostgreSQL Cluster.
    haEnabled Boolean
    Is high availability enabled for the Azure Cosmos DB for PostgreSQL cluster? Defaults to false.
    location String
    The Azure Region where the Azure Cosmos DB for PostgreSQL Cluster should exist. Changing this forces a new resource to be created.
    maintenanceWindow Property Map
    A maintenance_window block as defined below.
    name 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 Number
    The worker node count of the Azure Cosmos DB for PostgreSQL Cluster. Possible value is between 0 and 20 except 1.
    nodePublicIpAccessEnabled Boolean
    Is public access enabled on worker nodes. Defaults to false.
    nodeServerEdition String
    The edition of the node server. Possible values are BurstableGeneralPurpose, BurstableMemoryOptimized, GeneralPurpose and MemoryOptimized. Defaults to MemoryOptimized.
    nodeStorageQuotaInMb Number
    The storage quota in MB on each worker node. Possible values are 32768, 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608 and 16777216.
    nodeVcores Number
    The vCores count on each worker node. Possible values are 1, 2, 4, 8, 16, 32, 64, 96 and 104.
    pointInTimeInUtc 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 String
    The preferred primary availability zone for the Azure Cosmos DB for PostgreSQL cluster.
    resourceGroupName 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.
    servers List<Property Map>
    A servers block as defined below.
    shardsOnCoordinatorEnabled Boolean
    Is shards on coordinator enabled for the Azure Cosmos DB for PostgreSQL cluster.
    sourceLocation 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 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 String
    The major PostgreSQL version on the Azure Cosmos DB for PostgreSQL cluster. Possible values are 11, 12, 13, 14, 15 and 16.
    tags Map<String>
    A mapping of tags which should be assigned to the Azure Cosmos DB for PostgreSQL Cluster.

    Supporting Types

    PostgresqlClusterMaintenanceWindow, PostgresqlClusterMaintenanceWindowArgs

    DayOfWeek int
    The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday = 0, Monday = 1. Defaults to 0.
    StartHour int
    The start hour for maintenance window. Defaults to 0.
    StartMinute int
    The start minute for maintenance window. Defaults to 0.
    DayOfWeek int
    The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday = 0, Monday = 1. Defaults to 0.
    StartHour int
    The start hour for maintenance window. Defaults to 0.
    StartMinute int
    The start minute for maintenance window. Defaults to 0.
    dayOfWeek Integer
    The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday = 0, Monday = 1. Defaults to 0.
    startHour Integer
    The start hour for maintenance window. Defaults to 0.
    startMinute Integer
    The start minute for maintenance window. Defaults to 0.
    dayOfWeek number
    The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday = 0, Monday = 1. Defaults to 0.
    startHour number
    The start hour for maintenance window. Defaults to 0.
    startMinute number
    The start minute for maintenance window. Defaults to 0.
    day_of_week int
    The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday = 0, Monday = 1. Defaults to 0.
    start_hour int
    The start hour for maintenance window. Defaults to 0.
    start_minute int
    The start minute for maintenance window. Defaults to 0.
    dayOfWeek Number
    The day of week for maintenance window, where the week starts on a Sunday, i.e. Sunday = 0, Monday = 1. Defaults to 0.
    startHour Number
    The start hour for maintenance window. Defaults to 0.
    startMinute Number
    The start minute for maintenance window. Defaults to 0.

    PostgresqlClusterServer, PostgresqlClusterServerArgs

    Fqdn string
    The Fully Qualified Domain Name of the server.
    Name string
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    Fqdn string
    The Fully Qualified Domain Name of the server.
    Name string
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    fqdn String
    The Fully Qualified Domain Name of the server.
    name String
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    fqdn string
    The Fully Qualified Domain Name of the server.
    name string
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    fqdn str
    The Fully Qualified Domain Name of the server.
    name str
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.
    fqdn String
    The Fully Qualified Domain Name of the server.
    name String
    The name which should be used for this Azure Cosmos DB for PostgreSQL Cluster. Changing this forces a new resource to be created.

    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

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v6.2.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-azure