1. Packages
  2. Volcengine
  3. API Docs
  4. rds_postgresql
  5. Instance
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.rds_postgresql.Instance

volcengine logo
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Provides a resource to manage rds postgresql instance

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";
import * as volcengine from "@volcengine/pulumi";

const fooZones = volcengine.rds_postgresql.getZones({});
// create vpc
const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
    vpcName: "acc-test-vpc",
    cidrBlock: "172.16.0.0/16",
    dnsServers: [
        "8.8.8.8",
        "114.114.114.114",
    ],
    projectName: "default",
});
// create subnet
const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
    subnetName: "acc-test-subnet",
    cidrBlock: "172.16.0.0/24",
    zoneId: data.volcengine_zones.foo.zones[0].id,
    vpcId: fooVpc.id,
});
// create postgresql instance
const fooInstance = new volcengine.rds_postgresql.Instance("fooInstance", {
    dbEngineVersion: "PostgreSQL_12",
    nodeSpec: "rds.postgres.1c2g",
    primaryZoneId: data.volcengine_zones.foo.zones[0].id,
    secondaryZoneId: data.volcengine_zones.foo.zones[0].id,
    storageSpace: 40,
    subnetId: fooSubnet.id,
    instanceName: "acc-test-postgresql-instance",
    chargeInfo: {
        chargeType: "PostPaid",
    },
    projectName: "default",
    tags: [{
        key: "tfk1",
        value: "tfv1",
    }],
    parameters: [
        {
            name: "auto_explain.log_analyze",
            value: "off",
        },
        {
            name: "auto_explain.log_format",
            value: "text",
        },
    ],
});
// create postgresql instance readonly node
const fooInstanceReadonlyNode = new volcengine.rds_postgresql.InstanceReadonlyNode("fooInstanceReadonlyNode", {
    instanceId: fooInstance.id,
    nodeSpec: "rds.postgres.1c2g",
    zoneId: data.volcengine_zones.foo.zones[0].id,
});
// create postgresql allow list
const fooAllowlist = new volcengine.rds_postgresql.Allowlist("fooAllowlist", {
    allowListName: "acc-test-allowlist",
    allowListDesc: "acc-test",
    allowListType: "IPv4",
    allowLists: [
        "192.168.0.0/24",
        "192.168.1.0/24",
    ],
});
// associate postgresql allow list to postgresql instance
const fooAllowlistAssociate = new volcengine.rds_postgresql.AllowlistAssociate("fooAllowlistAssociate", {
    instanceId: fooInstance.id,
    allowListId: fooAllowlist.id,
});
// create postgresql database
const fooDatabase = new volcengine.rds_postgresql.Database("fooDatabase", {
    dbName: "acc-test-database",
    instanceId: fooInstance.id,
    cType: "C",
    collate: "zh_CN.utf8",
});
// create postgresql account
const fooAccount = new volcengine.rds_postgresql.Account("fooAccount", {
    accountName: "acc-test-account",
    accountPassword: "9wc@********12",
    accountType: "Normal",
    instanceId: fooInstance.id,
    accountPrivileges: "Inherit,Login,CreateRole,CreateDB",
});
// create postgresql schema
const fooSchema = new volcengine.rds_postgresql.Schema("fooSchema", {
    dbName: fooDatabase.dbName,
    instanceId: fooInstance.id,
    owner: fooAccount.accountName,
    schemaName: "acc-test-schema",
});
// Restore the backup to a new instance
const example = new volcengine.rds_postgresql.Instance("example", {
    srcInstanceId: "postgres-faa4921fdde4",
    backupId: "20251215-215628F",
    dbEngineVersion: "PostgreSQL_12",
    nodeSpec: "rds.postgres.1c2g",
    subnetId: fooSubnet.id,
    instanceName: "acc-test-postgresql-instance-restore",
    chargeInfo: {
        chargeType: "PostPaid",
        number: 1,
    },
    primaryZoneId: data.volcengine_zones.foo.zones[0].id,
    secondaryZoneId: data.volcengine_zones.foo.zones[0].id,
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.rds_postgresql.get_zones()
# create vpc
foo_vpc = volcengine.vpc.Vpc("fooVpc",
    vpc_name="acc-test-vpc",
    cidr_block="172.16.0.0/16",
    dns_servers=[
        "8.8.8.8",
        "114.114.114.114",
    ],
    project_name="default")
# create subnet
foo_subnet = volcengine.vpc.Subnet("fooSubnet",
    subnet_name="acc-test-subnet",
    cidr_block="172.16.0.0/24",
    zone_id=data["volcengine_zones"]["foo"]["zones"][0]["id"],
    vpc_id=foo_vpc.id)
# create postgresql instance
foo_instance = volcengine.rds_postgresql.Instance("fooInstance",
    db_engine_version="PostgreSQL_12",
    node_spec="rds.postgres.1c2g",
    primary_zone_id=data["volcengine_zones"]["foo"]["zones"][0]["id"],
    secondary_zone_id=data["volcengine_zones"]["foo"]["zones"][0]["id"],
    storage_space=40,
    subnet_id=foo_subnet.id,
    instance_name="acc-test-postgresql-instance",
    charge_info=volcengine.rds_postgresql.InstanceChargeInfoArgs(
        charge_type="PostPaid",
    ),
    project_name="default",
    tags=[volcengine.rds_postgresql.InstanceTagArgs(
        key="tfk1",
        value="tfv1",
    )],
    parameters=[
        volcengine.rds_postgresql.InstanceParameterArgs(
            name="auto_explain.log_analyze",
            value="off",
        ),
        volcengine.rds_postgresql.InstanceParameterArgs(
            name="auto_explain.log_format",
            value="text",
        ),
    ])
# create postgresql instance readonly node
foo_instance_readonly_node = volcengine.rds_postgresql.InstanceReadonlyNode("fooInstanceReadonlyNode",
    instance_id=foo_instance.id,
    node_spec="rds.postgres.1c2g",
    zone_id=data["volcengine_zones"]["foo"]["zones"][0]["id"])
# create postgresql allow list
foo_allowlist = volcengine.rds_postgresql.Allowlist("fooAllowlist",
    allow_list_name="acc-test-allowlist",
    allow_list_desc="acc-test",
    allow_list_type="IPv4",
    allow_lists=[
        "192.168.0.0/24",
        "192.168.1.0/24",
    ])
# associate postgresql allow list to postgresql instance
foo_allowlist_associate = volcengine.rds_postgresql.AllowlistAssociate("fooAllowlistAssociate",
    instance_id=foo_instance.id,
    allow_list_id=foo_allowlist.id)
# create postgresql database
foo_database = volcengine.rds_postgresql.Database("fooDatabase",
    db_name="acc-test-database",
    instance_id=foo_instance.id,
    c_type="C",
    collate="zh_CN.utf8")
# create postgresql account
foo_account = volcengine.rds_postgresql.Account("fooAccount",
    account_name="acc-test-account",
    account_password="9wc@********12",
    account_type="Normal",
    instance_id=foo_instance.id,
    account_privileges="Inherit,Login,CreateRole,CreateDB")
# create postgresql schema
foo_schema = volcengine.rds_postgresql.Schema("fooSchema",
    db_name=foo_database.db_name,
    instance_id=foo_instance.id,
    owner=foo_account.account_name,
    schema_name="acc-test-schema")
# Restore the backup to a new instance
example = volcengine.rds_postgresql.Instance("example",
    src_instance_id="postgres-faa4921fdde4",
    backup_id="20251215-215628F",
    db_engine_version="PostgreSQL_12",
    node_spec="rds.postgres.1c2g",
    subnet_id=foo_subnet.id,
    instance_name="acc-test-postgresql-instance-restore",
    charge_info=volcengine.rds_postgresql.InstanceChargeInfoArgs(
        charge_type="PostPaid",
        number=1,
    ),
    primary_zone_id=data["volcengine_zones"]["foo"]["zones"][0]["id"],
    secondary_zone_id=data["volcengine_zones"]["foo"]["zones"][0]["id"])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_postgresql"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/vpc"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds_postgresql.GetZones(ctx, nil, nil)
		if err != nil {
			return err
		}
		// create vpc
		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
			VpcName:   pulumi.String("acc-test-vpc"),
			CidrBlock: pulumi.String("172.16.0.0/16"),
			DnsServers: pulumi.StringArray{
				pulumi.String("8.8.8.8"),
				pulumi.String("114.114.114.114"),
			},
			ProjectName: pulumi.String("default"),
		})
		if err != nil {
			return err
		}
		// create subnet
		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
			SubnetName: pulumi.String("acc-test-subnet"),
			CidrBlock:  pulumi.String("172.16.0.0/24"),
			ZoneId:     pulumi.Any(data.Volcengine_zones.Foo.Zones[0].Id),
			VpcId:      fooVpc.ID(),
		})
		if err != nil {
			return err
		}
		// create postgresql instance
		fooInstance, err := rds_postgresql.NewInstance(ctx, "fooInstance", &rds_postgresql.InstanceArgs{
			DbEngineVersion: pulumi.String("PostgreSQL_12"),
			NodeSpec:        pulumi.String("rds.postgres.1c2g"),
			PrimaryZoneId:   pulumi.Any(data.Volcengine_zones.Foo.Zones[0].Id),
			SecondaryZoneId: pulumi.Any(data.Volcengine_zones.Foo.Zones[0].Id),
			StorageSpace:    pulumi.Int(40),
			SubnetId:        fooSubnet.ID(),
			InstanceName:    pulumi.String("acc-test-postgresql-instance"),
			ChargeInfo: &rds_postgresql.InstanceChargeInfoArgs{
				ChargeType: pulumi.String("PostPaid"),
			},
			ProjectName: pulumi.String("default"),
			Tags: rds_postgresql.InstanceTagArray{
				&rds_postgresql.InstanceTagArgs{
					Key:   pulumi.String("tfk1"),
					Value: pulumi.String("tfv1"),
				},
			},
			Parameters: rds_postgresql.InstanceParameterArray{
				&rds_postgresql.InstanceParameterArgs{
					Name:  pulumi.String("auto_explain.log_analyze"),
					Value: pulumi.String("off"),
				},
				&rds_postgresql.InstanceParameterArgs{
					Name:  pulumi.String("auto_explain.log_format"),
					Value: pulumi.String("text"),
				},
			},
		})
		if err != nil {
			return err
		}
		// create postgresql instance readonly node
		_, err = rds_postgresql.NewInstanceReadonlyNode(ctx, "fooInstanceReadonlyNode", &rds_postgresql.InstanceReadonlyNodeArgs{
			InstanceId: fooInstance.ID(),
			NodeSpec:   pulumi.String("rds.postgres.1c2g"),
			ZoneId:     pulumi.Any(data.Volcengine_zones.Foo.Zones[0].Id),
		})
		if err != nil {
			return err
		}
		// create postgresql allow list
		fooAllowlist, err := rds_postgresql.NewAllowlist(ctx, "fooAllowlist", &rds_postgresql.AllowlistArgs{
			AllowListName: pulumi.String("acc-test-allowlist"),
			AllowListDesc: pulumi.String("acc-test"),
			AllowListType: pulumi.String("IPv4"),
			AllowLists: pulumi.StringArray{
				pulumi.String("192.168.0.0/24"),
				pulumi.String("192.168.1.0/24"),
			},
		})
		if err != nil {
			return err
		}
		// associate postgresql allow list to postgresql instance
		_, err = rds_postgresql.NewAllowlistAssociate(ctx, "fooAllowlistAssociate", &rds_postgresql.AllowlistAssociateArgs{
			InstanceId:  fooInstance.ID(),
			AllowListId: fooAllowlist.ID(),
		})
		if err != nil {
			return err
		}
		// create postgresql database
		fooDatabase, err := rds_postgresql.NewDatabase(ctx, "fooDatabase", &rds_postgresql.DatabaseArgs{
			DbName:     pulumi.String("acc-test-database"),
			InstanceId: fooInstance.ID(),
			CType:      pulumi.String("C"),
			Collate:    pulumi.String("zh_CN.utf8"),
		})
		if err != nil {
			return err
		}
		// create postgresql account
		fooAccount, err := rds_postgresql.NewAccount(ctx, "fooAccount", &rds_postgresql.AccountArgs{
			AccountName:       pulumi.String("acc-test-account"),
			AccountPassword:   pulumi.String("9wc@********12"),
			AccountType:       pulumi.String("Normal"),
			InstanceId:        fooInstance.ID(),
			AccountPrivileges: pulumi.String("Inherit,Login,CreateRole,CreateDB"),
		})
		if err != nil {
			return err
		}
		// create postgresql schema
		_, err = rds_postgresql.NewSchema(ctx, "fooSchema", &rds_postgresql.SchemaArgs{
			DbName:     fooDatabase.DbName,
			InstanceId: fooInstance.ID(),
			Owner:      fooAccount.AccountName,
			SchemaName: pulumi.String("acc-test-schema"),
		})
		if err != nil {
			return err
		}
		_, err = rds_postgresql.NewInstance(ctx, "example", &rds_postgresql.InstanceArgs{
			SrcInstanceId:   pulumi.String("postgres-faa4921fdde4"),
			BackupId:        pulumi.String("20251215-215628F"),
			DbEngineVersion: pulumi.String("PostgreSQL_12"),
			NodeSpec:        pulumi.String("rds.postgres.1c2g"),
			SubnetId:        fooSubnet.ID(),
			InstanceName:    pulumi.String("acc-test-postgresql-instance-restore"),
			ChargeInfo: &rds_postgresql.InstanceChargeInfoArgs{
				ChargeType: pulumi.String("PostPaid"),
				Number:     pulumi.Int(1),
			},
			PrimaryZoneId:   pulumi.Any(data.Volcengine_zones.Foo.Zones[0].Id),
			SecondaryZoneId: pulumi.Any(data.Volcengine_zones.Foo.Zones[0].Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Rds_postgresql.GetZones.Invoke();

    // create vpc
    var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
    {
        VpcName = "acc-test-vpc",
        CidrBlock = "172.16.0.0/16",
        DnsServers = new[]
        {
            "8.8.8.8",
            "114.114.114.114",
        },
        ProjectName = "default",
    });

    // create subnet
    var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
    {
        SubnetName = "acc-test-subnet",
        CidrBlock = "172.16.0.0/24",
        ZoneId = data.Volcengine_zones.Foo.Zones[0].Id,
        VpcId = fooVpc.Id,
    });

    // create postgresql instance
    var fooInstance = new Volcengine.Rds_postgresql.Instance("fooInstance", new()
    {
        DbEngineVersion = "PostgreSQL_12",
        NodeSpec = "rds.postgres.1c2g",
        PrimaryZoneId = data.Volcengine_zones.Foo.Zones[0].Id,
        SecondaryZoneId = data.Volcengine_zones.Foo.Zones[0].Id,
        StorageSpace = 40,
        SubnetId = fooSubnet.Id,
        InstanceName = "acc-test-postgresql-instance",
        ChargeInfo = new Volcengine.Rds_postgresql.Inputs.InstanceChargeInfoArgs
        {
            ChargeType = "PostPaid",
        },
        ProjectName = "default",
        Tags = new[]
        {
            new Volcengine.Rds_postgresql.Inputs.InstanceTagArgs
            {
                Key = "tfk1",
                Value = "tfv1",
            },
        },
        Parameters = new[]
        {
            new Volcengine.Rds_postgresql.Inputs.InstanceParameterArgs
            {
                Name = "auto_explain.log_analyze",
                Value = "off",
            },
            new Volcengine.Rds_postgresql.Inputs.InstanceParameterArgs
            {
                Name = "auto_explain.log_format",
                Value = "text",
            },
        },
    });

    // create postgresql instance readonly node
    var fooInstanceReadonlyNode = new Volcengine.Rds_postgresql.InstanceReadonlyNode("fooInstanceReadonlyNode", new()
    {
        InstanceId = fooInstance.Id,
        NodeSpec = "rds.postgres.1c2g",
        ZoneId = data.Volcengine_zones.Foo.Zones[0].Id,
    });

    // create postgresql allow list
    var fooAllowlist = new Volcengine.Rds_postgresql.Allowlist("fooAllowlist", new()
    {
        AllowListName = "acc-test-allowlist",
        AllowListDesc = "acc-test",
        AllowListType = "IPv4",
        AllowLists = new[]
        {
            "192.168.0.0/24",
            "192.168.1.0/24",
        },
    });

    // associate postgresql allow list to postgresql instance
    var fooAllowlistAssociate = new Volcengine.Rds_postgresql.AllowlistAssociate("fooAllowlistAssociate", new()
    {
        InstanceId = fooInstance.Id,
        AllowListId = fooAllowlist.Id,
    });

    // create postgresql database
    var fooDatabase = new Volcengine.Rds_postgresql.Database("fooDatabase", new()
    {
        DbName = "acc-test-database",
        InstanceId = fooInstance.Id,
        CType = "C",
        Collate = "zh_CN.utf8",
    });

    // create postgresql account
    var fooAccount = new Volcengine.Rds_postgresql.Account("fooAccount", new()
    {
        AccountName = "acc-test-account",
        AccountPassword = "9wc@********12",
        AccountType = "Normal",
        InstanceId = fooInstance.Id,
        AccountPrivileges = "Inherit,Login,CreateRole,CreateDB",
    });

    // create postgresql schema
    var fooSchema = new Volcengine.Rds_postgresql.Schema("fooSchema", new()
    {
        DbName = fooDatabase.DbName,
        InstanceId = fooInstance.Id,
        Owner = fooAccount.AccountName,
        SchemaName = "acc-test-schema",
    });

    // Restore the backup to a new instance
    var example = new Volcengine.Rds_postgresql.Instance("example", new()
    {
        SrcInstanceId = "postgres-faa4921fdde4",
        BackupId = "20251215-215628F",
        DbEngineVersion = "PostgreSQL_12",
        NodeSpec = "rds.postgres.1c2g",
        SubnetId = fooSubnet.Id,
        InstanceName = "acc-test-postgresql-instance-restore",
        ChargeInfo = new Volcengine.Rds_postgresql.Inputs.InstanceChargeInfoArgs
        {
            ChargeType = "PostPaid",
            Number = 1,
        },
        PrimaryZoneId = data.Volcengine_zones.Foo.Zones[0].Id,
        SecondaryZoneId = data.Volcengine_zones.Foo.Zones[0].Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_postgresql.Rds_postgresqlFunctions;
import com.pulumi.volcengine.rds_postgresql.inputs.GetZonesArgs;
import com.pulumi.volcengine.vpc.Vpc;
import com.pulumi.volcengine.vpc.VpcArgs;
import com.pulumi.volcengine.vpc.Subnet;
import com.pulumi.volcengine.vpc.SubnetArgs;
import com.pulumi.volcengine.rds_postgresql.Instance;
import com.pulumi.volcengine.rds_postgresql.InstanceArgs;
import com.pulumi.volcengine.rds_postgresql.inputs.InstanceChargeInfoArgs;
import com.pulumi.volcengine.rds_postgresql.inputs.InstanceTagArgs;
import com.pulumi.volcengine.rds_postgresql.inputs.InstanceParameterArgs;
import com.pulumi.volcengine.rds_postgresql.InstanceReadonlyNode;
import com.pulumi.volcengine.rds_postgresql.InstanceReadonlyNodeArgs;
import com.pulumi.volcengine.rds_postgresql.Allowlist;
import com.pulumi.volcengine.rds_postgresql.AllowlistArgs;
import com.pulumi.volcengine.rds_postgresql.AllowlistAssociate;
import com.pulumi.volcengine.rds_postgresql.AllowlistAssociateArgs;
import com.pulumi.volcengine.rds_postgresql.Database;
import com.pulumi.volcengine.rds_postgresql.DatabaseArgs;
import com.pulumi.volcengine.rds_postgresql.Account;
import com.pulumi.volcengine.rds_postgresql.AccountArgs;
import com.pulumi.volcengine.rds_postgresql.Schema;
import com.pulumi.volcengine.rds_postgresql.SchemaArgs;
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) {
        final var fooZones = Rds_postgresqlFunctions.getZones();

        // create vpc
        var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
            .vpcName("acc-test-vpc")
            .cidrBlock("172.16.0.0/16")
            .dnsServers(            
                "8.8.8.8",
                "114.114.114.114")
            .projectName("default")
            .build());

        // create subnet
        var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
            .subnetName("acc-test-subnet")
            .cidrBlock("172.16.0.0/24")
            .zoneId(data.volcengine_zones().foo().zones()[0].id())
            .vpcId(fooVpc.id())
            .build());

        // create postgresql instance
        var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
            .dbEngineVersion("PostgreSQL_12")
            .nodeSpec("rds.postgres.1c2g")
            .primaryZoneId(data.volcengine_zones().foo().zones()[0].id())
            .secondaryZoneId(data.volcengine_zones().foo().zones()[0].id())
            .storageSpace(40)
            .subnetId(fooSubnet.id())
            .instanceName("acc-test-postgresql-instance")
            .chargeInfo(InstanceChargeInfoArgs.builder()
                .chargeType("PostPaid")
                .build())
            .projectName("default")
            .tags(InstanceTagArgs.builder()
                .key("tfk1")
                .value("tfv1")
                .build())
            .parameters(            
                InstanceParameterArgs.builder()
                    .name("auto_explain.log_analyze")
                    .value("off")
                    .build(),
                InstanceParameterArgs.builder()
                    .name("auto_explain.log_format")
                    .value("text")
                    .build())
            .build());

        // create postgresql instance readonly node
        var fooInstanceReadonlyNode = new InstanceReadonlyNode("fooInstanceReadonlyNode", InstanceReadonlyNodeArgs.builder()        
            .instanceId(fooInstance.id())
            .nodeSpec("rds.postgres.1c2g")
            .zoneId(data.volcengine_zones().foo().zones()[0].id())
            .build());

        // create postgresql allow list
        var fooAllowlist = new Allowlist("fooAllowlist", AllowlistArgs.builder()        
            .allowListName("acc-test-allowlist")
            .allowListDesc("acc-test")
            .allowListType("IPv4")
            .allowLists(            
                "192.168.0.0/24",
                "192.168.1.0/24")
            .build());

        // associate postgresql allow list to postgresql instance
        var fooAllowlistAssociate = new AllowlistAssociate("fooAllowlistAssociate", AllowlistAssociateArgs.builder()        
            .instanceId(fooInstance.id())
            .allowListId(fooAllowlist.id())
            .build());

        // create postgresql database
        var fooDatabase = new Database("fooDatabase", DatabaseArgs.builder()        
            .dbName("acc-test-database")
            .instanceId(fooInstance.id())
            .cType("C")
            .collate("zh_CN.utf8")
            .build());

        // create postgresql account
        var fooAccount = new Account("fooAccount", AccountArgs.builder()        
            .accountName("acc-test-account")
            .accountPassword("9wc@********12")
            .accountType("Normal")
            .instanceId(fooInstance.id())
            .accountPrivileges("Inherit,Login,CreateRole,CreateDB")
            .build());

        // create postgresql schema
        var fooSchema = new Schema("fooSchema", SchemaArgs.builder()        
            .dbName(fooDatabase.dbName())
            .instanceId(fooInstance.id())
            .owner(fooAccount.accountName())
            .schemaName("acc-test-schema")
            .build());

        // Restore the backup to a new instance
        var example = new Instance("example", InstanceArgs.builder()        
            .srcInstanceId("postgres-faa4921fdde4")
            .backupId("20251215-215628F")
            .dbEngineVersion("PostgreSQL_12")
            .nodeSpec("rds.postgres.1c2g")
            .subnetId(fooSubnet.id())
            .instanceName("acc-test-postgresql-instance-restore")
            .chargeInfo(InstanceChargeInfoArgs.builder()
                .chargeType("PostPaid")
                .number(1)
                .build())
            .primaryZoneId(data.volcengine_zones().foo().zones()[0].id())
            .secondaryZoneId(data.volcengine_zones().foo().zones()[0].id())
            .build());

    }
}

    resources:
  # create vpc
  fooVpc:
    type: volcengine:vpc:Vpc
    properties:
      vpcName: acc-test-vpc
      cidrBlock: 172.16.0.0/16
      dnsServers:
        - 8.8.8.8
        - 114.114.114.114
      projectName: default
  # create subnet
  fooSubnet:
    type: volcengine:vpc:Subnet
    properties:
      subnetName: acc-test-subnet
      cidrBlock: 172.16.0.0/24
      zoneId: ${data.volcengine_zones.foo.zones[0].id}
      vpcId: ${fooVpc.id}
  # create postgresql instance
  fooInstance:
    type: volcengine:rds_postgresql:Instance
    properties:
      dbEngineVersion: PostgreSQL_12
      nodeSpec: rds.postgres.1c2g
      primaryZoneId: ${data.volcengine_zones.foo.zones[0].id}
      secondaryZoneId: ${data.volcengine_zones.foo.zones[0].id}
      storageSpace: 40
      subnetId: ${fooSubnet.id}
      instanceName: acc-test-postgresql-instance
      chargeInfo:
        chargeType: PostPaid
      projectName: default
      tags:
        - key: tfk1
          value: tfv1
      parameters:
        - name: auto_explain.log_analyze
          value: off
        - name: auto_explain.log_format
          value: text
  # create postgresql instance readonly node
  fooInstanceReadonlyNode:
    type: volcengine:rds_postgresql:InstanceReadonlyNode
    properties:
      instanceId: ${fooInstance.id}
      nodeSpec: rds.postgres.1c2g
      zoneId: ${data.volcengine_zones.foo.zones[0].id}
  # create postgresql allow list
  fooAllowlist:
    type: volcengine:rds_postgresql:Allowlist
    properties:
      allowListName: acc-test-allowlist
      allowListDesc: acc-test
      allowListType: IPv4
      allowLists:
        - 192.168.0.0/24
        - 192.168.1.0/24
  # associate postgresql allow list to postgresql instance
  fooAllowlistAssociate:
    type: volcengine:rds_postgresql:AllowlistAssociate
    properties:
      instanceId: ${fooInstance.id}
      allowListId: ${fooAllowlist.id}
  # create postgresql database
  fooDatabase:
    type: volcengine:rds_postgresql:Database
    properties:
      dbName: acc-test-database
      instanceId: ${fooInstance.id}
      cType: C
      collate: zh_CN.utf8
  # create postgresql account
  fooAccount:
    type: volcengine:rds_postgresql:Account
    properties:
      accountName: acc-test-account
      accountPassword: 9wc@********12
      accountType: Normal
      instanceId: ${fooInstance.id}
      accountPrivileges: Inherit,Login,CreateRole,CreateDB
  # create postgresql schema
  fooSchema: # Restore the backup to a new instance
    type: volcengine:rds_postgresql:Schema
    properties:
      dbName: ${fooDatabase.dbName}
      instanceId: ${fooInstance.id}
      owner: ${fooAccount.accountName}
      schemaName: acc-test-schema
  example:
    type: volcengine:rds_postgresql:Instance
    properties:
      srcInstanceId: postgres-faa4921fdde4
      backupId: 20251215-215628F
      dbEngineVersion: PostgreSQL_12
      nodeSpec: rds.postgres.1c2g
      subnetId: ${fooSubnet.id}
      instanceName: acc-test-postgresql-instance-restore
      chargeInfo:
        chargeType: PostPaid
        number: 1
      primaryZoneId: ${data.volcengine_zones.foo.zones[0].id}
      secondaryZoneId: ${data.volcengine_zones.foo.zones[0].id}
variables:
  fooZones:
    fn::invoke:
      Function: volcengine:rds_postgresql:getZones
      Arguments: {}

    Create Instance Resource

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

    Constructor syntax

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             node_spec: Optional[str] = None,
             subnet_id: Optional[str] = None,
             charge_info: Optional[InstanceChargeInfoArgs] = None,
             db_engine_version: Optional[str] = None,
             secondary_zone_id: Optional[str] = None,
             primary_zone_id: Optional[str] = None,
             parameters: Optional[Sequence[InstanceParameterArgs]] = None,
             modify_type: Optional[str] = None,
             allow_list_ids: Optional[Sequence[str]] = None,
             instance_name: Optional[str] = None,
             project_name: Optional[str] = None,
             restore_time: Optional[str] = None,
             rollback_time: Optional[str] = None,
             estimate_only: Optional[bool] = None,
             src_instance_id: Optional[str] = None,
             storage_space: Optional[int] = None,
             backup_id: Optional[str] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = None,
             zone_migrations: Optional[Sequence[InstanceZoneMigrationArgs]] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: volcengine:rds_postgresql:Instance
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 InstanceArgs
    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 InstanceArgs
    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 InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    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 exampleinstanceResourceResourceFromRds_postgresqlinstance = new Volcengine.Rds_postgresql.Instance("exampleinstanceResourceResourceFromRds_postgresqlinstance", new()
{
    NodeSpec = "string",
    SubnetId = "string",
    ChargeInfo = new Volcengine.Rds_postgresql.Inputs.InstanceChargeInfoArgs
    {
        ChargeType = "string",
        AutoRenew = false,
        Number = 0,
        Period = 0,
        PeriodUnit = "string",
    },
    DbEngineVersion = "string",
    SecondaryZoneId = "string",
    PrimaryZoneId = "string",
    Parameters = new[]
    {
        new Volcengine.Rds_postgresql.Inputs.InstanceParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    ModifyType = "string",
    AllowListIds = new[]
    {
        "string",
    },
    InstanceName = "string",
    ProjectName = "string",
    RestoreTime = "string",
    RollbackTime = "string",
    EstimateOnly = false,
    SrcInstanceId = "string",
    StorageSpace = 0,
    BackupId = "string",
    Tags = new[]
    {
        new Volcengine.Rds_postgresql.Inputs.InstanceTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    ZoneMigrations = new[]
    {
        new Volcengine.Rds_postgresql.Inputs.InstanceZoneMigrationArgs
        {
            NodeId = "string",
            ZoneId = "string",
            NodeType = "string",
        },
    },
});

    example, err := rds_postgresql.NewInstance(ctx, "exampleinstanceResourceResourceFromRds_postgresqlinstance", &rds_postgresql.InstanceArgs{
	NodeSpec: pulumi.String("string"),
	SubnetId: pulumi.String("string"),
	ChargeInfo: &rds_postgresql.InstanceChargeInfoArgs{
		ChargeType: pulumi.String("string"),
		AutoRenew:  pulumi.Bool(false),
		Number:     pulumi.Int(0),
		Period:     pulumi.Int(0),
		PeriodUnit: pulumi.String("string"),
	},
	DbEngineVersion: pulumi.String("string"),
	SecondaryZoneId: pulumi.String("string"),
	PrimaryZoneId:   pulumi.String("string"),
	Parameters: rds_postgresql.InstanceParameterArray{
		&rds_postgresql.InstanceParameterArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	ModifyType: pulumi.String("string"),
	AllowListIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	InstanceName:  pulumi.String("string"),
	ProjectName:   pulumi.String("string"),
	RestoreTime:   pulumi.String("string"),
	RollbackTime:  pulumi.String("string"),
	EstimateOnly:  pulumi.Bool(false),
	SrcInstanceId: pulumi.String("string"),
	StorageSpace:  pulumi.Int(0),
	BackupId:      pulumi.String("string"),
	Tags: rds_postgresql.InstanceTagArray{
		&rds_postgresql.InstanceTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	ZoneMigrations: rds_postgresql.InstanceZoneMigrationArray{
		&rds_postgresql.InstanceZoneMigrationArgs{
			NodeId:   pulumi.String("string"),
			ZoneId:   pulumi.String("string"),
			NodeType: pulumi.String("string"),
		},
	},
})

    var exampleinstanceResourceResourceFromRds_postgresqlinstance = new com.pulumi.volcengine.rds_postgresql.Instance("exampleinstanceResourceResourceFromRds_postgresqlinstance", com.pulumi.volcengine.rds_postgresql.InstanceArgs.builder()
    .nodeSpec("string")
    .subnetId("string")
    .chargeInfo(InstanceChargeInfoArgs.builder()
        .chargeType("string")
        .autoRenew(false)
        .number(0)
        .period(0)
        .periodUnit("string")
        .build())
    .dbEngineVersion("string")
    .secondaryZoneId("string")
    .primaryZoneId("string")
    .parameters(InstanceParameterArgs.builder()
        .name("string")
        .value("string")
        .build())
    .modifyType("string")
    .allowListIds("string")
    .instanceName("string")
    .projectName("string")
    .restoreTime("string")
    .rollbackTime("string")
    .estimateOnly(false)
    .srcInstanceId("string")
    .storageSpace(0)
    .backupId("string")
    .tags(InstanceTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .zoneMigrations(InstanceZoneMigrationArgs.builder()
        .nodeId("string")
        .zoneId("string")
        .nodeType("string")
        .build())
    .build());

    exampleinstance_resource_resource_from_rds_postgresqlinstance = volcengine.rds_postgresql.Instance("exampleinstanceResourceResourceFromRds_postgresqlinstance",
    node_spec="string",
    subnet_id="string",
    charge_info={
        "charge_type": "string",
        "auto_renew": False,
        "number": 0,
        "period": 0,
        "period_unit": "string",
    },
    db_engine_version="string",
    secondary_zone_id="string",
    primary_zone_id="string",
    parameters=[{
        "name": "string",
        "value": "string",
    }],
    modify_type="string",
    allow_list_ids=["string"],
    instance_name="string",
    project_name="string",
    restore_time="string",
    rollback_time="string",
    estimate_only=False,
    src_instance_id="string",
    storage_space=0,
    backup_id="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    zone_migrations=[{
        "node_id": "string",
        "zone_id": "string",
        "node_type": "string",
    }])

    const exampleinstanceResourceResourceFromRds_postgresqlinstance = new volcengine.rds_postgresql.Instance("exampleinstanceResourceResourceFromRds_postgresqlinstance", {
    nodeSpec: "string",
    subnetId: "string",
    chargeInfo: {
        chargeType: "string",
        autoRenew: false,
        number: 0,
        period: 0,
        periodUnit: "string",
    },
    dbEngineVersion: "string",
    secondaryZoneId: "string",
    primaryZoneId: "string",
    parameters: [{
        name: "string",
        value: "string",
    }],
    modifyType: "string",
    allowListIds: ["string"],
    instanceName: "string",
    projectName: "string",
    restoreTime: "string",
    rollbackTime: "string",
    estimateOnly: false,
    srcInstanceId: "string",
    storageSpace: 0,
    backupId: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    zoneMigrations: [{
        nodeId: "string",
        zoneId: "string",
        nodeType: "string",
    }],
});

    type: volcengine:rds_postgresql:Instance
properties:
    allowListIds:
        - string
    backupId: string
    chargeInfo:
        autoRenew: false
        chargeType: string
        number: 0
        period: 0
        periodUnit: string
    dbEngineVersion: string
    estimateOnly: false
    instanceName: string
    modifyType: string
    nodeSpec: string
    parameters:
        - name: string
          value: string
    primaryZoneId: string
    projectName: string
    restoreTime: string
    rollbackTime: string
    secondaryZoneId: string
    srcInstanceId: string
    storageSpace: 0
    subnetId: string
    tags:
        - key: string
          value: string
    zoneMigrations:
        - nodeId: string
          nodeType: string
          zoneId: string

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

    ChargeInfo InstanceChargeInfo
    Payment methods.
    DbEngineVersion string
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    NodeSpec string
    The specification of primary node and secondary node.
    PrimaryZoneId string
    The available zone of primary node.
    SecondaryZoneId string
    The available zone of secondary node.
    SubnetId string
    Subnet ID of the RDS PostgreSQL instance.
    AllowListIds List<string>
    Allow list IDs to bind at creation.
    BackupId string
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    EstimateOnly bool
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    InstanceName string
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    ModifyType string
    Spec change type. Usually(default) or Temporary.
    Parameters List<InstanceParameter>
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    ProjectName string
    The project name of the RDS instance.
    RestoreTime string
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    RollbackTime string
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    SrcInstanceId string
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    StorageSpace int
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    Tags List<InstanceTag>
    Tags.
    ZoneMigrations List<InstanceZoneMigration>
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.
    ChargeInfo InstanceChargeInfoArgs
    Payment methods.
    DbEngineVersion string
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    NodeSpec string
    The specification of primary node and secondary node.
    PrimaryZoneId string
    The available zone of primary node.
    SecondaryZoneId string
    The available zone of secondary node.
    SubnetId string
    Subnet ID of the RDS PostgreSQL instance.
    AllowListIds []string
    Allow list IDs to bind at creation.
    BackupId string
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    EstimateOnly bool
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    InstanceName string
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    ModifyType string
    Spec change type. Usually(default) or Temporary.
    Parameters []InstanceParameterArgs
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    ProjectName string
    The project name of the RDS instance.
    RestoreTime string
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    RollbackTime string
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    SrcInstanceId string
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    StorageSpace int
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    Tags []InstanceTagArgs
    Tags.
    ZoneMigrations []InstanceZoneMigrationArgs
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.
    chargeInfo InstanceChargeInfo
    Payment methods.
    dbEngineVersion String
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    nodeSpec String
    The specification of primary node and secondary node.
    primaryZoneId String
    The available zone of primary node.
    secondaryZoneId String
    The available zone of secondary node.
    subnetId String
    Subnet ID of the RDS PostgreSQL instance.
    allowListIds List<String>
    Allow list IDs to bind at creation.
    backupId String
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    estimateOnly Boolean
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    instanceName String
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    modifyType String
    Spec change type. Usually(default) or Temporary.
    parameters List<InstanceParameter>
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    projectName String
    The project name of the RDS instance.
    restoreTime String
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    rollbackTime String
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    srcInstanceId String
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    storageSpace Integer
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    tags List<InstanceTag>
    Tags.
    zoneMigrations List<InstanceZoneMigration>
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.
    chargeInfo InstanceChargeInfo
    Payment methods.
    dbEngineVersion string
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    nodeSpec string
    The specification of primary node and secondary node.
    primaryZoneId string
    The available zone of primary node.
    secondaryZoneId string
    The available zone of secondary node.
    subnetId string
    Subnet ID of the RDS PostgreSQL instance.
    allowListIds string[]
    Allow list IDs to bind at creation.
    backupId string
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    estimateOnly boolean
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    instanceName string
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    modifyType string
    Spec change type. Usually(default) or Temporary.
    parameters InstanceParameter[]
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    projectName string
    The project name of the RDS instance.
    restoreTime string
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    rollbackTime string
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    srcInstanceId string
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    storageSpace number
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    tags InstanceTag[]
    Tags.
    zoneMigrations InstanceZoneMigration[]
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.
    charge_info InstanceChargeInfoArgs
    Payment methods.
    db_engine_version str
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    node_spec str
    The specification of primary node and secondary node.
    primary_zone_id str
    The available zone of primary node.
    secondary_zone_id str
    The available zone of secondary node.
    subnet_id str
    Subnet ID of the RDS PostgreSQL instance.
    allow_list_ids Sequence[str]
    Allow list IDs to bind at creation.
    backup_id str
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    estimate_only bool
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    instance_name str
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    modify_type str
    Spec change type. Usually(default) or Temporary.
    parameters Sequence[InstanceParameterArgs]
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    project_name str
    The project name of the RDS instance.
    restore_time str
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    rollback_time str
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    src_instance_id str
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    storage_space int
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    tags Sequence[InstanceTagArgs]
    Tags.
    zone_migrations Sequence[InstanceZoneMigrationArgs]
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.
    chargeInfo Property Map
    Payment methods.
    dbEngineVersion String
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    nodeSpec String
    The specification of primary node and secondary node.
    primaryZoneId String
    The available zone of primary node.
    secondaryZoneId String
    The available zone of secondary node.
    subnetId String
    Subnet ID of the RDS PostgreSQL instance.
    allowListIds List<String>
    Allow list IDs to bind at creation.
    backupId String
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    estimateOnly Boolean
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    instanceName String
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    modifyType String
    Spec change type. Usually(default) or Temporary.
    parameters List<Property Map>
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    projectName String
    The project name of the RDS instance.
    restoreTime String
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    rollbackTime String
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    srcInstanceId String
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    storageSpace Number
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    tags List<Property Map>
    Tags.
    zoneMigrations List<Property Map>
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.

    Outputs

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

    AllowListVersion string
    The allow list version of the RDS PostgreSQL instance.
    BackupUse int
    The instance has used backup space. Unit: GB.
    ChargeDetails List<InstanceChargeDetail>
    Payment methods.
    CreateTime string
    Node creation local time.
    DataSyncMode string
    Data synchronization mode.
    Endpoints List<InstanceEndpoint>
    The endpoint info of the RDS instance.
    EstimationResults List<InstanceEstimationResult>
    The estimated impact on the instance after the current configuration changes.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID.
    InstanceStatus string
    The status of the RDS PostgreSQL instance.
    InstanceType string
    The instance type of the RDS PostgreSQL instance.
    Memory int
    Memory size in GB.
    NodeNumber int
    The number of nodes.
    Nodes List<InstanceNode>
    Instance node information.
    RegionId string
    The region of the RDS PostgreSQL instance.
    StorageDataUse int
    The instance's primary node has used storage space. Unit: Byte.
    StorageLogUse int
    The instance's primary node has used log storage space. Unit: Byte.
    StorageTempUse int
    The instance's primary node has used temporary storage space. Unit: Byte.
    StorageType string
    Instance storage type.
    StorageUse int
    The instance has used storage space. Unit: Byte.
    StorageWalUse int
    The instance's primary node has used WAL storage space. Unit: Byte.
    UpdateTime string
    The update time of the RDS PostgreSQL instance.
    VCpu int
    CPU size.
    VpcId string
    The vpc ID of the RDS PostgreSQL instance.
    ZoneId string
    The available zone of the RDS PostgreSQL instance.
    ZoneIds List<string>
    ID of the availability zone where each instance is located.
    AllowListVersion string
    The allow list version of the RDS PostgreSQL instance.
    BackupUse int
    The instance has used backup space. Unit: GB.
    ChargeDetails []InstanceChargeDetail
    Payment methods.
    CreateTime string
    Node creation local time.
    DataSyncMode string
    Data synchronization mode.
    Endpoints []InstanceEndpoint
    The endpoint info of the RDS instance.
    EstimationResults []InstanceEstimationResult
    The estimated impact on the instance after the current configuration changes.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Instance ID.
    InstanceStatus string
    The status of the RDS PostgreSQL instance.
    InstanceType string
    The instance type of the RDS PostgreSQL instance.
    Memory int
    Memory size in GB.
    NodeNumber int
    The number of nodes.
    Nodes []InstanceNode
    Instance node information.
    RegionId string
    The region of the RDS PostgreSQL instance.
    StorageDataUse int
    The instance's primary node has used storage space. Unit: Byte.
    StorageLogUse int
    The instance's primary node has used log storage space. Unit: Byte.
    StorageTempUse int
    The instance's primary node has used temporary storage space. Unit: Byte.
    StorageType string
    Instance storage type.
    StorageUse int
    The instance has used storage space. Unit: Byte.
    StorageWalUse int
    The instance's primary node has used WAL storage space. Unit: Byte.
    UpdateTime string
    The update time of the RDS PostgreSQL instance.
    VCpu int
    CPU size.
    VpcId string
    The vpc ID of the RDS PostgreSQL instance.
    ZoneId string
    The available zone of the RDS PostgreSQL instance.
    ZoneIds []string
    ID of the availability zone where each instance is located.
    allowListVersion String
    The allow list version of the RDS PostgreSQL instance.
    backupUse Integer
    The instance has used backup space. Unit: GB.
    chargeDetails List<InstanceChargeDetail>
    Payment methods.
    createTime String
    Node creation local time.
    dataSyncMode String
    Data synchronization mode.
    endpoints List<InstanceEndpoint>
    The endpoint info of the RDS instance.
    estimationResults List<InstanceEstimationResult>
    The estimated impact on the instance after the current configuration changes.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID.
    instanceStatus String
    The status of the RDS PostgreSQL instance.
    instanceType String
    The instance type of the RDS PostgreSQL instance.
    memory Integer
    Memory size in GB.
    nodeNumber Integer
    The number of nodes.
    nodes List<InstanceNode>
    Instance node information.
    regionId String
    The region of the RDS PostgreSQL instance.
    storageDataUse Integer
    The instance's primary node has used storage space. Unit: Byte.
    storageLogUse Integer
    The instance's primary node has used log storage space. Unit: Byte.
    storageTempUse Integer
    The instance's primary node has used temporary storage space. Unit: Byte.
    storageType String
    Instance storage type.
    storageUse Integer
    The instance has used storage space. Unit: Byte.
    storageWalUse Integer
    The instance's primary node has used WAL storage space. Unit: Byte.
    updateTime String
    The update time of the RDS PostgreSQL instance.
    vCpu Integer
    CPU size.
    vpcId String
    The vpc ID of the RDS PostgreSQL instance.
    zoneId String
    The available zone of the RDS PostgreSQL instance.
    zoneIds List<String>
    ID of the availability zone where each instance is located.
    allowListVersion string
    The allow list version of the RDS PostgreSQL instance.
    backupUse number
    The instance has used backup space. Unit: GB.
    chargeDetails InstanceChargeDetail[]
    Payment methods.
    createTime string
    Node creation local time.
    dataSyncMode string
    Data synchronization mode.
    endpoints InstanceEndpoint[]
    The endpoint info of the RDS instance.
    estimationResults InstanceEstimationResult[]
    The estimated impact on the instance after the current configuration changes.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    Instance ID.
    instanceStatus string
    The status of the RDS PostgreSQL instance.
    instanceType string
    The instance type of the RDS PostgreSQL instance.
    memory number
    Memory size in GB.
    nodeNumber number
    The number of nodes.
    nodes InstanceNode[]
    Instance node information.
    regionId string
    The region of the RDS PostgreSQL instance.
    storageDataUse number
    The instance's primary node has used storage space. Unit: Byte.
    storageLogUse number
    The instance's primary node has used log storage space. Unit: Byte.
    storageTempUse number
    The instance's primary node has used temporary storage space. Unit: Byte.
    storageType string
    Instance storage type.
    storageUse number
    The instance has used storage space. Unit: Byte.
    storageWalUse number
    The instance's primary node has used WAL storage space. Unit: Byte.
    updateTime string
    The update time of the RDS PostgreSQL instance.
    vCpu number
    CPU size.
    vpcId string
    The vpc ID of the RDS PostgreSQL instance.
    zoneId string
    The available zone of the RDS PostgreSQL instance.
    zoneIds string[]
    ID of the availability zone where each instance is located.
    allow_list_version str
    The allow list version of the RDS PostgreSQL instance.
    backup_use int
    The instance has used backup space. Unit: GB.
    charge_details Sequence[InstanceChargeDetail]
    Payment methods.
    create_time str
    Node creation local time.
    data_sync_mode str
    Data synchronization mode.
    endpoints Sequence[InstanceEndpoint]
    The endpoint info of the RDS instance.
    estimation_results Sequence[InstanceEstimationResult]
    The estimated impact on the instance after the current configuration changes.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    Instance ID.
    instance_status str
    The status of the RDS PostgreSQL instance.
    instance_type str
    The instance type of the RDS PostgreSQL instance.
    memory int
    Memory size in GB.
    node_number int
    The number of nodes.
    nodes Sequence[InstanceNode]
    Instance node information.
    region_id str
    The region of the RDS PostgreSQL instance.
    storage_data_use int
    The instance's primary node has used storage space. Unit: Byte.
    storage_log_use int
    The instance's primary node has used log storage space. Unit: Byte.
    storage_temp_use int
    The instance's primary node has used temporary storage space. Unit: Byte.
    storage_type str
    Instance storage type.
    storage_use int
    The instance has used storage space. Unit: Byte.
    storage_wal_use int
    The instance's primary node has used WAL storage space. Unit: Byte.
    update_time str
    The update time of the RDS PostgreSQL instance.
    v_cpu int
    CPU size.
    vpc_id str
    The vpc ID of the RDS PostgreSQL instance.
    zone_id str
    The available zone of the RDS PostgreSQL instance.
    zone_ids Sequence[str]
    ID of the availability zone where each instance is located.
    allowListVersion String
    The allow list version of the RDS PostgreSQL instance.
    backupUse Number
    The instance has used backup space. Unit: GB.
    chargeDetails List<Property Map>
    Payment methods.
    createTime String
    Node creation local time.
    dataSyncMode String
    Data synchronization mode.
    endpoints List<Property Map>
    The endpoint info of the RDS instance.
    estimationResults List<Property Map>
    The estimated impact on the instance after the current configuration changes.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    Instance ID.
    instanceStatus String
    The status of the RDS PostgreSQL instance.
    instanceType String
    The instance type of the RDS PostgreSQL instance.
    memory Number
    Memory size in GB.
    nodeNumber Number
    The number of nodes.
    nodes List<Property Map>
    Instance node information.
    regionId String
    The region of the RDS PostgreSQL instance.
    storageDataUse Number
    The instance's primary node has used storage space. Unit: Byte.
    storageLogUse Number
    The instance's primary node has used log storage space. Unit: Byte.
    storageTempUse Number
    The instance's primary node has used temporary storage space. Unit: Byte.
    storageType String
    Instance storage type.
    storageUse Number
    The instance has used storage space. Unit: Byte.
    storageWalUse Number
    The instance's primary node has used WAL storage space. Unit: Byte.
    updateTime String
    The update time of the RDS PostgreSQL instance.
    vCpu Number
    CPU size.
    vpcId String
    The vpc ID of the RDS PostgreSQL instance.
    zoneId String
    The available zone of the RDS PostgreSQL instance.
    zoneIds List<String>
    ID of the availability zone where each instance is located.

    Look up Existing Instance Resource

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

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_list_ids: Optional[Sequence[str]] = None,
        allow_list_version: Optional[str] = None,
        backup_id: Optional[str] = None,
        backup_use: Optional[int] = None,
        charge_details: Optional[Sequence[InstanceChargeDetailArgs]] = None,
        charge_info: Optional[InstanceChargeInfoArgs] = None,
        create_time: Optional[str] = None,
        data_sync_mode: Optional[str] = None,
        db_engine_version: Optional[str] = None,
        endpoints: Optional[Sequence[InstanceEndpointArgs]] = None,
        estimate_only: Optional[bool] = None,
        estimation_results: Optional[Sequence[InstanceEstimationResultArgs]] = None,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_status: Optional[str] = None,
        instance_type: Optional[str] = None,
        memory: Optional[int] = None,
        modify_type: Optional[str] = None,
        node_number: Optional[int] = None,
        node_spec: Optional[str] = None,
        nodes: Optional[Sequence[InstanceNodeArgs]] = None,
        parameters: Optional[Sequence[InstanceParameterArgs]] = None,
        primary_zone_id: Optional[str] = None,
        project_name: Optional[str] = None,
        region_id: Optional[str] = None,
        restore_time: Optional[str] = None,
        rollback_time: Optional[str] = None,
        secondary_zone_id: Optional[str] = None,
        src_instance_id: Optional[str] = None,
        storage_data_use: Optional[int] = None,
        storage_log_use: Optional[int] = None,
        storage_space: Optional[int] = None,
        storage_temp_use: Optional[int] = None,
        storage_type: Optional[str] = None,
        storage_use: Optional[int] = None,
        storage_wal_use: Optional[int] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Sequence[InstanceTagArgs]] = None,
        update_time: Optional[str] = None,
        v_cpu: Optional[int] = None,
        vpc_id: Optional[str] = None,
        zone_id: Optional[str] = None,
        zone_ids: Optional[Sequence[str]] = None,
        zone_migrations: Optional[Sequence[InstanceZoneMigrationArgs]] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    resources:  _:    type: volcengine:rds_postgresql:Instance    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:
    AllowListIds List<string>
    Allow list IDs to bind at creation.
    AllowListVersion string
    The allow list version of the RDS PostgreSQL instance.
    BackupId string
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    BackupUse int
    The instance has used backup space. Unit: GB.
    ChargeDetails List<InstanceChargeDetail>
    Payment methods.
    ChargeInfo InstanceChargeInfo
    Payment methods.
    CreateTime string
    Node creation local time.
    DataSyncMode string
    Data synchronization mode.
    DbEngineVersion string
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    Endpoints List<InstanceEndpoint>
    The endpoint info of the RDS instance.
    EstimateOnly bool
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    EstimationResults List<InstanceEstimationResult>
    The estimated impact on the instance after the current configuration changes.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    InstanceStatus string
    The status of the RDS PostgreSQL instance.
    InstanceType string
    The instance type of the RDS PostgreSQL instance.
    Memory int
    Memory size in GB.
    ModifyType string
    Spec change type. Usually(default) or Temporary.
    NodeNumber int
    The number of nodes.
    NodeSpec string
    The specification of primary node and secondary node.
    Nodes List<InstanceNode>
    Instance node information.
    Parameters List<InstanceParameter>
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    PrimaryZoneId string
    The available zone of primary node.
    ProjectName string
    The project name of the RDS instance.
    RegionId string
    The region of the RDS PostgreSQL instance.
    RestoreTime string
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    RollbackTime string
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    SecondaryZoneId string
    The available zone of secondary node.
    SrcInstanceId string
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    StorageDataUse int
    The instance's primary node has used storage space. Unit: Byte.
    StorageLogUse int
    The instance's primary node has used log storage space. Unit: Byte.
    StorageSpace int
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    StorageTempUse int
    The instance's primary node has used temporary storage space. Unit: Byte.
    StorageType string
    Instance storage type.
    StorageUse int
    The instance has used storage space. Unit: Byte.
    StorageWalUse int
    The instance's primary node has used WAL storage space. Unit: Byte.
    SubnetId string
    Subnet ID of the RDS PostgreSQL instance.
    Tags List<InstanceTag>
    Tags.
    UpdateTime string
    The update time of the RDS PostgreSQL instance.
    VCpu int
    CPU size.
    VpcId string
    The vpc ID of the RDS PostgreSQL instance.
    ZoneId string
    The available zone of the RDS PostgreSQL instance.
    ZoneIds List<string>
    ID of the availability zone where each instance is located.
    ZoneMigrations List<InstanceZoneMigration>
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.
    AllowListIds []string
    Allow list IDs to bind at creation.
    AllowListVersion string
    The allow list version of the RDS PostgreSQL instance.
    BackupId string
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    BackupUse int
    The instance has used backup space. Unit: GB.
    ChargeDetails []InstanceChargeDetailArgs
    Payment methods.
    ChargeInfo InstanceChargeInfoArgs
    Payment methods.
    CreateTime string
    Node creation local time.
    DataSyncMode string
    Data synchronization mode.
    DbEngineVersion string
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    Endpoints []InstanceEndpointArgs
    The endpoint info of the RDS instance.
    EstimateOnly bool
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    EstimationResults []InstanceEstimationResultArgs
    The estimated impact on the instance after the current configuration changes.
    InstanceId string
    Instance ID.
    InstanceName string
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    InstanceStatus string
    The status of the RDS PostgreSQL instance.
    InstanceType string
    The instance type of the RDS PostgreSQL instance.
    Memory int
    Memory size in GB.
    ModifyType string
    Spec change type. Usually(default) or Temporary.
    NodeNumber int
    The number of nodes.
    NodeSpec string
    The specification of primary node and secondary node.
    Nodes []InstanceNodeArgs
    Instance node information.
    Parameters []InstanceParameterArgs
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    PrimaryZoneId string
    The available zone of primary node.
    ProjectName string
    The project name of the RDS instance.
    RegionId string
    The region of the RDS PostgreSQL instance.
    RestoreTime string
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    RollbackTime string
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    SecondaryZoneId string
    The available zone of secondary node.
    SrcInstanceId string
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    StorageDataUse int
    The instance's primary node has used storage space. Unit: Byte.
    StorageLogUse int
    The instance's primary node has used log storage space. Unit: Byte.
    StorageSpace int
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    StorageTempUse int
    The instance's primary node has used temporary storage space. Unit: Byte.
    StorageType string
    Instance storage type.
    StorageUse int
    The instance has used storage space. Unit: Byte.
    StorageWalUse int
    The instance's primary node has used WAL storage space. Unit: Byte.
    SubnetId string
    Subnet ID of the RDS PostgreSQL instance.
    Tags []InstanceTagArgs
    Tags.
    UpdateTime string
    The update time of the RDS PostgreSQL instance.
    VCpu int
    CPU size.
    VpcId string
    The vpc ID of the RDS PostgreSQL instance.
    ZoneId string
    The available zone of the RDS PostgreSQL instance.
    ZoneIds []string
    ID of the availability zone where each instance is located.
    ZoneMigrations []InstanceZoneMigrationArgs
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.
    allowListIds List<String>
    Allow list IDs to bind at creation.
    allowListVersion String
    The allow list version of the RDS PostgreSQL instance.
    backupId String
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    backupUse Integer
    The instance has used backup space. Unit: GB.
    chargeDetails List<InstanceChargeDetail>
    Payment methods.
    chargeInfo InstanceChargeInfo
    Payment methods.
    createTime String
    Node creation local time.
    dataSyncMode String
    Data synchronization mode.
    dbEngineVersion String
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    endpoints List<InstanceEndpoint>
    The endpoint info of the RDS instance.
    estimateOnly Boolean
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    estimationResults List<InstanceEstimationResult>
    The estimated impact on the instance after the current configuration changes.
    instanceId String
    Instance ID.
    instanceName String
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    instanceStatus String
    The status of the RDS PostgreSQL instance.
    instanceType String
    The instance type of the RDS PostgreSQL instance.
    memory Integer
    Memory size in GB.
    modifyType String
    Spec change type. Usually(default) or Temporary.
    nodeNumber Integer
    The number of nodes.
    nodeSpec String
    The specification of primary node and secondary node.
    nodes List<InstanceNode>
    Instance node information.
    parameters List<InstanceParameter>
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    primaryZoneId String
    The available zone of primary node.
    projectName String
    The project name of the RDS instance.
    regionId String
    The region of the RDS PostgreSQL instance.
    restoreTime String
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    rollbackTime String
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    secondaryZoneId String
    The available zone of secondary node.
    srcInstanceId String
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    storageDataUse Integer
    The instance's primary node has used storage space. Unit: Byte.
    storageLogUse Integer
    The instance's primary node has used log storage space. Unit: Byte.
    storageSpace Integer
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    storageTempUse Integer
    The instance's primary node has used temporary storage space. Unit: Byte.
    storageType String
    Instance storage type.
    storageUse Integer
    The instance has used storage space. Unit: Byte.
    storageWalUse Integer
    The instance's primary node has used WAL storage space. Unit: Byte.
    subnetId String
    Subnet ID of the RDS PostgreSQL instance.
    tags List<InstanceTag>
    Tags.
    updateTime String
    The update time of the RDS PostgreSQL instance.
    vCpu Integer
    CPU size.
    vpcId String
    The vpc ID of the RDS PostgreSQL instance.
    zoneId String
    The available zone of the RDS PostgreSQL instance.
    zoneIds List<String>
    ID of the availability zone where each instance is located.
    zoneMigrations List<InstanceZoneMigration>
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.
    allowListIds string[]
    Allow list IDs to bind at creation.
    allowListVersion string
    The allow list version of the RDS PostgreSQL instance.
    backupId string
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    backupUse number
    The instance has used backup space. Unit: GB.
    chargeDetails InstanceChargeDetail[]
    Payment methods.
    chargeInfo InstanceChargeInfo
    Payment methods.
    createTime string
    Node creation local time.
    dataSyncMode string
    Data synchronization mode.
    dbEngineVersion string
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    endpoints InstanceEndpoint[]
    The endpoint info of the RDS instance.
    estimateOnly boolean
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    estimationResults InstanceEstimationResult[]
    The estimated impact on the instance after the current configuration changes.
    instanceId string
    Instance ID.
    instanceName string
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    instanceStatus string
    The status of the RDS PostgreSQL instance.
    instanceType string
    The instance type of the RDS PostgreSQL instance.
    memory number
    Memory size in GB.
    modifyType string
    Spec change type. Usually(default) or Temporary.
    nodeNumber number
    The number of nodes.
    nodeSpec string
    The specification of primary node and secondary node.
    nodes InstanceNode[]
    Instance node information.
    parameters InstanceParameter[]
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    primaryZoneId string
    The available zone of primary node.
    projectName string
    The project name of the RDS instance.
    regionId string
    The region of the RDS PostgreSQL instance.
    restoreTime string
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    rollbackTime string
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    secondaryZoneId string
    The available zone of secondary node.
    srcInstanceId string
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    storageDataUse number
    The instance's primary node has used storage space. Unit: Byte.
    storageLogUse number
    The instance's primary node has used log storage space. Unit: Byte.
    storageSpace number
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    storageTempUse number
    The instance's primary node has used temporary storage space. Unit: Byte.
    storageType string
    Instance storage type.
    storageUse number
    The instance has used storage space. Unit: Byte.
    storageWalUse number
    The instance's primary node has used WAL storage space. Unit: Byte.
    subnetId string
    Subnet ID of the RDS PostgreSQL instance.
    tags InstanceTag[]
    Tags.
    updateTime string
    The update time of the RDS PostgreSQL instance.
    vCpu number
    CPU size.
    vpcId string
    The vpc ID of the RDS PostgreSQL instance.
    zoneId string
    The available zone of the RDS PostgreSQL instance.
    zoneIds string[]
    ID of the availability zone where each instance is located.
    zoneMigrations InstanceZoneMigration[]
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.
    allow_list_ids Sequence[str]
    Allow list IDs to bind at creation.
    allow_list_version str
    The allow list version of the RDS PostgreSQL instance.
    backup_id str
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    backup_use int
    The instance has used backup space. Unit: GB.
    charge_details Sequence[InstanceChargeDetailArgs]
    Payment methods.
    charge_info InstanceChargeInfoArgs
    Payment methods.
    create_time str
    Node creation local time.
    data_sync_mode str
    Data synchronization mode.
    db_engine_version str
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    endpoints Sequence[InstanceEndpointArgs]
    The endpoint info of the RDS instance.
    estimate_only bool
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    estimation_results Sequence[InstanceEstimationResultArgs]
    The estimated impact on the instance after the current configuration changes.
    instance_id str
    Instance ID.
    instance_name str
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    instance_status str
    The status of the RDS PostgreSQL instance.
    instance_type str
    The instance type of the RDS PostgreSQL instance.
    memory int
    Memory size in GB.
    modify_type str
    Spec change type. Usually(default) or Temporary.
    node_number int
    The number of nodes.
    node_spec str
    The specification of primary node and secondary node.
    nodes Sequence[InstanceNodeArgs]
    Instance node information.
    parameters Sequence[InstanceParameterArgs]
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    primary_zone_id str
    The available zone of primary node.
    project_name str
    The project name of the RDS instance.
    region_id str
    The region of the RDS PostgreSQL instance.
    restore_time str
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    rollback_time str
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    secondary_zone_id str
    The available zone of secondary node.
    src_instance_id str
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    storage_data_use int
    The instance's primary node has used storage space. Unit: Byte.
    storage_log_use int
    The instance's primary node has used log storage space. Unit: Byte.
    storage_space int
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    storage_temp_use int
    The instance's primary node has used temporary storage space. Unit: Byte.
    storage_type str
    Instance storage type.
    storage_use int
    The instance has used storage space. Unit: Byte.
    storage_wal_use int
    The instance's primary node has used WAL storage space. Unit: Byte.
    subnet_id str
    Subnet ID of the RDS PostgreSQL instance.
    tags Sequence[InstanceTagArgs]
    Tags.
    update_time str
    The update time of the RDS PostgreSQL instance.
    v_cpu int
    CPU size.
    vpc_id str
    The vpc ID of the RDS PostgreSQL instance.
    zone_id str
    The available zone of the RDS PostgreSQL instance.
    zone_ids Sequence[str]
    ID of the availability zone where each instance is located.
    zone_migrations Sequence[InstanceZoneMigrationArgs]
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.
    allowListIds List<String>
    Allow list IDs to bind at creation.
    allowListVersion String
    The allow list version of the RDS PostgreSQL instance.
    backupId String
    Backup ID (choose either this or restore_time; if both are set, backup_id shall prevail).
    backupUse Number
    The instance has used backup space. Unit: GB.
    chargeDetails List<Property Map>
    Payment methods.
    chargeInfo Property Map
    Payment methods.
    createTime String
    Node creation local time.
    dataSyncMode String
    Data synchronization mode.
    dbEngineVersion String
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13, PostgreSQL_14, PostgreSQL_15, PostgreSQL_16, PostgreSQL_17.
    endpoints List<Property Map>
    The endpoint info of the RDS instance.
    estimateOnly Boolean
    Whether to initiate a configuration change assessment. Only estimate spec change impact without executing. Default value: false.
    estimationResults List<Property Map>
    The estimated impact on the instance after the current configuration changes.
    instanceId String
    Instance ID.
    instanceName String
    Instance name. Cannot start with a number or a dash. Can only contain Chinese characters, letters, numbers, underscores and dashes. The length is limited between 1 ~ 128.
    instanceStatus String
    The status of the RDS PostgreSQL instance.
    instanceType String
    The instance type of the RDS PostgreSQL instance.
    memory Number
    Memory size in GB.
    modifyType String
    Spec change type. Usually(default) or Temporary.
    nodeNumber Number
    The number of nodes.
    nodeSpec String
    The specification of primary node and secondary node.
    nodes List<Property Map>
    Instance node information.
    parameters List<Property Map>
    Parameter of the RDS PostgreSQL instance. This field can only be added or modified. Deleting this field is invalid.
    primaryZoneId String
    The available zone of primary node.
    projectName String
    The project name of the RDS instance.
    regionId String
    The region of the RDS PostgreSQL instance.
    restoreTime String
    The point in time to restore to, in UTC format yyyy-MM-ddTHH:mm:ssZ (choose either this or backup_id).
    rollbackTime String
    Rollback time for Temporary change, UTC format yyyy-MM-ddTHH:mm:ss.sssZ.
    secondaryZoneId String
    The available zone of secondary node.
    srcInstanceId String
    Source instance ID. After setting it, a new instance will be created by restoring from the backup/time point.
    storageDataUse Number
    The instance's primary node has used storage space. Unit: Byte.
    storageLogUse Number
    The instance's primary node has used log storage space. Unit: Byte.
    storageSpace Number
    Instance storage space. Value range: [20, 3000], unit: GB, step 10GB. Default value: 100.
    storageTempUse Number
    The instance's primary node has used temporary storage space. Unit: Byte.
    storageType String
    Instance storage type.
    storageUse Number
    The instance has used storage space. Unit: Byte.
    storageWalUse Number
    The instance's primary node has used WAL storage space. Unit: Byte.
    subnetId String
    Subnet ID of the RDS PostgreSQL instance.
    tags List<Property Map>
    Tags.
    updateTime String
    The update time of the RDS PostgreSQL instance.
    vCpu Number
    CPU size.
    vpcId String
    The vpc ID of the RDS PostgreSQL instance.
    zoneId String
    The available zone of the RDS PostgreSQL instance.
    zoneIds List<String>
    ID of the availability zone where each instance is located.
    zoneMigrations List<Property Map>
    Nodes to migrate AZ. Only Secondary or ReadOnly nodes are allowed. If you want to migrate the availability zone of the secondary node, you need to add the zone_migrations field. Modifying the secondary_zone_id directly will not work. Cross-AZ instance migration is not supported.

    Supporting Types

    InstanceChargeDetail, InstanceChargeDetailArgs

    AutoRenew bool
    Whether to automatically renew in prepaid scenarios. Autorenew_Enable Autorenew_Disable (default).
    ChargeEndTime string
    Billing expiry time (yearly and monthly only).
    ChargeStartTime string
    Billing start time (pay-as-you-go & monthly subscription).
    ChargeStatus string
    Pay status. Value: normal - normal overdue - overdue unpaid - unpaid.
    ChargeType string
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    Number int
    The number of the RDS PostgreSQL instance.
    OverdueReclaimTime string
    Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
    OverdueTime string
    Shutdown time in arrears (pay-as-you-go & monthly subscription).
    Period int
    Purchase duration in prepaid scenarios. Default: 1.
    PeriodUnit string
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    TempModifyEndTime string
    Temporary upgrade of restoration time.
    TempModifyStartTime string
    Start time of temporary upgrade.
    AutoRenew bool
    Whether to automatically renew in prepaid scenarios. Autorenew_Enable Autorenew_Disable (default).
    ChargeEndTime string
    Billing expiry time (yearly and monthly only).
    ChargeStartTime string
    Billing start time (pay-as-you-go & monthly subscription).
    ChargeStatus string
    Pay status. Value: normal - normal overdue - overdue unpaid - unpaid.
    ChargeType string
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    Number int
    The number of the RDS PostgreSQL instance.
    OverdueReclaimTime string
    Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
    OverdueTime string
    Shutdown time in arrears (pay-as-you-go & monthly subscription).
    Period int
    Purchase duration in prepaid scenarios. Default: 1.
    PeriodUnit string
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    TempModifyEndTime string
    Temporary upgrade of restoration time.
    TempModifyStartTime string
    Start time of temporary upgrade.
    autoRenew Boolean
    Whether to automatically renew in prepaid scenarios. Autorenew_Enable Autorenew_Disable (default).
    chargeEndTime String
    Billing expiry time (yearly and monthly only).
    chargeStartTime String
    Billing start time (pay-as-you-go & monthly subscription).
    chargeStatus String
    Pay status. Value: normal - normal overdue - overdue unpaid - unpaid.
    chargeType String
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    number Integer
    The number of the RDS PostgreSQL instance.
    overdueReclaimTime String
    Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
    overdueTime String
    Shutdown time in arrears (pay-as-you-go & monthly subscription).
    period Integer
    Purchase duration in prepaid scenarios. Default: 1.
    periodUnit String
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    tempModifyEndTime String
    Temporary upgrade of restoration time.
    tempModifyStartTime String
    Start time of temporary upgrade.
    autoRenew boolean
    Whether to automatically renew in prepaid scenarios. Autorenew_Enable Autorenew_Disable (default).
    chargeEndTime string
    Billing expiry time (yearly and monthly only).
    chargeStartTime string
    Billing start time (pay-as-you-go & monthly subscription).
    chargeStatus string
    Pay status. Value: normal - normal overdue - overdue unpaid - unpaid.
    chargeType string
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    number number
    The number of the RDS PostgreSQL instance.
    overdueReclaimTime string
    Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
    overdueTime string
    Shutdown time in arrears (pay-as-you-go & monthly subscription).
    period number
    Purchase duration in prepaid scenarios. Default: 1.
    periodUnit string
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    tempModifyEndTime string
    Temporary upgrade of restoration time.
    tempModifyStartTime string
    Start time of temporary upgrade.
    auto_renew bool
    Whether to automatically renew in prepaid scenarios. Autorenew_Enable Autorenew_Disable (default).
    charge_end_time str
    Billing expiry time (yearly and monthly only).
    charge_start_time str
    Billing start time (pay-as-you-go & monthly subscription).
    charge_status str
    Pay status. Value: normal - normal overdue - overdue unpaid - unpaid.
    charge_type str
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    number int
    The number of the RDS PostgreSQL instance.
    overdue_reclaim_time str
    Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
    overdue_time str
    Shutdown time in arrears (pay-as-you-go & monthly subscription).
    period int
    Purchase duration in prepaid scenarios. Default: 1.
    period_unit str
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    temp_modify_end_time str
    Temporary upgrade of restoration time.
    temp_modify_start_time str
    Start time of temporary upgrade.
    autoRenew Boolean
    Whether to automatically renew in prepaid scenarios. Autorenew_Enable Autorenew_Disable (default).
    chargeEndTime String
    Billing expiry time (yearly and monthly only).
    chargeStartTime String
    Billing start time (pay-as-you-go & monthly subscription).
    chargeStatus String
    Pay status. Value: normal - normal overdue - overdue unpaid - unpaid.
    chargeType String
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    number Number
    The number of the RDS PostgreSQL instance.
    overdueReclaimTime String
    Estimated release time when arrears are closed (pay-as-you-go & monthly subscription).
    overdueTime String
    Shutdown time in arrears (pay-as-you-go & monthly subscription).
    period Number
    Purchase duration in prepaid scenarios. Default: 1.
    periodUnit String
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    tempModifyEndTime String
    Temporary upgrade of restoration time.
    tempModifyStartTime String
    Start time of temporary upgrade.

    InstanceChargeInfo, InstanceChargeInfoArgs

    ChargeType string
    AutoRenew bool
    Whether to automatically renew in prepaid scenarios.
    Number int
    Purchase number of the RDS PostgreSQL instance. Range: [1, 20]. Default: 1.
    Period int
    Purchase duration in prepaid scenarios. Default: 1.
    PeriodUnit string
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    ChargeType string
    AutoRenew bool
    Whether to automatically renew in prepaid scenarios.
    Number int
    Purchase number of the RDS PostgreSQL instance. Range: [1, 20]. Default: 1.
    Period int
    Purchase duration in prepaid scenarios. Default: 1.
    PeriodUnit string
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    chargeType String
    autoRenew Boolean
    Whether to automatically renew in prepaid scenarios.
    number Integer
    Purchase number of the RDS PostgreSQL instance. Range: [1, 20]. Default: 1.
    period Integer
    Purchase duration in prepaid scenarios. Default: 1.
    periodUnit String
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    chargeType string
    autoRenew boolean
    Whether to automatically renew in prepaid scenarios.
    number number
    Purchase number of the RDS PostgreSQL instance. Range: [1, 20]. Default: 1.
    period number
    Purchase duration in prepaid scenarios. Default: 1.
    periodUnit string
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    charge_type str
    auto_renew bool
    Whether to automatically renew in prepaid scenarios.
    number int
    Purchase number of the RDS PostgreSQL instance. Range: [1, 20]. Default: 1.
    period int
    Purchase duration in prepaid scenarios. Default: 1.
    period_unit str
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.
    chargeType String
    autoRenew Boolean
    Whether to automatically renew in prepaid scenarios.
    number Number
    Purchase number of the RDS PostgreSQL instance. Range: [1, 20]. Default: 1.
    period Number
    Purchase duration in prepaid scenarios. Default: 1.
    periodUnit String
    The purchase cycle in the prepaid scenario. Month - monthly subscription (default) Year - Package year.

    InstanceEndpoint, InstanceEndpointArgs

    Addresses List<InstanceEndpointAddress>
    Address list.
    AutoAddNewNodes string
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    Description string
    Address description.
    EnableReadOnly string
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    EnableReadWriteSplitting string
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    EndpointId string
    Instance connection terminal ID.
    EndpointName string
    The instance connection terminal name.
    EndpointType string
    Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
    ReadOnlyNodeDistributionType string
    The distribution type of the read-only nodes, value: Default: Default distribution. Custom: Custom distribution.
    ReadOnlyNodeMaxDelayTime int
    Maximum latency threshold of read-only node. If the latency of a read-only node exceeds this value, reading traffic won't be routed to this node. Unit: seconds.Values: 0~3600.Default value: 30.
    ReadOnlyNodeWeights List<InstanceEndpointReadOnlyNodeWeight>
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    ReadWriteMode string
    Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
    ReadWriteProxyConnection int
    After the terminal enables read-write separation, the number of proxy connections set for the terminal. The lower limit of the number of proxy connections is 20. The upper limit of the number of proxy connections depends on the specifications of the instance master node.
    WriteNodeHaltWriting bool
    Whether the endpoint sends write requests to the write node (currently only the master node is a write node). Values: true: Yes(Default). false: No.
    Addresses []InstanceEndpointAddress
    Address list.
    AutoAddNewNodes string
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    Description string
    Address description.
    EnableReadOnly string
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    EnableReadWriteSplitting string
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    EndpointId string
    Instance connection terminal ID.
    EndpointName string
    The instance connection terminal name.
    EndpointType string
    Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
    ReadOnlyNodeDistributionType string
    The distribution type of the read-only nodes, value: Default: Default distribution. Custom: Custom distribution.
    ReadOnlyNodeMaxDelayTime int
    Maximum latency threshold of read-only node. If the latency of a read-only node exceeds this value, reading traffic won't be routed to this node. Unit: seconds.Values: 0~3600.Default value: 30.
    ReadOnlyNodeWeights []InstanceEndpointReadOnlyNodeWeight
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    ReadWriteMode string
    Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
    ReadWriteProxyConnection int
    After the terminal enables read-write separation, the number of proxy connections set for the terminal. The lower limit of the number of proxy connections is 20. The upper limit of the number of proxy connections depends on the specifications of the instance master node.
    WriteNodeHaltWriting bool
    Whether the endpoint sends write requests to the write node (currently only the master node is a write node). Values: true: Yes(Default). false: No.
    addresses List<InstanceEndpointAddress>
    Address list.
    autoAddNewNodes String
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    description String
    Address description.
    enableReadOnly String
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    enableReadWriteSplitting String
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    endpointId String
    Instance connection terminal ID.
    endpointName String
    The instance connection terminal name.
    endpointType String
    Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
    readOnlyNodeDistributionType String
    The distribution type of the read-only nodes, value: Default: Default distribution. Custom: Custom distribution.
    readOnlyNodeMaxDelayTime Integer
    Maximum latency threshold of read-only node. If the latency of a read-only node exceeds this value, reading traffic won't be routed to this node. Unit: seconds.Values: 0~3600.Default value: 30.
    readOnlyNodeWeights List<InstanceEndpointReadOnlyNodeWeight>
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    readWriteMode String
    Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
    readWriteProxyConnection Integer
    After the terminal enables read-write separation, the number of proxy connections set for the terminal. The lower limit of the number of proxy connections is 20. The upper limit of the number of proxy connections depends on the specifications of the instance master node.
    writeNodeHaltWriting Boolean
    Whether the endpoint sends write requests to the write node (currently only the master node is a write node). Values: true: Yes(Default). false: No.
    addresses InstanceEndpointAddress[]
    Address list.
    autoAddNewNodes string
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    description string
    Address description.
    enableReadOnly string
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    enableReadWriteSplitting string
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    endpointId string
    Instance connection terminal ID.
    endpointName string
    The instance connection terminal name.
    endpointType string
    Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
    readOnlyNodeDistributionType string
    The distribution type of the read-only nodes, value: Default: Default distribution. Custom: Custom distribution.
    readOnlyNodeMaxDelayTime number
    Maximum latency threshold of read-only node. If the latency of a read-only node exceeds this value, reading traffic won't be routed to this node. Unit: seconds.Values: 0~3600.Default value: 30.
    readOnlyNodeWeights InstanceEndpointReadOnlyNodeWeight[]
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    readWriteMode string
    Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
    readWriteProxyConnection number
    After the terminal enables read-write separation, the number of proxy connections set for the terminal. The lower limit of the number of proxy connections is 20. The upper limit of the number of proxy connections depends on the specifications of the instance master node.
    writeNodeHaltWriting boolean
    Whether the endpoint sends write requests to the write node (currently only the master node is a write node). Values: true: Yes(Default). false: No.
    addresses Sequence[InstanceEndpointAddress]
    Address list.
    auto_add_new_nodes str
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    description str
    Address description.
    enable_read_only str
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    enable_read_write_splitting str
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    endpoint_id str
    Instance connection terminal ID.
    endpoint_name str
    The instance connection terminal name.
    endpoint_type str
    Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
    read_only_node_distribution_type str
    The distribution type of the read-only nodes, value: Default: Default distribution. Custom: Custom distribution.
    read_only_node_max_delay_time int
    Maximum latency threshold of read-only node. If the latency of a read-only node exceeds this value, reading traffic won't be routed to this node. Unit: seconds.Values: 0~3600.Default value: 30.
    read_only_node_weights Sequence[InstanceEndpointReadOnlyNodeWeight]
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    read_write_mode str
    Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
    read_write_proxy_connection int
    After the terminal enables read-write separation, the number of proxy connections set for the terminal. The lower limit of the number of proxy connections is 20. The upper limit of the number of proxy connections depends on the specifications of the instance master node.
    write_node_halt_writing bool
    Whether the endpoint sends write requests to the write node (currently only the master node is a write node). Values: true: Yes(Default). false: No.
    addresses List<Property Map>
    Address list.
    autoAddNewNodes String
    When the terminal type is read-write terminal or read-only terminal, it supports setting whether new nodes are automatically added.
    description String
    Address description.
    enableReadOnly String
    Whether global read-only is enabled, value: Enable: Enable. Disable: Disabled.
    enableReadWriteSplitting String
    Whether read-write separation is enabled, value: Enable: Enable. Disable: Disabled.
    endpointId String
    Instance connection terminal ID.
    endpointName String
    The instance connection terminal name.
    endpointType String
    Terminal type: Cluster: The default terminal. (created by default) Primary: Primary node terminal. Custom: Custom terminal. Direct: Direct connection to the terminal. (Only the operation and maintenance side) AllNode: All node terminals. (Only the operation and maintenance side).
    readOnlyNodeDistributionType String
    The distribution type of the read-only nodes, value: Default: Default distribution. Custom: Custom distribution.
    readOnlyNodeMaxDelayTime Number
    Maximum latency threshold of read-only node. If the latency of a read-only node exceeds this value, reading traffic won't be routed to this node. Unit: seconds.Values: 0~3600.Default value: 30.
    readOnlyNodeWeights List<Property Map>
    The list of nodes configured by the connection terminal and the corresponding read-only weights.
    readWriteMode String
    Read and write mode: ReadWrite: read and write ReadOnly: read only (default).
    readWriteProxyConnection Number
    After the terminal enables read-write separation, the number of proxy connections set for the terminal. The lower limit of the number of proxy connections is 20. The upper limit of the number of proxy connections depends on the specifications of the instance master node.
    writeNodeHaltWriting Boolean
    Whether the endpoint sends write requests to the write node (currently only the master node is a write node). Values: true: Yes(Default). false: No.

    InstanceEndpointAddress, InstanceEndpointAddressArgs

    CrossRegionDomain string
    Address that can be accessed across regions.
    DnsVisibility bool
    Whether to enable public network resolution. Values: false: Default value. PrivateZone of Volcano Engine. true: Private and public network resolution of Volcano Engine.
    Domain string
    Connect domain name.
    DomainVisibilitySetting string
    The type of private network address. Values: LocalDomain: Local domain name. CrossRegionDomain: Domains accessible across regions.
    EipId string
    The ID of the EIP, only valid for Public addresses.
    InternetProtocol string
    Address IP protocol, IPv4 or IPv6.
    IpAddress string
    The IP Address.
    Ipv6Address string
    The IPv6 Address.
    NetworkType string
    Network address type, temporarily Private, Public, PublicService.
    Port string
    The Port.
    SubnetId string
    Subnet ID of the RDS PostgreSQL instance.
    CrossRegionDomain string
    Address that can be accessed across regions.
    DnsVisibility bool
    Whether to enable public network resolution. Values: false: Default value. PrivateZone of Volcano Engine. true: Private and public network resolution of Volcano Engine.
    Domain string
    Connect domain name.
    DomainVisibilitySetting string
    The type of private network address. Values: LocalDomain: Local domain name. CrossRegionDomain: Domains accessible across regions.
    EipId string
    The ID of the EIP, only valid for Public addresses.
    InternetProtocol string
    Address IP protocol, IPv4 or IPv6.
    IpAddress string
    The IP Address.
    Ipv6Address string
    The IPv6 Address.
    NetworkType string
    Network address type, temporarily Private, Public, PublicService.
    Port string
    The Port.
    SubnetId string
    Subnet ID of the RDS PostgreSQL instance.
    crossRegionDomain String
    Address that can be accessed across regions.
    dnsVisibility Boolean
    Whether to enable public network resolution. Values: false: Default value. PrivateZone of Volcano Engine. true: Private and public network resolution of Volcano Engine.
    domain String
    Connect domain name.
    domainVisibilitySetting String
    The type of private network address. Values: LocalDomain: Local domain name. CrossRegionDomain: Domains accessible across regions.
    eipId String
    The ID of the EIP, only valid for Public addresses.
    internetProtocol String
    Address IP protocol, IPv4 or IPv6.
    ipAddress String
    The IP Address.
    ipv6Address String
    The IPv6 Address.
    networkType String
    Network address type, temporarily Private, Public, PublicService.
    port String
    The Port.
    subnetId String
    Subnet ID of the RDS PostgreSQL instance.
    crossRegionDomain string
    Address that can be accessed across regions.
    dnsVisibility boolean
    Whether to enable public network resolution. Values: false: Default value. PrivateZone of Volcano Engine. true: Private and public network resolution of Volcano Engine.
    domain string
    Connect domain name.
    domainVisibilitySetting string
    The type of private network address. Values: LocalDomain: Local domain name. CrossRegionDomain: Domains accessible across regions.
    eipId string
    The ID of the EIP, only valid for Public addresses.
    internetProtocol string
    Address IP protocol, IPv4 or IPv6.
    ipAddress string
    The IP Address.
    ipv6Address string
    The IPv6 Address.
    networkType string
    Network address type, temporarily Private, Public, PublicService.
    port string
    The Port.
    subnetId string
    Subnet ID of the RDS PostgreSQL instance.
    cross_region_domain str
    Address that can be accessed across regions.
    dns_visibility bool
    Whether to enable public network resolution. Values: false: Default value. PrivateZone of Volcano Engine. true: Private and public network resolution of Volcano Engine.
    domain str
    Connect domain name.
    domain_visibility_setting str
    The type of private network address. Values: LocalDomain: Local domain name. CrossRegionDomain: Domains accessible across regions.
    eip_id str
    The ID of the EIP, only valid for Public addresses.
    internet_protocol str
    Address IP protocol, IPv4 or IPv6.
    ip_address str
    The IP Address.
    ipv6_address str
    The IPv6 Address.
    network_type str
    Network address type, temporarily Private, Public, PublicService.
    port str
    The Port.
    subnet_id str
    Subnet ID of the RDS PostgreSQL instance.
    crossRegionDomain String
    Address that can be accessed across regions.
    dnsVisibility Boolean
    Whether to enable public network resolution. Values: false: Default value. PrivateZone of Volcano Engine. true: Private and public network resolution of Volcano Engine.
    domain String
    Connect domain name.
    domainVisibilitySetting String
    The type of private network address. Values: LocalDomain: Local domain name. CrossRegionDomain: Domains accessible across regions.
    eipId String
    The ID of the EIP, only valid for Public addresses.
    internetProtocol String
    Address IP protocol, IPv4 or IPv6.
    ipAddress String
    The IP Address.
    ipv6Address String
    The IPv6 Address.
    networkType String
    Network address type, temporarily Private, Public, PublicService.
    port String
    The Port.
    subnetId String
    Subnet ID of the RDS PostgreSQL instance.

    InstanceEndpointReadOnlyNodeWeight, InstanceEndpointReadOnlyNodeWeightArgs

    NodeId string
    Node ID.
    NodeType string
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    Weight int
    The weight of the node.
    NodeId string
    Node ID.
    NodeType string
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    Weight int
    The weight of the node.
    nodeId String
    Node ID.
    nodeType String
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    weight Integer
    The weight of the node.
    nodeId string
    Node ID.
    nodeType string
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    weight number
    The weight of the node.
    node_id str
    Node ID.
    node_type str
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    weight int
    The weight of the node.
    nodeId String
    Node ID.
    nodeType String
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    weight Number
    The weight of the node.

    InstanceEstimationResult, InstanceEstimationResultArgs

    Effects List<string>
    After changing according to the current configuration, the estimated impact on the read and write connections of the instance.
    Plans List<string>
    Estimated impact on the instance after the current configuration changes.
    Effects []string
    After changing according to the current configuration, the estimated impact on the read and write connections of the instance.
    Plans []string
    Estimated impact on the instance after the current configuration changes.
    effects List<String>
    After changing according to the current configuration, the estimated impact on the read and write connections of the instance.
    plans List<String>
    Estimated impact on the instance after the current configuration changes.
    effects string[]
    After changing according to the current configuration, the estimated impact on the read and write connections of the instance.
    plans string[]
    Estimated impact on the instance after the current configuration changes.
    effects Sequence[str]
    After changing according to the current configuration, the estimated impact on the read and write connections of the instance.
    plans Sequence[str]
    Estimated impact on the instance after the current configuration changes.
    effects List<String>
    After changing according to the current configuration, the estimated impact on the read and write connections of the instance.
    plans List<String>
    Estimated impact on the instance after the current configuration changes.

    InstanceNode, InstanceNodeArgs

    CreateTime string
    Node creation local time.
    InstanceId string
    Instance ID.
    Memory int
    Memory size in GB.
    NodeId string
    Node ID.
    NodeSpec string
    The specification of primary node and secondary node.
    NodeStatus string
    Node state, value: aligned with instance state.
    NodeType string
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    RegionId string
    The region of the RDS PostgreSQL instance.
    UpdateTime string
    The update time of the RDS PostgreSQL instance.
    VCpu int
    CPU size.
    ZoneId string
    The available zone of the RDS PostgreSQL instance.
    CreateTime string
    Node creation local time.
    InstanceId string
    Instance ID.
    Memory int
    Memory size in GB.
    NodeId string
    Node ID.
    NodeSpec string
    The specification of primary node and secondary node.
    NodeStatus string
    Node state, value: aligned with instance state.
    NodeType string
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    RegionId string
    The region of the RDS PostgreSQL instance.
    UpdateTime string
    The update time of the RDS PostgreSQL instance.
    VCpu int
    CPU size.
    ZoneId string
    The available zone of the RDS PostgreSQL instance.
    createTime String
    Node creation local time.
    instanceId String
    Instance ID.
    memory Integer
    Memory size in GB.
    nodeId String
    Node ID.
    nodeSpec String
    The specification of primary node and secondary node.
    nodeStatus String
    Node state, value: aligned with instance state.
    nodeType String
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    regionId String
    The region of the RDS PostgreSQL instance.
    updateTime String
    The update time of the RDS PostgreSQL instance.
    vCpu Integer
    CPU size.
    zoneId String
    The available zone of the RDS PostgreSQL instance.
    createTime string
    Node creation local time.
    instanceId string
    Instance ID.
    memory number
    Memory size in GB.
    nodeId string
    Node ID.
    nodeSpec string
    The specification of primary node and secondary node.
    nodeStatus string
    Node state, value: aligned with instance state.
    nodeType string
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    regionId string
    The region of the RDS PostgreSQL instance.
    updateTime string
    The update time of the RDS PostgreSQL instance.
    vCpu number
    CPU size.
    zoneId string
    The available zone of the RDS PostgreSQL instance.
    create_time str
    Node creation local time.
    instance_id str
    Instance ID.
    memory int
    Memory size in GB.
    node_id str
    Node ID.
    node_spec str
    The specification of primary node and secondary node.
    node_status str
    Node state, value: aligned with instance state.
    node_type str
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    region_id str
    The region of the RDS PostgreSQL instance.
    update_time str
    The update time of the RDS PostgreSQL instance.
    v_cpu int
    CPU size.
    zone_id str
    The available zone of the RDS PostgreSQL instance.
    createTime String
    Node creation local time.
    instanceId String
    Instance ID.
    memory Number
    Memory size in GB.
    nodeId String
    Node ID.
    nodeSpec String
    The specification of primary node and secondary node.
    nodeStatus String
    Node state, value: aligned with instance state.
    nodeType String
    Node type. Value: Primary: Primary node. Secondary: Standby node. ReadOnly: Read-only node.
    regionId String
    The region of the RDS PostgreSQL instance.
    updateTime String
    The update time of the RDS PostgreSQL instance.
    vCpu Number
    CPU size.
    zoneId String
    The available zone of the RDS PostgreSQL instance.

    InstanceParameter, InstanceParameterArgs

    Name string
    Parameter name.
    Value string
    Parameter value.
    Name string
    Parameter name.
    Value string
    Parameter value.
    name String
    Parameter name.
    value String
    Parameter value.
    name string
    Parameter name.
    value string
    Parameter value.
    name str
    Parameter name.
    value str
    Parameter value.
    name String
    Parameter name.
    value String
    Parameter value.

    InstanceTag, InstanceTagArgs

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    InstanceZoneMigration, InstanceZoneMigrationArgs

    NodeId string
    Node ID to migrate.
    ZoneId string
    Target zone ID.
    NodeType string
    Node type: Secondary or ReadOnly.
    NodeId string
    Node ID to migrate.
    ZoneId string
    Target zone ID.
    NodeType string
    Node type: Secondary or ReadOnly.
    nodeId String
    Node ID to migrate.
    zoneId String
    Target zone ID.
    nodeType String
    Node type: Secondary or ReadOnly.
    nodeId string
    Node ID to migrate.
    zoneId string
    Target zone ID.
    nodeType string
    Node type: Secondary or ReadOnly.
    node_id str
    Node ID to migrate.
    zone_id str
    Target zone ID.
    node_type str
    Node type: Secondary or ReadOnly.
    nodeId String
    Node ID to migrate.
    zoneId String
    Target zone ID.
    nodeType String
    Node type: Secondary or ReadOnly.

    Import

    RdsPostgresqlInstance can be imported using the id, e.g.

    $ pulumi import volcengine:rds_postgresql/instance:Instance default postgres-21a3333b****

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate