azure-native.dbforpostgresql.Cluster
Explore with Pulumi AI
Represents a cluster. Azure REST API version: 2022-11-08.
Other available API versions: 2023-03-02-preview.
Example Usage
Create a new cluster as a point in time restore
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var cluster = new AzureNative.DBforPostgreSQL.Cluster("cluster", new()
{
ClusterName = "testcluster",
Location = "westus",
PointInTimeUTC = "2017-12-14T00:00:37.467Z",
ResourceGroupName = "TestGroup",
SourceLocation = "westus",
SourceResourceId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/source-cluster",
});
});
package main
import (
dbforpostgresql "github.com/pulumi/pulumi-azure-native-sdk/dbforpostgresql/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dbforpostgresql.NewCluster(ctx, "cluster", &dbforpostgresql.ClusterArgs{
ClusterName: pulumi.String("testcluster"),
Location: pulumi.String("westus"),
PointInTimeUTC: pulumi.String("2017-12-14T00:00:37.467Z"),
ResourceGroupName: pulumi.String("TestGroup"),
SourceLocation: pulumi.String("westus"),
SourceResourceId: pulumi.String("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/source-cluster"),
})
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.azurenative.dbforpostgresql.Cluster;
import com.pulumi.azurenative.dbforpostgresql.ClusterArgs;
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 cluster = new Cluster("cluster", ClusterArgs.builder()
.clusterName("testcluster")
.location("westus")
.pointInTimeUTC("2017-12-14T00:00:37.467Z")
.resourceGroupName("TestGroup")
.sourceLocation("westus")
.sourceResourceId("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/source-cluster")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
cluster = azure_native.dbforpostgresql.Cluster("cluster",
cluster_name="testcluster",
location="westus",
point_in_time_utc="2017-12-14T00:00:37.467Z",
resource_group_name="TestGroup",
source_location="westus",
source_resource_id="/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/source-cluster")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const cluster = new azure_native.dbforpostgresql.Cluster("cluster", {
clusterName: "testcluster",
location: "westus",
pointInTimeUTC: "2017-12-14T00:00:37.467Z",
resourceGroupName: "TestGroup",
sourceLocation: "westus",
sourceResourceId: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/source-cluster",
});
resources:
cluster:
type: azure-native:dbforpostgresql:Cluster
properties:
clusterName: testcluster
location: westus
pointInTimeUTC: 2017-12-14T00:00:37.467Z
resourceGroupName: TestGroup
sourceLocation: westus
sourceResourceId: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/source-cluster
Create a new cluster as a read replica
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var cluster = new AzureNative.DBforPostgreSQL.Cluster("cluster", new()
{
ClusterName = "testcluster",
Location = "westus",
ResourceGroupName = "TestGroup",
SourceLocation = "westus",
SourceResourceId = "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/sourcecluster",
});
});
package main
import (
dbforpostgresql "github.com/pulumi/pulumi-azure-native-sdk/dbforpostgresql/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dbforpostgresql.NewCluster(ctx, "cluster", &dbforpostgresql.ClusterArgs{
ClusterName: pulumi.String("testcluster"),
Location: pulumi.String("westus"),
ResourceGroupName: pulumi.String("TestGroup"),
SourceLocation: pulumi.String("westus"),
SourceResourceId: pulumi.String("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/sourcecluster"),
})
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.azurenative.dbforpostgresql.Cluster;
import com.pulumi.azurenative.dbforpostgresql.ClusterArgs;
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 cluster = new Cluster("cluster", ClusterArgs.builder()
.clusterName("testcluster")
.location("westus")
.resourceGroupName("TestGroup")
.sourceLocation("westus")
.sourceResourceId("/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/sourcecluster")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
cluster = azure_native.dbforpostgresql.Cluster("cluster",
cluster_name="testcluster",
location="westus",
resource_group_name="TestGroup",
source_location="westus",
source_resource_id="/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/sourcecluster")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const cluster = new azure_native.dbforpostgresql.Cluster("cluster", {
clusterName: "testcluster",
location: "westus",
resourceGroupName: "TestGroup",
sourceLocation: "westus",
sourceResourceId: "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/sourcecluster",
});
resources:
cluster:
type: azure-native:dbforpostgresql:Cluster
properties:
clusterName: testcluster
location: westus
resourceGroupName: TestGroup
sourceLocation: westus
sourceResourceId: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestResourceGroup/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/sourcecluster
Create a new multi-node cluster
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var cluster = new AzureNative.DBforPostgreSQL.Cluster("cluster", new()
{
AdministratorLoginPassword = "password",
CitusVersion = "11.1",
ClusterName = "testcluster-multinode",
CoordinatorEnablePublicIpAccess = true,
CoordinatorServerEdition = "GeneralPurpose",
CoordinatorStorageQuotaInMb = 524288,
CoordinatorVCores = 4,
EnableHa = true,
EnableShardsOnCoordinator = false,
Location = "westus",
NodeCount = 3,
NodeEnablePublicIpAccess = false,
NodeServerEdition = "MemoryOptimized",
NodeStorageQuotaInMb = 524288,
NodeVCores = 8,
PostgresqlVersion = "15",
PreferredPrimaryZone = "1",
ResourceGroupName = "TestGroup",
Tags = null,
});
});
package main
import (
dbforpostgresql "github.com/pulumi/pulumi-azure-native-sdk/dbforpostgresql/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dbforpostgresql.NewCluster(ctx, "cluster", &dbforpostgresql.ClusterArgs{
AdministratorLoginPassword: pulumi.String("password"),
CitusVersion: pulumi.String("11.1"),
ClusterName: pulumi.String("testcluster-multinode"),
CoordinatorEnablePublicIpAccess: pulumi.Bool(true),
CoordinatorServerEdition: pulumi.String("GeneralPurpose"),
CoordinatorStorageQuotaInMb: pulumi.Int(524288),
CoordinatorVCores: pulumi.Int(4),
EnableHa: pulumi.Bool(true),
EnableShardsOnCoordinator: pulumi.Bool(false),
Location: pulumi.String("westus"),
NodeCount: pulumi.Int(3),
NodeEnablePublicIpAccess: pulumi.Bool(false),
NodeServerEdition: pulumi.String("MemoryOptimized"),
NodeStorageQuotaInMb: pulumi.Int(524288),
NodeVCores: pulumi.Int(8),
PostgresqlVersion: pulumi.String("15"),
PreferredPrimaryZone: pulumi.String("1"),
ResourceGroupName: pulumi.String("TestGroup"),
Tags: pulumi.StringMap{},
})
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.azurenative.dbforpostgresql.Cluster;
import com.pulumi.azurenative.dbforpostgresql.ClusterArgs;
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 cluster = new Cluster("cluster", ClusterArgs.builder()
.administratorLoginPassword("password")
.citusVersion("11.1")
.clusterName("testcluster-multinode")
.coordinatorEnablePublicIpAccess(true)
.coordinatorServerEdition("GeneralPurpose")
.coordinatorStorageQuotaInMb(524288)
.coordinatorVCores(4)
.enableHa(true)
.enableShardsOnCoordinator(false)
.location("westus")
.nodeCount(3)
.nodeEnablePublicIpAccess(false)
.nodeServerEdition("MemoryOptimized")
.nodeStorageQuotaInMb(524288)
.nodeVCores(8)
.postgresqlVersion("15")
.preferredPrimaryZone("1")
.resourceGroupName("TestGroup")
.tags()
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
cluster = azure_native.dbforpostgresql.Cluster("cluster",
administrator_login_password="password",
citus_version="11.1",
cluster_name="testcluster-multinode",
coordinator_enable_public_ip_access=True,
coordinator_server_edition="GeneralPurpose",
coordinator_storage_quota_in_mb=524288,
coordinator_v_cores=4,
enable_ha=True,
enable_shards_on_coordinator=False,
location="westus",
node_count=3,
node_enable_public_ip_access=False,
node_server_edition="MemoryOptimized",
node_storage_quota_in_mb=524288,
node_v_cores=8,
postgresql_version="15",
preferred_primary_zone="1",
resource_group_name="TestGroup",
tags={})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const cluster = new azure_native.dbforpostgresql.Cluster("cluster", {
administratorLoginPassword: "password",
citusVersion: "11.1",
clusterName: "testcluster-multinode",
coordinatorEnablePublicIpAccess: true,
coordinatorServerEdition: "GeneralPurpose",
coordinatorStorageQuotaInMb: 524288,
coordinatorVCores: 4,
enableHa: true,
enableShardsOnCoordinator: false,
location: "westus",
nodeCount: 3,
nodeEnablePublicIpAccess: false,
nodeServerEdition: "MemoryOptimized",
nodeStorageQuotaInMb: 524288,
nodeVCores: 8,
postgresqlVersion: "15",
preferredPrimaryZone: "1",
resourceGroupName: "TestGroup",
tags: {},
});
resources:
cluster:
type: azure-native:dbforpostgresql:Cluster
properties:
administratorLoginPassword: password
citusVersion: '11.1'
clusterName: testcluster-multinode
coordinatorEnablePublicIpAccess: true
coordinatorServerEdition: GeneralPurpose
coordinatorStorageQuotaInMb: 524288
coordinatorVCores: 4
enableHa: true
enableShardsOnCoordinator: false
location: westus
nodeCount: 3
nodeEnablePublicIpAccess: false
nodeServerEdition: MemoryOptimized
nodeStorageQuotaInMb: 524288
nodeVCores: 8
postgresqlVersion: '15'
preferredPrimaryZone: '1'
resourceGroupName: TestGroup
tags: {}
Create a new single node Burstable 1 vCore cluster
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var cluster = new AzureNative.DBforPostgreSQL.Cluster("cluster", new()
{
AdministratorLoginPassword = "password",
CitusVersion = "11.3",
ClusterName = "testcluster-burstablev1",
CoordinatorEnablePublicIpAccess = true,
CoordinatorServerEdition = "BurstableMemoryOptimized",
CoordinatorStorageQuotaInMb = 131072,
CoordinatorVCores = 1,
EnableHa = false,
EnableShardsOnCoordinator = true,
Location = "westus",
NodeCount = 0,
PostgresqlVersion = "15",
PreferredPrimaryZone = "1",
ResourceGroupName = "TestGroup",
Tags =
{
{ "owner", "JohnDoe" },
},
});
});
package main
import (
dbforpostgresql "github.com/pulumi/pulumi-azure-native-sdk/dbforpostgresql/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dbforpostgresql.NewCluster(ctx, "cluster", &dbforpostgresql.ClusterArgs{
AdministratorLoginPassword: pulumi.String("password"),
CitusVersion: pulumi.String("11.3"),
ClusterName: pulumi.String("testcluster-burstablev1"),
CoordinatorEnablePublicIpAccess: pulumi.Bool(true),
CoordinatorServerEdition: pulumi.String("BurstableMemoryOptimized"),
CoordinatorStorageQuotaInMb: pulumi.Int(131072),
CoordinatorVCores: pulumi.Int(1),
EnableHa: pulumi.Bool(false),
EnableShardsOnCoordinator: pulumi.Bool(true),
Location: pulumi.String("westus"),
NodeCount: pulumi.Int(0),
PostgresqlVersion: pulumi.String("15"),
PreferredPrimaryZone: pulumi.String("1"),
ResourceGroupName: pulumi.String("TestGroup"),
Tags: pulumi.StringMap{
"owner": pulumi.String("JohnDoe"),
},
})
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.azurenative.dbforpostgresql.Cluster;
import com.pulumi.azurenative.dbforpostgresql.ClusterArgs;
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 cluster = new Cluster("cluster", ClusterArgs.builder()
.administratorLoginPassword("password")
.citusVersion("11.3")
.clusterName("testcluster-burstablev1")
.coordinatorEnablePublicIpAccess(true)
.coordinatorServerEdition("BurstableMemoryOptimized")
.coordinatorStorageQuotaInMb(131072)
.coordinatorVCores(1)
.enableHa(false)
.enableShardsOnCoordinator(true)
.location("westus")
.nodeCount(0)
.postgresqlVersion("15")
.preferredPrimaryZone("1")
.resourceGroupName("TestGroup")
.tags(Map.of("owner", "JohnDoe"))
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
cluster = azure_native.dbforpostgresql.Cluster("cluster",
administrator_login_password="password",
citus_version="11.3",
cluster_name="testcluster-burstablev1",
coordinator_enable_public_ip_access=True,
coordinator_server_edition="BurstableMemoryOptimized",
coordinator_storage_quota_in_mb=131072,
coordinator_v_cores=1,
enable_ha=False,
enable_shards_on_coordinator=True,
location="westus",
node_count=0,
postgresql_version="15",
preferred_primary_zone="1",
resource_group_name="TestGroup",
tags={
"owner": "JohnDoe",
})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const cluster = new azure_native.dbforpostgresql.Cluster("cluster", {
administratorLoginPassword: "password",
citusVersion: "11.3",
clusterName: "testcluster-burstablev1",
coordinatorEnablePublicIpAccess: true,
coordinatorServerEdition: "BurstableMemoryOptimized",
coordinatorStorageQuotaInMb: 131072,
coordinatorVCores: 1,
enableHa: false,
enableShardsOnCoordinator: true,
location: "westus",
nodeCount: 0,
postgresqlVersion: "15",
preferredPrimaryZone: "1",
resourceGroupName: "TestGroup",
tags: {
owner: "JohnDoe",
},
});
resources:
cluster:
type: azure-native:dbforpostgresql:Cluster
properties:
administratorLoginPassword: password
citusVersion: '11.3'
clusterName: testcluster-burstablev1
coordinatorEnablePublicIpAccess: true
coordinatorServerEdition: BurstableMemoryOptimized
coordinatorStorageQuotaInMb: 131072
coordinatorVCores: 1
enableHa: false
enableShardsOnCoordinator: true
location: westus
nodeCount: 0
postgresqlVersion: '15'
preferredPrimaryZone: '1'
resourceGroupName: TestGroup
tags:
owner: JohnDoe
Create a new single node Burstable 2 vCores cluster
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var cluster = new AzureNative.DBforPostgreSQL.Cluster("cluster", new()
{
AdministratorLoginPassword = "password",
CitusVersion = "11.3",
ClusterName = "testcluster-burstablev2",
CoordinatorEnablePublicIpAccess = true,
CoordinatorServerEdition = "BurstableGeneralPurpose",
CoordinatorStorageQuotaInMb = 131072,
CoordinatorVCores = 2,
EnableHa = false,
EnableShardsOnCoordinator = true,
Location = "westus",
NodeCount = 0,
PostgresqlVersion = "15",
PreferredPrimaryZone = "1",
ResourceGroupName = "TestGroup",
Tags =
{
{ "owner", "JohnDoe" },
},
});
});
package main
import (
dbforpostgresql "github.com/pulumi/pulumi-azure-native-sdk/dbforpostgresql/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dbforpostgresql.NewCluster(ctx, "cluster", &dbforpostgresql.ClusterArgs{
AdministratorLoginPassword: pulumi.String("password"),
CitusVersion: pulumi.String("11.3"),
ClusterName: pulumi.String("testcluster-burstablev2"),
CoordinatorEnablePublicIpAccess: pulumi.Bool(true),
CoordinatorServerEdition: pulumi.String("BurstableGeneralPurpose"),
CoordinatorStorageQuotaInMb: pulumi.Int(131072),
CoordinatorVCores: pulumi.Int(2),
EnableHa: pulumi.Bool(false),
EnableShardsOnCoordinator: pulumi.Bool(true),
Location: pulumi.String("westus"),
NodeCount: pulumi.Int(0),
PostgresqlVersion: pulumi.String("15"),
PreferredPrimaryZone: pulumi.String("1"),
ResourceGroupName: pulumi.String("TestGroup"),
Tags: pulumi.StringMap{
"owner": pulumi.String("JohnDoe"),
},
})
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.azurenative.dbforpostgresql.Cluster;
import com.pulumi.azurenative.dbforpostgresql.ClusterArgs;
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 cluster = new Cluster("cluster", ClusterArgs.builder()
.administratorLoginPassword("password")
.citusVersion("11.3")
.clusterName("testcluster-burstablev2")
.coordinatorEnablePublicIpAccess(true)
.coordinatorServerEdition("BurstableGeneralPurpose")
.coordinatorStorageQuotaInMb(131072)
.coordinatorVCores(2)
.enableHa(false)
.enableShardsOnCoordinator(true)
.location("westus")
.nodeCount(0)
.postgresqlVersion("15")
.preferredPrimaryZone("1")
.resourceGroupName("TestGroup")
.tags(Map.of("owner", "JohnDoe"))
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
cluster = azure_native.dbforpostgresql.Cluster("cluster",
administrator_login_password="password",
citus_version="11.3",
cluster_name="testcluster-burstablev2",
coordinator_enable_public_ip_access=True,
coordinator_server_edition="BurstableGeneralPurpose",
coordinator_storage_quota_in_mb=131072,
coordinator_v_cores=2,
enable_ha=False,
enable_shards_on_coordinator=True,
location="westus",
node_count=0,
postgresql_version="15",
preferred_primary_zone="1",
resource_group_name="TestGroup",
tags={
"owner": "JohnDoe",
})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const cluster = new azure_native.dbforpostgresql.Cluster("cluster", {
administratorLoginPassword: "password",
citusVersion: "11.3",
clusterName: "testcluster-burstablev2",
coordinatorEnablePublicIpAccess: true,
coordinatorServerEdition: "BurstableGeneralPurpose",
coordinatorStorageQuotaInMb: 131072,
coordinatorVCores: 2,
enableHa: false,
enableShardsOnCoordinator: true,
location: "westus",
nodeCount: 0,
postgresqlVersion: "15",
preferredPrimaryZone: "1",
resourceGroupName: "TestGroup",
tags: {
owner: "JohnDoe",
},
});
resources:
cluster:
type: azure-native:dbforpostgresql:Cluster
properties:
administratorLoginPassword: password
citusVersion: '11.3'
clusterName: testcluster-burstablev2
coordinatorEnablePublicIpAccess: true
coordinatorServerEdition: BurstableGeneralPurpose
coordinatorStorageQuotaInMb: 131072
coordinatorVCores: 2
enableHa: false
enableShardsOnCoordinator: true
location: westus
nodeCount: 0
postgresqlVersion: '15'
preferredPrimaryZone: '1'
resourceGroupName: TestGroup
tags:
owner: JohnDoe
Create a new single node cluster
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var cluster = new AzureNative.DBforPostgreSQL.Cluster("cluster", new()
{
AdministratorLoginPassword = "password",
CitusVersion = "11.3",
ClusterName = "testcluster-singlenode",
CoordinatorEnablePublicIpAccess = true,
CoordinatorServerEdition = "GeneralPurpose",
CoordinatorStorageQuotaInMb = 131072,
CoordinatorVCores = 8,
EnableHa = true,
EnableShardsOnCoordinator = true,
Location = "westus",
NodeCount = 0,
PostgresqlVersion = "15",
PreferredPrimaryZone = "1",
ResourceGroupName = "TestGroup",
Tags =
{
{ "owner", "JohnDoe" },
},
});
});
package main
import (
dbforpostgresql "github.com/pulumi/pulumi-azure-native-sdk/dbforpostgresql/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := dbforpostgresql.NewCluster(ctx, "cluster", &dbforpostgresql.ClusterArgs{
AdministratorLoginPassword: pulumi.String("password"),
CitusVersion: pulumi.String("11.3"),
ClusterName: pulumi.String("testcluster-singlenode"),
CoordinatorEnablePublicIpAccess: pulumi.Bool(true),
CoordinatorServerEdition: pulumi.String("GeneralPurpose"),
CoordinatorStorageQuotaInMb: pulumi.Int(131072),
CoordinatorVCores: pulumi.Int(8),
EnableHa: pulumi.Bool(true),
EnableShardsOnCoordinator: pulumi.Bool(true),
Location: pulumi.String("westus"),
NodeCount: pulumi.Int(0),
PostgresqlVersion: pulumi.String("15"),
PreferredPrimaryZone: pulumi.String("1"),
ResourceGroupName: pulumi.String("TestGroup"),
Tags: pulumi.StringMap{
"owner": pulumi.String("JohnDoe"),
},
})
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.azurenative.dbforpostgresql.Cluster;
import com.pulumi.azurenative.dbforpostgresql.ClusterArgs;
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 cluster = new Cluster("cluster", ClusterArgs.builder()
.administratorLoginPassword("password")
.citusVersion("11.3")
.clusterName("testcluster-singlenode")
.coordinatorEnablePublicIpAccess(true)
.coordinatorServerEdition("GeneralPurpose")
.coordinatorStorageQuotaInMb(131072)
.coordinatorVCores(8)
.enableHa(true)
.enableShardsOnCoordinator(true)
.location("westus")
.nodeCount(0)
.postgresqlVersion("15")
.preferredPrimaryZone("1")
.resourceGroupName("TestGroup")
.tags(Map.of("owner", "JohnDoe"))
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
cluster = azure_native.dbforpostgresql.Cluster("cluster",
administrator_login_password="password",
citus_version="11.3",
cluster_name="testcluster-singlenode",
coordinator_enable_public_ip_access=True,
coordinator_server_edition="GeneralPurpose",
coordinator_storage_quota_in_mb=131072,
coordinator_v_cores=8,
enable_ha=True,
enable_shards_on_coordinator=True,
location="westus",
node_count=0,
postgresql_version="15",
preferred_primary_zone="1",
resource_group_name="TestGroup",
tags={
"owner": "JohnDoe",
})
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const cluster = new azure_native.dbforpostgresql.Cluster("cluster", {
administratorLoginPassword: "password",
citusVersion: "11.3",
clusterName: "testcluster-singlenode",
coordinatorEnablePublicIpAccess: true,
coordinatorServerEdition: "GeneralPurpose",
coordinatorStorageQuotaInMb: 131072,
coordinatorVCores: 8,
enableHa: true,
enableShardsOnCoordinator: true,
location: "westus",
nodeCount: 0,
postgresqlVersion: "15",
preferredPrimaryZone: "1",
resourceGroupName: "TestGroup",
tags: {
owner: "JohnDoe",
},
});
resources:
cluster:
type: azure-native:dbforpostgresql:Cluster
properties:
administratorLoginPassword: password
citusVersion: '11.3'
clusterName: testcluster-singlenode
coordinatorEnablePublicIpAccess: true
coordinatorServerEdition: GeneralPurpose
coordinatorStorageQuotaInMb: 131072
coordinatorVCores: 8
enableHa: true
enableShardsOnCoordinator: true
location: westus
nodeCount: 0
postgresqlVersion: '15'
preferredPrimaryZone: '1'
resourceGroupName: TestGroup
tags:
owner: JohnDoe
Create Cluster Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
maintenance_window: Optional[MaintenanceWindowArgs] = None,
coordinator_enable_public_ip_access: Optional[bool] = None,
node_enable_public_ip_access: Optional[bool] = None,
coordinator_server_edition: Optional[str] = None,
coordinator_storage_quota_in_mb: Optional[int] = None,
coordinator_v_cores: Optional[int] = None,
enable_ha: Optional[bool] = None,
enable_shards_on_coordinator: Optional[bool] = None,
node_server_edition: Optional[str] = None,
administrator_login_password: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
cluster_name: Optional[str] = None,
location: Optional[str] = None,
node_storage_quota_in_mb: Optional[int] = None,
node_v_cores: Optional[int] = None,
point_in_time_utc: Optional[str] = None,
postgresql_version: Optional[str] = None,
preferred_primary_zone: Optional[str] = None,
citus_version: Optional[str] = None,
source_location: Optional[str] = None,
source_resource_id: Optional[str] = None,
node_count: Optional[int] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: azure-native:dbforpostgresql:Cluster
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 ClusterArgs
- 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 ClusterArgs
- 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 ClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterArgs
- 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 exampleclusterResourceResourceFromDbforpostgresql = new AzureNative.DBforPostgreSQL.Cluster("exampleclusterResourceResourceFromDbforpostgresql", new()
{
ResourceGroupName = "string",
MaintenanceWindow = new AzureNative.DBforPostgreSQL.Inputs.MaintenanceWindowArgs
{
CustomWindow = "string",
DayOfWeek = 0,
StartHour = 0,
StartMinute = 0,
},
CoordinatorEnablePublicIpAccess = false,
NodeEnablePublicIpAccess = false,
CoordinatorServerEdition = "string",
CoordinatorStorageQuotaInMb = 0,
CoordinatorVCores = 0,
EnableHa = false,
EnableShardsOnCoordinator = false,
NodeServerEdition = "string",
AdministratorLoginPassword = "string",
Tags =
{
{ "string", "string" },
},
ClusterName = "string",
Location = "string",
NodeStorageQuotaInMb = 0,
NodeVCores = 0,
PointInTimeUTC = "string",
PostgresqlVersion = "string",
PreferredPrimaryZone = "string",
CitusVersion = "string",
SourceLocation = "string",
SourceResourceId = "string",
NodeCount = 0,
});
example, err := dbforpostgresql.NewCluster(ctx, "exampleclusterResourceResourceFromDbforpostgresql", &dbforpostgresql.ClusterArgs{
ResourceGroupName: pulumi.String("string"),
MaintenanceWindow: &dbforpostgresql.MaintenanceWindowArgs{
CustomWindow: pulumi.String("string"),
DayOfWeek: pulumi.Int(0),
StartHour: pulumi.Int(0),
StartMinute: pulumi.Int(0),
},
CoordinatorEnablePublicIpAccess: pulumi.Bool(false),
NodeEnablePublicIpAccess: pulumi.Bool(false),
CoordinatorServerEdition: pulumi.String("string"),
CoordinatorStorageQuotaInMb: pulumi.Int(0),
CoordinatorVCores: pulumi.Int(0),
EnableHa: pulumi.Bool(false),
EnableShardsOnCoordinator: pulumi.Bool(false),
NodeServerEdition: pulumi.String("string"),
AdministratorLoginPassword: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ClusterName: pulumi.String("string"),
Location: pulumi.String("string"),
NodeStorageQuotaInMb: pulumi.Int(0),
NodeVCores: pulumi.Int(0),
PointInTimeUTC: pulumi.String("string"),
PostgresqlVersion: pulumi.String("string"),
PreferredPrimaryZone: pulumi.String("string"),
CitusVersion: pulumi.String("string"),
SourceLocation: pulumi.String("string"),
SourceResourceId: pulumi.String("string"),
NodeCount: pulumi.Int(0),
})
var exampleclusterResourceResourceFromDbforpostgresql = new Cluster("exampleclusterResourceResourceFromDbforpostgresql", ClusterArgs.builder()
.resourceGroupName("string")
.maintenanceWindow(MaintenanceWindowArgs.builder()
.customWindow("string")
.dayOfWeek(0)
.startHour(0)
.startMinute(0)
.build())
.coordinatorEnablePublicIpAccess(false)
.nodeEnablePublicIpAccess(false)
.coordinatorServerEdition("string")
.coordinatorStorageQuotaInMb(0)
.coordinatorVCores(0)
.enableHa(false)
.enableShardsOnCoordinator(false)
.nodeServerEdition("string")
.administratorLoginPassword("string")
.tags(Map.of("string", "string"))
.clusterName("string")
.location("string")
.nodeStorageQuotaInMb(0)
.nodeVCores(0)
.pointInTimeUTC("string")
.postgresqlVersion("string")
.preferredPrimaryZone("string")
.citusVersion("string")
.sourceLocation("string")
.sourceResourceId("string")
.nodeCount(0)
.build());
examplecluster_resource_resource_from_dbforpostgresql = azure_native.dbforpostgresql.Cluster("exampleclusterResourceResourceFromDbforpostgresql",
resource_group_name="string",
maintenance_window={
"customWindow": "string",
"dayOfWeek": 0,
"startHour": 0,
"startMinute": 0,
},
coordinator_enable_public_ip_access=False,
node_enable_public_ip_access=False,
coordinator_server_edition="string",
coordinator_storage_quota_in_mb=0,
coordinator_v_cores=0,
enable_ha=False,
enable_shards_on_coordinator=False,
node_server_edition="string",
administrator_login_password="string",
tags={
"string": "string",
},
cluster_name="string",
location="string",
node_storage_quota_in_mb=0,
node_v_cores=0,
point_in_time_utc="string",
postgresql_version="string",
preferred_primary_zone="string",
citus_version="string",
source_location="string",
source_resource_id="string",
node_count=0)
const exampleclusterResourceResourceFromDbforpostgresql = new azure_native.dbforpostgresql.Cluster("exampleclusterResourceResourceFromDbforpostgresql", {
resourceGroupName: "string",
maintenanceWindow: {
customWindow: "string",
dayOfWeek: 0,
startHour: 0,
startMinute: 0,
},
coordinatorEnablePublicIpAccess: false,
nodeEnablePublicIpAccess: false,
coordinatorServerEdition: "string",
coordinatorStorageQuotaInMb: 0,
coordinatorVCores: 0,
enableHa: false,
enableShardsOnCoordinator: false,
nodeServerEdition: "string",
administratorLoginPassword: "string",
tags: {
string: "string",
},
clusterName: "string",
location: "string",
nodeStorageQuotaInMb: 0,
nodeVCores: 0,
pointInTimeUTC: "string",
postgresqlVersion: "string",
preferredPrimaryZone: "string",
citusVersion: "string",
sourceLocation: "string",
sourceResourceId: "string",
nodeCount: 0,
});
type: azure-native:dbforpostgresql:Cluster
properties:
administratorLoginPassword: string
citusVersion: string
clusterName: string
coordinatorEnablePublicIpAccess: false
coordinatorServerEdition: string
coordinatorStorageQuotaInMb: 0
coordinatorVCores: 0
enableHa: false
enableShardsOnCoordinator: false
location: string
maintenanceWindow:
customWindow: string
dayOfWeek: 0
startHour: 0
startMinute: 0
nodeCount: 0
nodeEnablePublicIpAccess: false
nodeServerEdition: string
nodeStorageQuotaInMb: 0
nodeVCores: 0
pointInTimeUTC: string
postgresqlVersion: string
preferredPrimaryZone: string
resourceGroupName: string
sourceLocation: string
sourceResourceId: string
tags:
string: string
Cluster 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 Cluster resource accepts the following input properties:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Administrator
Login stringPassword - The password of the administrator login. Required for creation.
- Citus
Version string - The Citus extension version on all cluster servers.
- Cluster
Name string - The name of the cluster.
- Coordinator
Enable boolPublic Ip Access - If public access is enabled on coordinator.
- Coordinator
Server stringEdition - The edition of a coordinator server (default: GeneralPurpose). Required for creation.
- Coordinator
Storage intQuota In Mb - The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- Coordinator
VCores int - The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- Enable
Ha bool - If high availability (HA) is enabled or not for the cluster.
- Enable
Shards boolOn Coordinator - If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
- Location string
- The geo-location where the resource lives
- Maintenance
Window Pulumi.Azure Native. DBfor Postgre SQL. Inputs. Maintenance Window - Maintenance window of a cluster.
- Node
Count int - Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
- Node
Enable boolPublic Ip Access - If public access is enabled on worker nodes.
- Node
Server stringEdition - The edition of a node server (default: MemoryOptimized).
- Node
Storage intQuota In Mb - The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- Node
VCores int - The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- Point
In stringTime UTC - Date and time in UTC (ISO8601 format) for cluster restore.
- Postgresql
Version string - The major PostgreSQL version on all cluster servers.
- Preferred
Primary stringZone - Preferred primary availability zone (AZ) for all cluster servers.
- Source
Location string - The Azure region of source cluster for read replica clusters.
- Source
Resource stringId - The resource id of source cluster for read replica clusters.
- Dictionary<string, string>
- Resource tags.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Administrator
Login stringPassword - The password of the administrator login. Required for creation.
- Citus
Version string - The Citus extension version on all cluster servers.
- Cluster
Name string - The name of the cluster.
- Coordinator
Enable boolPublic Ip Access - If public access is enabled on coordinator.
- Coordinator
Server stringEdition - The edition of a coordinator server (default: GeneralPurpose). Required for creation.
- Coordinator
Storage intQuota In Mb - The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- Coordinator
VCores int - The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- Enable
Ha bool - If high availability (HA) is enabled or not for the cluster.
- Enable
Shards boolOn Coordinator - If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
- Location string
- The geo-location where the resource lives
- Maintenance
Window MaintenanceWindow Args - Maintenance window of a cluster.
- Node
Count int - Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
- Node
Enable boolPublic Ip Access - If public access is enabled on worker nodes.
- Node
Server stringEdition - The edition of a node server (default: MemoryOptimized).
- Node
Storage intQuota In Mb - The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- Node
VCores int - The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- Point
In stringTime UTC - Date and time in UTC (ISO8601 format) for cluster restore.
- Postgresql
Version string - The major PostgreSQL version on all cluster servers.
- Preferred
Primary stringZone - Preferred primary availability zone (AZ) for all cluster servers.
- Source
Location string - The Azure region of source cluster for read replica clusters.
- Source
Resource stringId - The resource id of source cluster for read replica clusters.
- map[string]string
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- administrator
Login StringPassword - The password of the administrator login. Required for creation.
- citus
Version String - The Citus extension version on all cluster servers.
- cluster
Name String - The name of the cluster.
- coordinator
Enable BooleanPublic Ip Access - If public access is enabled on coordinator.
- coordinator
Server StringEdition - The edition of a coordinator server (default: GeneralPurpose). Required for creation.
- coordinator
Storage IntegerQuota In Mb - The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- coordinator
VCores Integer - The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- enable
Ha Boolean - If high availability (HA) is enabled or not for the cluster.
- enable
Shards BooleanOn Coordinator - If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
- location String
- The geo-location where the resource lives
- maintenance
Window MaintenanceWindow - Maintenance window of a cluster.
- node
Count Integer - Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
- node
Enable BooleanPublic Ip Access - If public access is enabled on worker nodes.
- node
Server StringEdition - The edition of a node server (default: MemoryOptimized).
- node
Storage IntegerQuota In Mb - The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- node
VCores Integer - The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- point
In StringTime UTC - Date and time in UTC (ISO8601 format) for cluster restore.
- postgresql
Version String - The major PostgreSQL version on all cluster servers.
- preferred
Primary StringZone - Preferred primary availability zone (AZ) for all cluster servers.
- source
Location String - The Azure region of source cluster for read replica clusters.
- source
Resource StringId - The resource id of source cluster for read replica clusters.
- Map<String,String>
- Resource tags.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- administrator
Login stringPassword - The password of the administrator login. Required for creation.
- citus
Version string - The Citus extension version on all cluster servers.
- cluster
Name string - The name of the cluster.
- coordinator
Enable booleanPublic Ip Access - If public access is enabled on coordinator.
- coordinator
Server stringEdition - The edition of a coordinator server (default: GeneralPurpose). Required for creation.
- coordinator
Storage numberQuota In Mb - The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- coordinator
VCores number - The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- enable
Ha boolean - If high availability (HA) is enabled or not for the cluster.
- enable
Shards booleanOn Coordinator - If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
- location string
- The geo-location where the resource lives
- maintenance
Window MaintenanceWindow - Maintenance window of a cluster.
- node
Count number - Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
- node
Enable booleanPublic Ip Access - If public access is enabled on worker nodes.
- node
Server stringEdition - The edition of a node server (default: MemoryOptimized).
- node
Storage numberQuota In Mb - The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- node
VCores number - The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- point
In stringTime UTC - Date and time in UTC (ISO8601 format) for cluster restore.
- postgresql
Version string - The major PostgreSQL version on all cluster servers.
- preferred
Primary stringZone - Preferred primary availability zone (AZ) for all cluster servers.
- source
Location string - The Azure region of source cluster for read replica clusters.
- source
Resource stringId - The resource id of source cluster for read replica clusters.
- {[key: string]: string}
- Resource tags.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- administrator_
login_ strpassword - The password of the administrator login. Required for creation.
- citus_
version str - The Citus extension version on all cluster servers.
- cluster_
name str - The name of the cluster.
- coordinator_
enable_ boolpublic_ ip_ access - If public access is enabled on coordinator.
- coordinator_
server_ stredition - The edition of a coordinator server (default: GeneralPurpose). Required for creation.
- coordinator_
storage_ intquota_ in_ mb - The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- coordinator_
v_ intcores - The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- enable_
ha bool - If high availability (HA) is enabled or not for the cluster.
- enable_
shards_ boolon_ coordinator - If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
- location str
- The geo-location where the resource lives
- maintenance_
window MaintenanceWindow Args - Maintenance window of a cluster.
- node_
count int - Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
- node_
enable_ boolpublic_ ip_ access - If public access is enabled on worker nodes.
- node_
server_ stredition - The edition of a node server (default: MemoryOptimized).
- node_
storage_ intquota_ in_ mb - The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- node_
v_ intcores - The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- point_
in_ strtime_ utc - Date and time in UTC (ISO8601 format) for cluster restore.
- postgresql_
version str - The major PostgreSQL version on all cluster servers.
- preferred_
primary_ strzone - Preferred primary availability zone (AZ) for all cluster servers.
- source_
location str - The Azure region of source cluster for read replica clusters.
- source_
resource_ strid - The resource id of source cluster for read replica clusters.
- Mapping[str, str]
- Resource tags.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- administrator
Login StringPassword - The password of the administrator login. Required for creation.
- citus
Version String - The Citus extension version on all cluster servers.
- cluster
Name String - The name of the cluster.
- coordinator
Enable BooleanPublic Ip Access - If public access is enabled on coordinator.
- coordinator
Server StringEdition - The edition of a coordinator server (default: GeneralPurpose). Required for creation.
- coordinator
Storage NumberQuota In Mb - The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- coordinator
VCores Number - The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- enable
Ha Boolean - If high availability (HA) is enabled or not for the cluster.
- enable
Shards BooleanOn Coordinator - If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
- location String
- The geo-location where the resource lives
- maintenance
Window Property Map - Maintenance window of a cluster.
- node
Count Number - Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
- node
Enable BooleanPublic Ip Access - If public access is enabled on worker nodes.
- node
Server StringEdition - The edition of a node server (default: MemoryOptimized).
- node
Storage NumberQuota In Mb - The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- node
VCores Number - The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- point
In StringTime UTC - Date and time in UTC (ISO8601 format) for cluster restore.
- postgresql
Version String - The major PostgreSQL version on all cluster servers.
- preferred
Primary StringZone - Preferred primary availability zone (AZ) for all cluster servers.
- source
Location String - The Azure region of source cluster for read replica clusters.
- source
Resource StringId - The resource id of source cluster for read replica clusters.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:
- Administrator
Login string - The administrator's login name of the servers in the cluster.
- Earliest
Restore stringTime - The earliest restore point time (ISO8601 format) for the cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Private
Endpoint List<Pulumi.Connections Azure Native. DBfor Postgre SQL. Outputs. Simple Private Endpoint Connection Response> - The private endpoint connections for a cluster.
- Provisioning
State string - Provisioning state of the cluster
- Read
Replicas List<string> - The array of read replica clusters.
- Server
Names List<Pulumi.Azure Native. DBfor Postgre SQL. Outputs. Server Name Item Response> - The list of server names in the cluster
- State string
- A state of a cluster/server that is visible to user.
- System
Data Pulumi.Azure Native. DBfor Postgre SQL. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Administrator
Login string - The administrator's login name of the servers in the cluster.
- Earliest
Restore stringTime - The earliest restore point time (ISO8601 format) for the cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Private
Endpoint []SimpleConnections Private Endpoint Connection Response - The private endpoint connections for a cluster.
- Provisioning
State string - Provisioning state of the cluster
- Read
Replicas []string - The array of read replica clusters.
- Server
Names []ServerName Item Response - The list of server names in the cluster
- State string
- A state of a cluster/server that is visible to user.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- administrator
Login String - The administrator's login name of the servers in the cluster.
- earliest
Restore StringTime - The earliest restore point time (ISO8601 format) for the cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- private
Endpoint List<SimpleConnections Private Endpoint Connection Response> - The private endpoint connections for a cluster.
- provisioning
State String - Provisioning state of the cluster
- read
Replicas List<String> - The array of read replica clusters.
- server
Names List<ServerName Item Response> - The list of server names in the cluster
- state String
- A state of a cluster/server that is visible to user.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- administrator
Login string - The administrator's login name of the servers in the cluster.
- earliest
Restore stringTime - The earliest restore point time (ISO8601 format) for the cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- private
Endpoint SimpleConnections Private Endpoint Connection Response[] - The private endpoint connections for a cluster.
- provisioning
State string - Provisioning state of the cluster
- read
Replicas string[] - The array of read replica clusters.
- server
Names ServerName Item Response[] - The list of server names in the cluster
- state string
- A state of a cluster/server that is visible to user.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- administrator_
login str - The administrator's login name of the servers in the cluster.
- earliest_
restore_ strtime - The earliest restore point time (ISO8601 format) for the cluster.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- private_
endpoint_ Sequence[Simpleconnections Private Endpoint Connection Response] - The private endpoint connections for a cluster.
- provisioning_
state str - Provisioning state of the cluster
- read_
replicas Sequence[str] - The array of read replica clusters.
- server_
names Sequence[ServerName Item Response] - The list of server names in the cluster
- state str
- A state of a cluster/server that is visible to user.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- administrator
Login String - The administrator's login name of the servers in the cluster.
- earliest
Restore StringTime - The earliest restore point time (ISO8601 format) for the cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- private
Endpoint List<Property Map>Connections - The private endpoint connections for a cluster.
- provisioning
State String - Provisioning state of the cluster
- read
Replicas List<String> - The array of read replica clusters.
- server
Names List<Property Map> - The list of server names in the cluster
- state String
- A state of a cluster/server that is visible to user.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
MaintenanceWindow, MaintenanceWindowArgs
- Custom
Window string - indicates whether custom window is enabled or disabled
- Day
Of intWeek - day of week for maintenance window
- Start
Hour int - start hour for maintenance window
- Start
Minute int - start minute for maintenance window
- Custom
Window string - indicates whether custom window is enabled or disabled
- Day
Of intWeek - day of week for maintenance window
- Start
Hour int - start hour for maintenance window
- Start
Minute int - start minute for maintenance window
- custom
Window String - indicates whether custom window is enabled or disabled
- day
Of IntegerWeek - day of week for maintenance window
- start
Hour Integer - start hour for maintenance window
- start
Minute Integer - start minute for maintenance window
- custom
Window string - indicates whether custom window is enabled or disabled
- day
Of numberWeek - day of week for maintenance window
- start
Hour number - start hour for maintenance window
- start
Minute number - start minute for maintenance window
- custom_
window str - indicates whether custom window is enabled or disabled
- day_
of_ intweek - day of week for maintenance window
- start_
hour int - start hour for maintenance window
- start_
minute int - start minute for maintenance window
- custom
Window String - indicates whether custom window is enabled or disabled
- day
Of NumberWeek - day of week for maintenance window
- start
Hour Number - start hour for maintenance window
- start
Minute Number - start minute for maintenance window
MaintenanceWindowResponse, MaintenanceWindowResponseArgs
- Custom
Window string - indicates whether custom window is enabled or disabled
- Day
Of intWeek - day of week for maintenance window
- Start
Hour int - start hour for maintenance window
- Start
Minute int - start minute for maintenance window
- Custom
Window string - indicates whether custom window is enabled or disabled
- Day
Of intWeek - day of week for maintenance window
- Start
Hour int - start hour for maintenance window
- Start
Minute int - start minute for maintenance window
- custom
Window String - indicates whether custom window is enabled or disabled
- day
Of IntegerWeek - day of week for maintenance window
- start
Hour Integer - start hour for maintenance window
- start
Minute Integer - start minute for maintenance window
- custom
Window string - indicates whether custom window is enabled or disabled
- day
Of numberWeek - day of week for maintenance window
- start
Hour number - start hour for maintenance window
- start
Minute number - start minute for maintenance window
- custom_
window str - indicates whether custom window is enabled or disabled
- day_
of_ intweek - day of week for maintenance window
- start_
hour int - start hour for maintenance window
- start_
minute int - start minute for maintenance window
- custom
Window String - indicates whether custom window is enabled or disabled
- day
Of NumberWeek - day of week for maintenance window
- start
Hour Number - start hour for maintenance window
- start
Minute Number - start minute for maintenance window
PrivateEndpointPropertyResponse, PrivateEndpointPropertyResponseArgs
- Id string
- Resource id of the private endpoint.
- Id string
- Resource id of the private endpoint.
- id String
- Resource id of the private endpoint.
- id string
- Resource id of the private endpoint.
- id str
- Resource id of the private endpoint.
- id String
- Resource id of the private endpoint.
PrivateLinkServiceConnectionStateResponse, PrivateLinkServiceConnectionStateResponseArgs
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- Actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- Description string
- The reason for approval/rejection of the connection.
- Status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required string - A message indicating if changes on the service provider require any updates on the consumer.
- description string
- The reason for approval/rejection of the connection.
- status string
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions_
required str - A message indicating if changes on the service provider require any updates on the consumer.
- description str
- The reason for approval/rejection of the connection.
- status str
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
- actions
Required String - A message indicating if changes on the service provider require any updates on the consumer.
- description String
- The reason for approval/rejection of the connection.
- status String
- Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
ServerNameItemResponse, ServerNameItemResponseArgs
- Fully
Qualified stringDomain Name - The fully qualified domain name of a server.
- Name string
- The name of a server.
- Fully
Qualified stringDomain Name - The fully qualified domain name of a server.
- Name string
- The name of a server.
- fully
Qualified StringDomain Name - The fully qualified domain name of a server.
- name String
- The name of a server.
- fully
Qualified stringDomain Name - The fully qualified domain name of a server.
- name string
- The name of a server.
- fully_
qualified_ strdomain_ name - The fully qualified domain name of a server.
- name str
- The name of a server.
- fully
Qualified StringDomain Name - The fully qualified domain name of a server.
- name String
- The name of a server.
SimplePrivateEndpointConnectionResponse, SimplePrivateEndpointConnectionResponseArgs
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. DBfor Postgre SQL. Inputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Group
Ids List<string> - Group ids of the private endpoint connection.
- Private
Endpoint Pulumi.Azure Native. DBfor Postgre SQL. Inputs. Private Endpoint Property Response - Private endpoint which the connection belongs to.
- Private
Link Pulumi.Service Connection State Azure Native. DBfor Postgre SQL. Inputs. Private Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Name string
- The name of the resource
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Group
Ids []string - Group ids of the private endpoint connection.
- Private
Endpoint PrivateEndpoint Property Response - Private endpoint which the connection belongs to.
- Private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- group
Ids List<String> - Group ids of the private endpoint connection.
- private
Endpoint PrivateEndpoint Property Response - Private endpoint which the connection belongs to.
- private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name string
- The name of the resource
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- group
Ids string[] - Group ids of the private endpoint connection.
- private
Endpoint PrivateEndpoint Property Response - Private endpoint which the connection belongs to.
- private
Link PrivateService Connection State Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name str
- The name of the resource
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- group_
ids Sequence[str] - Group ids of the private endpoint connection.
- private_
endpoint PrivateEndpoint Property Response - Private endpoint which the connection belongs to.
- private_
link_ Privateservice_ connection_ state Link Service Connection State Response - A collection of information about the state of the connection between service consumer and provider.
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- name String
- The name of the resource
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- group
Ids List<String> - Group ids of the private endpoint connection.
- private
Endpoint Property Map - Private endpoint which the connection belongs to.
- private
Link Property MapService Connection State - A collection of information about the state of the connection between service consumer and provider.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:dbforpostgresql:Cluster testcluster-singlenode /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0