ionoscloud 6.7.6, Apr 14 25

ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

ionos-cloud/terraform-provider-ionoscloud

ionoscloud.PgCluster

Explore with Pulumi AI

ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

ionos-cloud/terraform-provider-ionoscloud

Create PgCluster Resource

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

new PgCluster(name: string, args: PgClusterArgs, opts?: CustomResourceOptions);

@overload
def PgCluster(resource_name: str,
              args: PgClusterArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def PgCluster(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              instances: Optional[float] = None,
              ram: Optional[float] = None,
              synchronization_mode: Optional[str] = None,
              storage_type: Optional[str] = None,
              cores: Optional[float] = None,
              credentials: Optional[PgClusterCredentialsArgs] = None,
              display_name: Optional[str] = None,
              storage_size: Optional[float] = None,
              postgres_version: Optional[str] = None,
              location: Optional[str] = None,
              maintenance_window: Optional[PgClusterMaintenanceWindowArgs] = None,
              pg_cluster_id: Optional[str] = None,
              backup_location: Optional[str] = None,
              allow_replace: Optional[bool] = None,
              from_backup: Optional[PgClusterFromBackupArgs] = None,
              connections: Optional[PgClusterConnectionsArgs] = None,
              connection_pooler: Optional[PgClusterConnectionPoolerArgs] = None,
              timeouts: Optional[PgClusterTimeoutsArgs] = None)

func NewPgCluster(ctx *Context, name string, args PgClusterArgs, opts ...ResourceOption) (*PgCluster, error)

public PgCluster(string name, PgClusterArgs args, CustomResourceOptions? opts = null)

public PgCluster(String name, PgClusterArgs args)
public PgCluster(String name, PgClusterArgs args, CustomResourceOptions options)

type: ionoscloud:PgCluster
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 PgClusterArgs: 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 PgClusterArgs: 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 PgClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PgClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PgClusterArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var pgClusterResource = new Ionoscloud.PgCluster("pgClusterResource", new()
{
    Instances = 0,
    Ram = 0,
    SynchronizationMode = "string",
    StorageType = "string",
    Cores = 0,
    Credentials = new Ionoscloud.Inputs.PgClusterCredentialsArgs
    {
        Password = "string",
        Username = "string",
    },
    DisplayName = "string",
    StorageSize = 0,
    PostgresVersion = "string",
    Location = "string",
    MaintenanceWindow = new Ionoscloud.Inputs.PgClusterMaintenanceWindowArgs
    {
        DayOfTheWeek = "string",
        Time = "string",
    },
    PgClusterId = "string",
    BackupLocation = "string",
    AllowReplace = false,
    FromBackup = new Ionoscloud.Inputs.PgClusterFromBackupArgs
    {
        BackupId = "string",
        RecoveryTargetTime = "string",
    },
    Connections = new Ionoscloud.Inputs.PgClusterConnectionsArgs
    {
        Cidr = "string",
        DatacenterId = "string",
        LanId = "string",
    },
    ConnectionPooler = new Ionoscloud.Inputs.PgClusterConnectionPoolerArgs
    {
        Enabled = false,
        PoolMode = "string",
    },
    Timeouts = new Ionoscloud.Inputs.PgClusterTimeoutsArgs
    {
        Create = "string",
        Default = "string",
        Delete = "string",
        Update = "string",
    },
});

example, err := ionoscloud.NewPgCluster(ctx, "pgClusterResource", &ionoscloud.PgClusterArgs{
Instances: pulumi.Float64(0),
Ram: pulumi.Float64(0),
SynchronizationMode: pulumi.String("string"),
StorageType: pulumi.String("string"),
Cores: pulumi.Float64(0),
Credentials: &.PgClusterCredentialsArgs{
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
StorageSize: pulumi.Float64(0),
PostgresVersion: pulumi.String("string"),
Location: pulumi.String("string"),
MaintenanceWindow: &.PgClusterMaintenanceWindowArgs{
DayOfTheWeek: pulumi.String("string"),
Time: pulumi.String("string"),
},
PgClusterId: pulumi.String("string"),
BackupLocation: pulumi.String("string"),
AllowReplace: pulumi.Bool(false),
FromBackup: &.PgClusterFromBackupArgs{
BackupId: pulumi.String("string"),
RecoveryTargetTime: pulumi.String("string"),
},
Connections: &.PgClusterConnectionsArgs{
Cidr: pulumi.String("string"),
DatacenterId: pulumi.String("string"),
LanId: pulumi.String("string"),
},
ConnectionPooler: &.PgClusterConnectionPoolerArgs{
Enabled: pulumi.Bool(false),
PoolMode: pulumi.String("string"),
},
Timeouts: &.PgClusterTimeoutsArgs{
Create: pulumi.String("string"),
Default: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})

var pgClusterResource = new PgCluster("pgClusterResource", PgClusterArgs.builder()
    .instances(0)
    .ram(0)
    .synchronizationMode("string")
    .storageType("string")
    .cores(0)
    .credentials(PgClusterCredentialsArgs.builder()
        .password("string")
        .username("string")
        .build())
    .displayName("string")
    .storageSize(0)
    .postgresVersion("string")
    .location("string")
    .maintenanceWindow(PgClusterMaintenanceWindowArgs.builder()
        .dayOfTheWeek("string")
        .time("string")
        .build())
    .pgClusterId("string")
    .backupLocation("string")
    .allowReplace(false)
    .fromBackup(PgClusterFromBackupArgs.builder()
        .backupId("string")
        .recoveryTargetTime("string")
        .build())
    .connections(PgClusterConnectionsArgs.builder()
        .cidr("string")
        .datacenterId("string")
        .lanId("string")
        .build())
    .connectionPooler(PgClusterConnectionPoolerArgs.builder()
        .enabled(false)
        .poolMode("string")
        .build())
    .timeouts(PgClusterTimeoutsArgs.builder()
        .create("string")
        .default_("string")
        .delete("string")
        .update("string")
        .build())
    .build());

pg_cluster_resource = ionoscloud.PgCluster("pgClusterResource",
    instances=0,
    ram=0,
    synchronization_mode="string",
    storage_type="string",
    cores=0,
    credentials={
        "password": "string",
        "username": "string",
    },
    display_name="string",
    storage_size=0,
    postgres_version="string",
    location="string",
    maintenance_window={
        "day_of_the_week": "string",
        "time": "string",
    },
    pg_cluster_id="string",
    backup_location="string",
    allow_replace=False,
    from_backup={
        "backup_id": "string",
        "recovery_target_time": "string",
    },
    connections={
        "cidr": "string",
        "datacenter_id": "string",
        "lan_id": "string",
    },
    connection_pooler={
        "enabled": False,
        "pool_mode": "string",
    },
    timeouts={
        "create": "string",
        "default": "string",
        "delete": "string",
        "update": "string",
    })

const pgClusterResource = new ionoscloud.PgCluster("pgClusterResource", {
    instances: 0,
    ram: 0,
    synchronizationMode: "string",
    storageType: "string",
    cores: 0,
    credentials: {
        password: "string",
        username: "string",
    },
    displayName: "string",
    storageSize: 0,
    postgresVersion: "string",
    location: "string",
    maintenanceWindow: {
        dayOfTheWeek: "string",
        time: "string",
    },
    pgClusterId: "string",
    backupLocation: "string",
    allowReplace: false,
    fromBackup: {
        backupId: "string",
        recoveryTargetTime: "string",
    },
    connections: {
        cidr: "string",
        datacenterId: "string",
        lanId: "string",
    },
    connectionPooler: {
        enabled: false,
        poolMode: "string",
    },
    timeouts: {
        create: "string",
        "default": "string",
        "delete": "string",
        update: "string",
    },
});

type: ionoscloud:PgCluster
properties:
    allowReplace: false
    backupLocation: string
    connectionPooler:
        enabled: false
        poolMode: string
    connections:
        cidr: string
        datacenterId: string
        lanId: string
    cores: 0
    credentials:
        password: string
        username: string
    displayName: string
    fromBackup:
        backupId: string
        recoveryTargetTime: string
    instances: 0
    location: string
    maintenanceWindow:
        dayOfTheWeek: string
        time: string
    pgClusterId: string
    postgresVersion: string
    ram: 0
    storageSize: 0
    storageType: string
    synchronizationMode: string
    timeouts:
        create: string
        default: string
        delete: string
        update: string

PgCluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PgCluster resource accepts the following input properties:

Cores double: The number of CPU cores per replica.
Credentials PgClusterCredentials: Credentials for the database user to be created.
DisplayName string: The friendly name of your cluster.
Instances double: The total number of instances in the cluster (one master and n-1 standbys)
Location string: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
PostgresVersion string: The PostgreSQL version of your cluster.
Ram double: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
StorageSize double: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
StorageType string: The storage type used in your cluster.
SynchronizationMode string: Represents different modes of replication.
AllowReplace bool: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
BackupLocation string: The Object Storage location where the backups will be stored.
ConnectionPooler PgClusterConnectionPooler: Configuration options for the connection pooler
Connections PgClusterConnections: Details about the network connection for your cluster.
FromBackup PgClusterFromBackup: Creates the cluster based on the existing backup.
MaintenanceWindow PgClusterMaintenanceWindow: a weekly 4 hour-long window, during which maintenance might occur
PgClusterId string
Timeouts PgClusterTimeouts

Cores float64: The number of CPU cores per replica.
Credentials PgClusterCredentialsArgs: Credentials for the database user to be created.
DisplayName string: The friendly name of your cluster.
Instances float64: The total number of instances in the cluster (one master and n-1 standbys)
Location string: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
PostgresVersion string: The PostgreSQL version of your cluster.
Ram float64: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
StorageSize float64: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
StorageType string: The storage type used in your cluster.
SynchronizationMode string: Represents different modes of replication.
AllowReplace bool: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
BackupLocation string: The Object Storage location where the backups will be stored.
ConnectionPooler PgClusterConnectionPoolerArgs: Configuration options for the connection pooler
Connections PgClusterConnectionsArgs: Details about the network connection for your cluster.
FromBackup PgClusterFromBackupArgs: Creates the cluster based on the existing backup.
MaintenanceWindow PgClusterMaintenanceWindowArgs: a weekly 4 hour-long window, during which maintenance might occur
PgClusterId string
Timeouts PgClusterTimeoutsArgs

cores Double: The number of CPU cores per replica.
credentials PgClusterCredentials: Credentials for the database user to be created.
displayName String: The friendly name of your cluster.
instances Double: The total number of instances in the cluster (one master and n-1 standbys)
location String: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
postgresVersion String: The PostgreSQL version of your cluster.
ram Double: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
storageSize Double: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
storageType String: The storage type used in your cluster.
synchronizationMode String: Represents different modes of replication.
allowReplace Boolean: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
backupLocation String: The Object Storage location where the backups will be stored.
connectionPooler PgClusterConnectionPooler: Configuration options for the connection pooler
connections PgClusterConnections: Details about the network connection for your cluster.
fromBackup PgClusterFromBackup: Creates the cluster based on the existing backup.
maintenanceWindow PgClusterMaintenanceWindow: a weekly 4 hour-long window, during which maintenance might occur
pgClusterId String
timeouts PgClusterTimeouts

cores number: The number of CPU cores per replica.
credentials PgClusterCredentials: Credentials for the database user to be created.
displayName string: The friendly name of your cluster.
instances number: The total number of instances in the cluster (one master and n-1 standbys)
location string: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
postgresVersion string: The PostgreSQL version of your cluster.
ram number: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
storageSize number: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
storageType string: The storage type used in your cluster.
synchronizationMode string: Represents different modes of replication.
allowReplace boolean: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
backupLocation string: The Object Storage location where the backups will be stored.
connectionPooler PgClusterConnectionPooler: Configuration options for the connection pooler
connections PgClusterConnections: Details about the network connection for your cluster.
fromBackup PgClusterFromBackup: Creates the cluster based on the existing backup.
maintenanceWindow PgClusterMaintenanceWindow: a weekly 4 hour-long window, during which maintenance might occur
pgClusterId string
timeouts PgClusterTimeouts

cores float: The number of CPU cores per replica.
credentials PgClusterCredentialsArgs: Credentials for the database user to be created.
display_name str: The friendly name of your cluster.
instances float: The total number of instances in the cluster (one master and n-1 standbys)
location str: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
postgres_version str: The PostgreSQL version of your cluster.
ram float: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
storage_size float: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
storage_type str: The storage type used in your cluster.
synchronization_mode str: Represents different modes of replication.
allow_replace bool: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
backup_location str: The Object Storage location where the backups will be stored.
connection_pooler PgClusterConnectionPoolerArgs: Configuration options for the connection pooler
connections PgClusterConnectionsArgs: Details about the network connection for your cluster.
from_backup PgClusterFromBackupArgs: Creates the cluster based on the existing backup.
maintenance_window PgClusterMaintenanceWindowArgs: a weekly 4 hour-long window, during which maintenance might occur
pg_cluster_id str
timeouts PgClusterTimeoutsArgs

cores Number: The number of CPU cores per replica.
credentials Property Map: Credentials for the database user to be created.
displayName String: The friendly name of your cluster.
instances Number: The total number of instances in the cluster (one master and n-1 standbys)
location String: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
postgresVersion String: The PostgreSQL version of your cluster.
ram Number: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
storageSize Number: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
storageType String: The storage type used in your cluster.
synchronizationMode String: Represents different modes of replication.
allowReplace Boolean: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
backupLocation String: The Object Storage location where the backups will be stored.
connectionPooler Property Map: Configuration options for the connection pooler
connections Property Map: Details about the network connection for your cluster.
fromBackup Property Map: Creates the cluster based on the existing backup.
maintenanceWindow Property Map: a weekly 4 hour-long window, during which maintenance might occur
pgClusterId String
timeouts Property Map

Outputs

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

DnsName string: The DNS name pointing to your cluster
Id string: The provider-assigned unique ID for this managed resource.

DnsName string: The DNS name pointing to your cluster
Id string: The provider-assigned unique ID for this managed resource.

dnsName String: The DNS name pointing to your cluster
id String: The provider-assigned unique ID for this managed resource.

dnsName string: The DNS name pointing to your cluster
id string: The provider-assigned unique ID for this managed resource.

dns_name str: The DNS name pointing to your cluster
id str: The provider-assigned unique ID for this managed resource.

dnsName String: The DNS name pointing to your cluster
id String: The provider-assigned unique ID for this managed resource.

Look up Existing PgCluster Resource

Get an existing PgCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: PgClusterState, opts?: CustomResourceOptions): PgCluster

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_replace: Optional[bool] = None,
        backup_location: Optional[str] = None,
        connection_pooler: Optional[PgClusterConnectionPoolerArgs] = None,
        connections: Optional[PgClusterConnectionsArgs] = None,
        cores: Optional[float] = None,
        credentials: Optional[PgClusterCredentialsArgs] = None,
        display_name: Optional[str] = None,
        dns_name: Optional[str] = None,
        from_backup: Optional[PgClusterFromBackupArgs] = None,
        instances: Optional[float] = None,
        location: Optional[str] = None,
        maintenance_window: Optional[PgClusterMaintenanceWindowArgs] = None,
        pg_cluster_id: Optional[str] = None,
        postgres_version: Optional[str] = None,
        ram: Optional[float] = None,
        storage_size: Optional[float] = None,
        storage_type: Optional[str] = None,
        synchronization_mode: Optional[str] = None,
        timeouts: Optional[PgClusterTimeoutsArgs] = None) -> PgCluster

func GetPgCluster(ctx *Context, name string, id IDInput, state *PgClusterState, opts ...ResourceOption) (*PgCluster, error)

public static PgCluster Get(string name, Input<string> id, PgClusterState? state, CustomResourceOptions? opts = null)

public static PgCluster get(String name, Output<String> id, PgClusterState state, CustomResourceOptions options)

resources:  _:    type: ionoscloud:PgCluster    get:      id: ${id}

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:

AllowReplace bool: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
BackupLocation string: The Object Storage location where the backups will be stored.
ConnectionPooler PgClusterConnectionPooler: Configuration options for the connection pooler
Connections PgClusterConnections: Details about the network connection for your cluster.
Cores double: The number of CPU cores per replica.
Credentials PgClusterCredentials: Credentials for the database user to be created.
DisplayName string: The friendly name of your cluster.
DnsName string: The DNS name pointing to your cluster
FromBackup PgClusterFromBackup: Creates the cluster based on the existing backup.
Instances double: The total number of instances in the cluster (one master and n-1 standbys)
Location string: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
MaintenanceWindow PgClusterMaintenanceWindow: a weekly 4 hour-long window, during which maintenance might occur
PgClusterId string
PostgresVersion string: The PostgreSQL version of your cluster.
Ram double: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
StorageSize double: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
StorageType string: The storage type used in your cluster.
SynchronizationMode string: Represents different modes of replication.
Timeouts PgClusterTimeouts

AllowReplace bool: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
BackupLocation string: The Object Storage location where the backups will be stored.
ConnectionPooler PgClusterConnectionPoolerArgs: Configuration options for the connection pooler
Connections PgClusterConnectionsArgs: Details about the network connection for your cluster.
Cores float64: The number of CPU cores per replica.
Credentials PgClusterCredentialsArgs: Credentials for the database user to be created.
DisplayName string: The friendly name of your cluster.
DnsName string: The DNS name pointing to your cluster
FromBackup PgClusterFromBackupArgs: Creates the cluster based on the existing backup.
Instances float64: The total number of instances in the cluster (one master and n-1 standbys)
Location string: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
MaintenanceWindow PgClusterMaintenanceWindowArgs: a weekly 4 hour-long window, during which maintenance might occur
PgClusterId string
PostgresVersion string: The PostgreSQL version of your cluster.
Ram float64: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
StorageSize float64: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
StorageType string: The storage type used in your cluster.
SynchronizationMode string: Represents different modes of replication.
Timeouts PgClusterTimeoutsArgs

allowReplace Boolean: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
backupLocation String: The Object Storage location where the backups will be stored.
connectionPooler PgClusterConnectionPooler: Configuration options for the connection pooler
connections PgClusterConnections: Details about the network connection for your cluster.
cores Double: The number of CPU cores per replica.
credentials PgClusterCredentials: Credentials for the database user to be created.
displayName String: The friendly name of your cluster.
dnsName String: The DNS name pointing to your cluster
fromBackup PgClusterFromBackup: Creates the cluster based on the existing backup.
instances Double: The total number of instances in the cluster (one master and n-1 standbys)
location String: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
maintenanceWindow PgClusterMaintenanceWindow: a weekly 4 hour-long window, during which maintenance might occur
pgClusterId String
postgresVersion String: The PostgreSQL version of your cluster.
ram Double: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
storageSize Double: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
storageType String: The storage type used in your cluster.
synchronizationMode String: Represents different modes of replication.
timeouts PgClusterTimeouts

allowReplace boolean: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
backupLocation string: The Object Storage location where the backups will be stored.
connectionPooler PgClusterConnectionPooler: Configuration options for the connection pooler
connections PgClusterConnections: Details about the network connection for your cluster.
cores number: The number of CPU cores per replica.
credentials PgClusterCredentials: Credentials for the database user to be created.
displayName string: The friendly name of your cluster.
dnsName string: The DNS name pointing to your cluster
fromBackup PgClusterFromBackup: Creates the cluster based on the existing backup.
instances number: The total number of instances in the cluster (one master and n-1 standbys)
location string: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
maintenanceWindow PgClusterMaintenanceWindow: a weekly 4 hour-long window, during which maintenance might occur
pgClusterId string
postgresVersion string: The PostgreSQL version of your cluster.
ram number: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
storageSize number: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
storageType string: The storage type used in your cluster.
synchronizationMode string: Represents different modes of replication.
timeouts PgClusterTimeouts

allow_replace bool: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
backup_location str: The Object Storage location where the backups will be stored.
connection_pooler PgClusterConnectionPoolerArgs: Configuration options for the connection pooler
connections PgClusterConnectionsArgs: Details about the network connection for your cluster.
cores float: The number of CPU cores per replica.
credentials PgClusterCredentialsArgs: Credentials for the database user to be created.
display_name str: The friendly name of your cluster.
dns_name str: The DNS name pointing to your cluster
from_backup PgClusterFromBackupArgs: Creates the cluster based on the existing backup.
instances float: The total number of instances in the cluster (one master and n-1 standbys)
location str: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
maintenance_window PgClusterMaintenanceWindowArgs: a weekly 4 hour-long window, during which maintenance might occur
pg_cluster_id str
postgres_version str: The PostgreSQL version of your cluster.
ram float: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
storage_size float: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
storage_type str: The storage type used in your cluster.
synchronization_mode str: Represents different modes of replication.
timeouts PgClusterTimeoutsArgs

allowReplace Boolean: When set to true, allows the update of immutable fields by destroying and re-creating the cluster.
backupLocation String: The Object Storage location where the backups will be stored.
connectionPooler Property Map: Configuration options for the connection pooler
connections Property Map: Details about the network connection for your cluster.
cores Number: The number of CPU cores per replica.
credentials Property Map: Credentials for the database user to be created.
displayName String: The friendly name of your cluster.
dnsName String: The DNS name pointing to your cluster
fromBackup Property Map: Creates the cluster based on the existing backup.
instances Number: The total number of instances in the cluster (one master and n-1 standbys)
location String: The physical location where the cluster will be created. This will be where all of your instances live. Property cannot be modified after datacenter creation (disallowed in update requests)
maintenanceWindow Property Map: a weekly 4 hour-long window, during which maintenance might occur
pgClusterId String
postgresVersion String: The PostgreSQL version of your cluster.
ram Number: The amount of memory per instance in megabytes. Has to be a multiple of 1024.
storageSize Number: The amount of storage per instance in megabytes. Has to be a multiple of 2048.
storageType String: The storage type used in your cluster.
synchronizationMode String: Represents different modes of replication.
timeouts Property Map

Supporting Types

PgClusterConnectionPooler
, PgClusterConnectionPoolerArgs

Enabled bool
PoolMode string: Represents different modes of connection pooling for the connection pooler

Enabled bool
PoolMode string: Represents different modes of connection pooling for the connection pooler

enabled Boolean
poolMode String: Represents different modes of connection pooling for the connection pooler

enabled boolean
poolMode string: Represents different modes of connection pooling for the connection pooler

enabled bool
pool_mode str: Represents different modes of connection pooling for the connection pooler

enabled Boolean
poolMode String: Represents different modes of connection pooling for the connection pooler

PgClusterConnections
, PgClusterConnectionsArgs

Cidr string: The IP and subnet for the database. Note the following unavailable IP ranges: 10.233.64.0/18 10.233.0.0/18 10.233.114.0/24
DatacenterId string: The datacenter to connect your cluster to.
LanId string: The LAN to connect your cluster to.

Cidr string: The IP and subnet for the database. Note the following unavailable IP ranges: 10.233.64.0/18 10.233.0.0/18 10.233.114.0/24
DatacenterId string: The datacenter to connect your cluster to.
LanId string: The LAN to connect your cluster to.

cidr String: The IP and subnet for the database. Note the following unavailable IP ranges: 10.233.64.0/18 10.233.0.0/18 10.233.114.0/24
datacenterId String: The datacenter to connect your cluster to.
lanId String: The LAN to connect your cluster to.

cidr string: The IP and subnet for the database. Note the following unavailable IP ranges: 10.233.64.0/18 10.233.0.0/18 10.233.114.0/24
datacenterId string: The datacenter to connect your cluster to.
lanId string: The LAN to connect your cluster to.

cidr str: The IP and subnet for the database. Note the following unavailable IP ranges: 10.233.64.0/18 10.233.0.0/18 10.233.114.0/24
datacenter_id str: The datacenter to connect your cluster to.
lan_id str: The LAN to connect your cluster to.

cidr String: The IP and subnet for the database. Note the following unavailable IP ranges: 10.233.64.0/18 10.233.0.0/18 10.233.114.0/24
datacenterId String: The datacenter to connect your cluster to.
lanId String: The LAN to connect your cluster to.

PgClusterCredentials
, PgClusterCredentialsArgs

Password string
Username string: the username for the initial postgres user. some system usernames are restricted (e.g. "postgres", "admin", "standby")

Password string
Username string: the username for the initial postgres user. some system usernames are restricted (e.g. "postgres", "admin", "standby")

password String
username String: the username for the initial postgres user. some system usernames are restricted (e.g. "postgres", "admin", "standby")

password string
username string: the username for the initial postgres user. some system usernames are restricted (e.g. "postgres", "admin", "standby")

password str
username str: the username for the initial postgres user. some system usernames are restricted (e.g. "postgres", "admin", "standby")

password String
username String: the username for the initial postgres user. some system usernames are restricted (e.g. "postgres", "admin", "standby")

PgClusterFromBackup
, PgClusterFromBackupArgs

BackupId string: The unique ID of the backup you want to restore.
RecoveryTargetTime string: If this value is supplied as ISO 8601 timestamp, the backup will be replayed up until the given timestamp. If empty, the backup will be applied completely.

BackupId string: The unique ID of the backup you want to restore.
RecoveryTargetTime string: If this value is supplied as ISO 8601 timestamp, the backup will be replayed up until the given timestamp. If empty, the backup will be applied completely.

backupId String: The unique ID of the backup you want to restore.
recoveryTargetTime String: If this value is supplied as ISO 8601 timestamp, the backup will be replayed up until the given timestamp. If empty, the backup will be applied completely.

backupId string: The unique ID of the backup you want to restore.
recoveryTargetTime string: If this value is supplied as ISO 8601 timestamp, the backup will be replayed up until the given timestamp. If empty, the backup will be applied completely.

backup_id str: The unique ID of the backup you want to restore.
recovery_target_time str: If this value is supplied as ISO 8601 timestamp, the backup will be replayed up until the given timestamp. If empty, the backup will be applied completely.

backupId String: The unique ID of the backup you want to restore.
recoveryTargetTime String: If this value is supplied as ISO 8601 timestamp, the backup will be replayed up until the given timestamp. If empty, the backup will be applied completely.

PgClusterMaintenanceWindow
, PgClusterMaintenanceWindowArgs

DayOfTheWeek string
Time string

DayOfTheWeek string
Time string

dayOfTheWeek String
time String

dayOfTheWeek string
time string

day_of_the_week str
time str

dayOfTheWeek String
time String

PgClusterTimeouts
, PgClusterTimeoutsArgs

Create string
Default string
Delete string
Update string

Create string
Default string
Delete string
Update string

create String
default_ String
delete String
update String

create string
default string
delete string
update string

create str
default str
delete str
update str

create String
default String
delete String
update String

Package Details

Repository: ionoscloud ionos-cloud/terraform-provider-ionoscloud
License
Notes: This Pulumi package is based on the ionoscloud Terraform Provider.

ionoscloud 6.7.6 published on Monday, Apr 14, 2025 by ionos-cloud

ionos-cloud/terraform-provider-ionoscloud

ionoscloud.PgCluster

On this page

On this page

Create PgCluster Resource

Constructor syntax

Parameters

Constructor example

PgCluster Resource Properties

Inputs

Outputs

Look up Existing PgCluster Resource

Supporting Types

PgClusterConnectionPooler
, PgClusterConnectionPoolerArgs

PgClusterConnections
, PgClusterConnectionsArgs

PgClusterCredentials
, PgClusterCredentialsArgs

PgClusterFromBackup
, PgClusterFromBackupArgs

PgClusterMaintenanceWindow
, PgClusterMaintenanceWindowArgs

PgClusterTimeouts
, PgClusterTimeoutsArgs

Package Details

On this page

On this page

ionoscloud.PgCluster

On this page

On this page

Create PgCluster Resource

Constructor syntax

Parameters

Constructor example

PgCluster Resource Properties

Inputs

Outputs

Look up Existing PgCluster Resource

Supporting Types

PgClusterConnectionPooler, PgClusterConnectionPoolerArgs

PgClusterConnections, PgClusterConnectionsArgs

PgClusterCredentials, PgClusterCredentialsArgs

PgClusterFromBackup, PgClusterFromBackupArgs

PgClusterMaintenanceWindow, PgClusterMaintenanceWindowArgs

PgClusterTimeouts, PgClusterTimeoutsArgs

Package Details

On this page

On this page

PgClusterConnectionPooler
, PgClusterConnectionPoolerArgs

PgClusterConnections
, PgClusterConnectionsArgs

PgClusterCredentials
, PgClusterCredentialsArgs

PgClusterFromBackup
, PgClusterFromBackupArgs

PgClusterMaintenanceWindow
, PgClusterMaintenanceWindowArgs

PgClusterTimeouts
, PgClusterTimeoutsArgs