1. Packages
  2. Volcengine
  3. API Docs
  4. rds_postgresql
  5. getInstances
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine
volcengine logo
Volcengine v0.0.43 published on Friday, Jan 16, 2026 by Volcengine

    Use this data source to query detailed information of rds postgresql instances

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@pulumi/volcengine";
    import * as volcengine from "@volcengine/pulumi";
    
    const fooZones = volcengine.ecs.getZones({});
    const fooVpc = new volcengine.vpc.Vpc("fooVpc", {
        vpcName: "acc-test-project1",
        cidrBlock: "172.16.0.0/16",
    });
    const fooSubnet = new volcengine.vpc.Subnet("fooSubnet", {
        subnetName: "acc-subnet-test-2",
        cidrBlock: "172.16.0.0/24",
        zoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        vpcId: fooVpc.id,
    });
    const fooInstance = new volcengine.rds_postgresql.Instance("fooInstance", {
        dbEngineVersion: "PostgreSQL_12",
        nodeSpec: "rds.postgres.1c2g",
        primaryZoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        secondaryZoneId: fooZones.then(fooZones => fooZones.zones?.[0]?.id),
        storageSpace: 40,
        subnetId: fooSubnet.id,
        instanceName: "acc-test-1",
        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",
            },
        ],
    });
    const fooInstances = volcengine.rds_postgresql.getInstancesOutput({
        instanceId: fooInstance.id,
    });
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo_zones = volcengine.ecs.get_zones()
    foo_vpc = volcengine.vpc.Vpc("fooVpc",
        vpc_name="acc-test-project1",
        cidr_block="172.16.0.0/16")
    foo_subnet = volcengine.vpc.Subnet("fooSubnet",
        subnet_name="acc-subnet-test-2",
        cidr_block="172.16.0.0/24",
        zone_id=foo_zones.zones[0].id,
        vpc_id=foo_vpc.id)
    foo_instance = volcengine.rds_postgresql.Instance("fooInstance",
        db_engine_version="PostgreSQL_12",
        node_spec="rds.postgres.1c2g",
        primary_zone_id=foo_zones.zones[0].id,
        secondary_zone_id=foo_zones.zones[0].id,
        storage_space=40,
        subnet_id=foo_subnet.id,
        instance_name="acc-test-1",
        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",
            ),
        ])
    foo_instances = volcengine.rds_postgresql.get_instances_output(instance_id=foo_instance.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
    	"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 {
    		fooZones, err := ecs.GetZones(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		fooVpc, err := vpc.NewVpc(ctx, "fooVpc", &vpc.VpcArgs{
    			VpcName:   pulumi.String("acc-test-project1"),
    			CidrBlock: pulumi.String("172.16.0.0/16"),
    		})
    		if err != nil {
    			return err
    		}
    		fooSubnet, err := vpc.NewSubnet(ctx, "fooSubnet", &vpc.SubnetArgs{
    			SubnetName: pulumi.String("acc-subnet-test-2"),
    			CidrBlock:  pulumi.String("172.16.0.0/24"),
    			ZoneId:     pulumi.String(fooZones.Zones[0].Id),
    			VpcId:      fooVpc.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		fooInstance, err := rds_postgresql.NewInstance(ctx, "fooInstance", &rds_postgresql.InstanceArgs{
    			DbEngineVersion: pulumi.String("PostgreSQL_12"),
    			NodeSpec:        pulumi.String("rds.postgres.1c2g"),
    			PrimaryZoneId:   pulumi.String(fooZones.Zones[0].Id),
    			SecondaryZoneId: pulumi.String(fooZones.Zones[0].Id),
    			StorageSpace:    pulumi.Int(40),
    			SubnetId:        fooSubnet.ID(),
    			InstanceName:    pulumi.String("acc-test-1"),
    			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
    		}
    		_ = rds_postgresql.GetInstancesOutput(ctx, rds_postgresql.GetInstancesOutputArgs{
    			InstanceId: fooInstance.ID(),
    		}, nil)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var fooZones = Volcengine.Ecs.GetZones.Invoke();
    
        var fooVpc = new Volcengine.Vpc.Vpc("fooVpc", new()
        {
            VpcName = "acc-test-project1",
            CidrBlock = "172.16.0.0/16",
        });
    
        var fooSubnet = new Volcengine.Vpc.Subnet("fooSubnet", new()
        {
            SubnetName = "acc-subnet-test-2",
            CidrBlock = "172.16.0.0/24",
            ZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            VpcId = fooVpc.Id,
        });
    
        var fooInstance = new Volcengine.Rds_postgresql.Instance("fooInstance", new()
        {
            DbEngineVersion = "PostgreSQL_12",
            NodeSpec = "rds.postgres.1c2g",
            PrimaryZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            SecondaryZoneId = fooZones.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
            StorageSpace = 40,
            SubnetId = fooSubnet.Id,
            InstanceName = "acc-test-1",
            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",
                },
            },
        });
    
        var fooInstances = Volcengine.Rds_postgresql.GetInstances.Invoke(new()
        {
            InstanceId = fooInstance.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.ecs.EcsFunctions;
    import com.pulumi.volcengine.ecs.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.Rds_postgresqlFunctions;
    import com.pulumi.volcengine.rds_postgresql.inputs.GetInstancesArgs;
    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 = EcsFunctions.getZones();
    
            var fooVpc = new Vpc("fooVpc", VpcArgs.builder()        
                .vpcName("acc-test-project1")
                .cidrBlock("172.16.0.0/16")
                .build());
    
            var fooSubnet = new Subnet("fooSubnet", SubnetArgs.builder()        
                .subnetName("acc-subnet-test-2")
                .cidrBlock("172.16.0.0/24")
                .zoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .vpcId(fooVpc.id())
                .build());
    
            var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
                .dbEngineVersion("PostgreSQL_12")
                .nodeSpec("rds.postgres.1c2g")
                .primaryZoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .secondaryZoneId(fooZones.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
                .storageSpace(40)
                .subnetId(fooSubnet.id())
                .instanceName("acc-test-1")
                .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());
    
            final var fooInstances = Rds_postgresqlFunctions.getInstances(GetInstancesArgs.builder()
                .instanceId(fooInstance.id())
                .build());
    
        }
    }
    
    resources:
      fooVpc:
        type: volcengine:vpc:Vpc
        properties:
          vpcName: acc-test-project1
          cidrBlock: 172.16.0.0/16
      fooSubnet:
        type: volcengine:vpc:Subnet
        properties:
          subnetName: acc-subnet-test-2
          cidrBlock: 172.16.0.0/24
          zoneId: ${fooZones.zones[0].id}
          vpcId: ${fooVpc.id}
      fooInstance:
        type: volcengine:rds_postgresql:Instance
        properties:
          dbEngineVersion: PostgreSQL_12
          nodeSpec: rds.postgres.1c2g
          primaryZoneId: ${fooZones.zones[0].id}
          secondaryZoneId: ${fooZones.zones[0].id}
          storageSpace: 40
          subnetId: ${fooSubnet.id}
          instanceName: acc-test-1
          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
    variables:
      fooZones:
        fn::invoke:
          Function: volcengine:ecs:getZones
          Arguments: {}
      fooInstances:
        fn::invoke:
          Function: volcengine:rds_postgresql:getInstances
          Arguments:
            instanceId: ${fooInstance.id}
    

    Using getInstances

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
    function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>
    def get_instances(charge_type: Optional[str] = None,
                      create_time_end: Optional[str] = None,
                      create_time_start: Optional[str] = None,
                      db_engine_version: Optional[str] = None,
                      instance_id: Optional[str] = None,
                      instance_name: Optional[str] = None,
                      instance_status: Optional[str] = None,
                      name_regex: Optional[str] = None,
                      output_file: Optional[str] = None,
                      project_name: Optional[str] = None,
                      storage_type: Optional[str] = None,
                      tags: Optional[Sequence[GetInstancesTag]] = None,
                      zone_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetInstancesResult
    def get_instances_output(charge_type: Optional[pulumi.Input[str]] = None,
                      create_time_end: Optional[pulumi.Input[str]] = None,
                      create_time_start: Optional[pulumi.Input[str]] = None,
                      db_engine_version: Optional[pulumi.Input[str]] = None,
                      instance_id: Optional[pulumi.Input[str]] = None,
                      instance_name: Optional[pulumi.Input[str]] = None,
                      instance_status: Optional[pulumi.Input[str]] = None,
                      name_regex: Optional[pulumi.Input[str]] = None,
                      output_file: Optional[pulumi.Input[str]] = None,
                      project_name: Optional[pulumi.Input[str]] = None,
                      storage_type: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetInstancesTagArgs]]]] = None,
                      zone_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]
    func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
    func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput

    > Note: This function is named GetInstances in the Go SDK.

    public static class GetInstances 
    {
        public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
        public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
    public static Output<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:rds_postgresql/getInstances:getInstances
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ChargeType string
    The charge type of the RDS instance.
    CreateTimeEnd string
    The end time of creating RDS PostgreSQL instance.
    CreateTimeStart string
    The start time of creating RDS PostgreSQL instance.
    DbEngineVersion string
    The version of the RDS PostgreSQL instance.
    InstanceId string
    The id of the RDS PostgreSQL instance.
    InstanceName string
    The name of the RDS PostgreSQL instance.
    InstanceStatus string
    The status of the RDS PostgreSQL instance.
    NameRegex string
    A Name Regex of RDS instance.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of the RDS PostgreSQL instance.
    StorageType string
    The storage type of the RDS PostgreSQL instance.
    Tags List<GetInstancesTag>
    Tags.
    ZoneId string
    The available zone of the RDS PostgreSQL instance.
    ChargeType string
    The charge type of the RDS instance.
    CreateTimeEnd string
    The end time of creating RDS PostgreSQL instance.
    CreateTimeStart string
    The start time of creating RDS PostgreSQL instance.
    DbEngineVersion string
    The version of the RDS PostgreSQL instance.
    InstanceId string
    The id of the RDS PostgreSQL instance.
    InstanceName string
    The name of the RDS PostgreSQL instance.
    InstanceStatus string
    The status of the RDS PostgreSQL instance.
    NameRegex string
    A Name Regex of RDS instance.
    OutputFile string
    File name where to save data source results.
    ProjectName string
    The project name of the RDS PostgreSQL instance.
    StorageType string
    The storage type of the RDS PostgreSQL instance.
    Tags []GetInstancesTag
    Tags.
    ZoneId string
    The available zone of the RDS PostgreSQL instance.
    chargeType String
    The charge type of the RDS instance.
    createTimeEnd String
    The end time of creating RDS PostgreSQL instance.
    createTimeStart String
    The start time of creating RDS PostgreSQL instance.
    dbEngineVersion String
    The version of the RDS PostgreSQL instance.
    instanceId String
    The id of the RDS PostgreSQL instance.
    instanceName String
    The name of the RDS PostgreSQL instance.
    instanceStatus String
    The status of the RDS PostgreSQL instance.
    nameRegex String
    A Name Regex of RDS instance.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of the RDS PostgreSQL instance.
    storageType String
    The storage type of the RDS PostgreSQL instance.
    tags List<GetInstancesTag>
    Tags.
    zoneId String
    The available zone of the RDS PostgreSQL instance.
    chargeType string
    The charge type of the RDS instance.
    createTimeEnd string
    The end time of creating RDS PostgreSQL instance.
    createTimeStart string
    The start time of creating RDS PostgreSQL instance.
    dbEngineVersion string
    The version of the RDS PostgreSQL instance.
    instanceId string
    The id of the RDS PostgreSQL instance.
    instanceName string
    The name of the RDS PostgreSQL instance.
    instanceStatus string
    The status of the RDS PostgreSQL instance.
    nameRegex string
    A Name Regex of RDS instance.
    outputFile string
    File name where to save data source results.
    projectName string
    The project name of the RDS PostgreSQL instance.
    storageType string
    The storage type of the RDS PostgreSQL instance.
    tags GetInstancesTag[]
    Tags.
    zoneId string
    The available zone of the RDS PostgreSQL instance.
    charge_type str
    The charge type of the RDS instance.
    create_time_end str
    The end time of creating RDS PostgreSQL instance.
    create_time_start str
    The start time of creating RDS PostgreSQL instance.
    db_engine_version str
    The version of the RDS PostgreSQL instance.
    instance_id str
    The id of the RDS PostgreSQL instance.
    instance_name str
    The name of the RDS PostgreSQL instance.
    instance_status str
    The status of the RDS PostgreSQL instance.
    name_regex str
    A Name Regex of RDS instance.
    output_file str
    File name where to save data source results.
    project_name str
    The project name of the RDS PostgreSQL instance.
    storage_type str
    The storage type of the RDS PostgreSQL instance.
    tags Sequence[GetInstancesTag]
    Tags.
    zone_id str
    The available zone of the RDS PostgreSQL instance.
    chargeType String
    The charge type of the RDS instance.
    createTimeEnd String
    The end time of creating RDS PostgreSQL instance.
    createTimeStart String
    The start time of creating RDS PostgreSQL instance.
    dbEngineVersion String
    The version of the RDS PostgreSQL instance.
    instanceId String
    The id of the RDS PostgreSQL instance.
    instanceName String
    The name of the RDS PostgreSQL instance.
    instanceStatus String
    The status of the RDS PostgreSQL instance.
    nameRegex String
    A Name Regex of RDS instance.
    outputFile String
    File name where to save data source results.
    projectName String
    The project name of the RDS PostgreSQL instance.
    storageType String
    The storage type of the RDS PostgreSQL instance.
    tags List<Property Map>
    Tags.
    zoneId String
    The available zone of the RDS PostgreSQL instance.

    getInstances Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Instances List<GetInstancesInstance>
    The collection of query.
    TotalCount int
    The total count of RDS instance query.
    ChargeType string
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    CreateTimeEnd string
    CreateTimeStart string
    DbEngineVersion string
    The engine version of the RDS PostgreSQL instance.
    InstanceId string
    Instance ID.
    InstanceName string
    The name of the RDS PostgreSQL instance.
    InstanceStatus string
    The status of the RDS PostgreSQL instance.
    NameRegex string
    OutputFile string
    ProjectName string
    The project name of the RDS PostgreSQL instance.
    StorageType string
    Instance storage type.
    Tags List<GetInstancesTag>
    Tags.
    ZoneId string
    The available zone of the RDS PostgreSQL instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    Instances []GetInstancesInstance
    The collection of query.
    TotalCount int
    The total count of RDS instance query.
    ChargeType string
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    CreateTimeEnd string
    CreateTimeStart string
    DbEngineVersion string
    The engine version of the RDS PostgreSQL instance.
    InstanceId string
    Instance ID.
    InstanceName string
    The name of the RDS PostgreSQL instance.
    InstanceStatus string
    The status of the RDS PostgreSQL instance.
    NameRegex string
    OutputFile string
    ProjectName string
    The project name of the RDS PostgreSQL instance.
    StorageType string
    Instance storage type.
    Tags []GetInstancesTag
    Tags.
    ZoneId string
    The available zone of the RDS PostgreSQL instance.
    id String
    The provider-assigned unique ID for this managed resource.
    instances List<GetInstancesInstance>
    The collection of query.
    totalCount Integer
    The total count of RDS instance query.
    chargeType String
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    createTimeEnd String
    createTimeStart String
    dbEngineVersion String
    The engine version of the RDS PostgreSQL instance.
    instanceId String
    Instance ID.
    instanceName String
    The name of the RDS PostgreSQL instance.
    instanceStatus String
    The status of the RDS PostgreSQL instance.
    nameRegex String
    outputFile String
    projectName String
    The project name of the RDS PostgreSQL instance.
    storageType String
    Instance storage type.
    tags List<GetInstancesTag>
    Tags.
    zoneId String
    The available zone of the RDS PostgreSQL instance.
    id string
    The provider-assigned unique ID for this managed resource.
    instances GetInstancesInstance[]
    The collection of query.
    totalCount number
    The total count of RDS instance query.
    chargeType string
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    createTimeEnd string
    createTimeStart string
    dbEngineVersion string
    The engine version of the RDS PostgreSQL instance.
    instanceId string
    Instance ID.
    instanceName string
    The name of the RDS PostgreSQL instance.
    instanceStatus string
    The status of the RDS PostgreSQL instance.
    nameRegex string
    outputFile string
    projectName string
    The project name of the RDS PostgreSQL instance.
    storageType string
    Instance storage type.
    tags GetInstancesTag[]
    Tags.
    zoneId string
    The available zone of the RDS PostgreSQL instance.
    id str
    The provider-assigned unique ID for this managed resource.
    instances Sequence[GetInstancesInstance]
    The collection of query.
    total_count int
    The total count of RDS instance query.
    charge_type str
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    create_time_end str
    create_time_start str
    db_engine_version str
    The engine version of the RDS PostgreSQL instance.
    instance_id str
    Instance ID.
    instance_name str
    The name of the RDS PostgreSQL instance.
    instance_status str
    The status of the RDS PostgreSQL instance.
    name_regex str
    output_file str
    project_name str
    The project name of the RDS PostgreSQL instance.
    storage_type str
    Instance storage type.
    tags Sequence[GetInstancesTag]
    Tags.
    zone_id str
    The available zone of the RDS PostgreSQL instance.
    id String
    The provider-assigned unique ID for this managed resource.
    instances List<Property Map>
    The collection of query.
    totalCount Number
    The total count of RDS instance query.
    chargeType String
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    createTimeEnd String
    createTimeStart String
    dbEngineVersion String
    The engine version of the RDS PostgreSQL instance.
    instanceId String
    Instance ID.
    instanceName String
    The name of the RDS PostgreSQL instance.
    instanceStatus String
    The status of the RDS PostgreSQL instance.
    nameRegex String
    outputFile String
    projectName String
    The project name of the RDS PostgreSQL instance.
    storageType String
    Instance storage type.
    tags List<Property Map>
    Tags.
    zoneId String
    The available zone of the RDS PostgreSQL instance.

    Supporting Types

    GetInstancesInstance

    AllowListVersion string
    The allow list version of the RDS PostgreSQL instance.
    BackupUse int
    The instance has used backup space. Unit: GB.
    ChargeDetails List<GetInstancesInstanceChargeDetail>
    Payment methods.
    CreateTime string
    Node creation local time.
    DataSyncMode string
    Data synchronization mode.
    DbEngineVersion string
    The version of the RDS PostgreSQL instance.
    Endpoints List<GetInstancesInstanceEndpoint>
    The endpoint info of the RDS instance.
    Id string
    The ID of the RDS PostgreSQL instance.
    InstanceId string
    The id of the RDS PostgreSQL instance.
    InstanceName string
    The name of the RDS PostgreSQL instance.
    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.
    NodeSpec string
    General instance type, different from Custom instance type.
    Nodes List<GetInstancesInstanceNode>
    Instance node information.
    ProjectName string
    The project name of the RDS PostgreSQL instance.
    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.
    StorageSpace int
    Total instance storage space. Unit: GB.
    StorageTempUse int
    The instance's primary node has used temporary storage space. Unit: Byte.
    StorageType string
    The storage type of the RDS PostgreSQL instance.
    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
    The subnet ID of the RDS PostgreSQL instance.
    Tags List<GetInstancesInstanceTag>
    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.
    AllowListVersion string
    The allow list version of the RDS PostgreSQL instance.
    BackupUse int
    The instance has used backup space. Unit: GB.
    ChargeDetails []GetInstancesInstanceChargeDetail
    Payment methods.
    CreateTime string
    Node creation local time.
    DataSyncMode string
    Data synchronization mode.
    DbEngineVersion string
    The version of the RDS PostgreSQL instance.
    Endpoints []GetInstancesInstanceEndpoint
    The endpoint info of the RDS instance.
    Id string
    The ID of the RDS PostgreSQL instance.
    InstanceId string
    The id of the RDS PostgreSQL instance.
    InstanceName string
    The name of the RDS PostgreSQL instance.
    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.
    NodeSpec string
    General instance type, different from Custom instance type.
    Nodes []GetInstancesInstanceNode
    Instance node information.
    ProjectName string
    The project name of the RDS PostgreSQL instance.
    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.
    StorageSpace int
    Total instance storage space. Unit: GB.
    StorageTempUse int
    The instance's primary node has used temporary storage space. Unit: Byte.
    StorageType string
    The storage type of the RDS PostgreSQL instance.
    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
    The subnet ID of the RDS PostgreSQL instance.
    Tags []GetInstancesInstanceTag
    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.
    allowListVersion String
    The allow list version of the RDS PostgreSQL instance.
    backupUse Integer
    The instance has used backup space. Unit: GB.
    chargeDetails List<GetInstancesInstanceChargeDetail>
    Payment methods.
    createTime String
    Node creation local time.
    dataSyncMode String
    Data synchronization mode.
    dbEngineVersion String
    The version of the RDS PostgreSQL instance.
    endpoints List<GetInstancesInstanceEndpoint>
    The endpoint info of the RDS instance.
    id String
    The ID of the RDS PostgreSQL instance.
    instanceId String
    The id of the RDS PostgreSQL instance.
    instanceName String
    The name of the RDS PostgreSQL instance.
    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.
    nodeSpec String
    General instance type, different from Custom instance type.
    nodes List<GetInstancesInstanceNode>
    Instance node information.
    projectName String
    The project name of the RDS PostgreSQL instance.
    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.
    storageSpace Integer
    Total instance storage space. Unit: GB.
    storageTempUse Integer
    The instance's primary node has used temporary storage space. Unit: Byte.
    storageType String
    The storage type of the RDS PostgreSQL instance.
    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
    The subnet ID of the RDS PostgreSQL instance.
    tags List<GetInstancesInstanceTag>
    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.
    allowListVersion string
    The allow list version of the RDS PostgreSQL instance.
    backupUse number
    The instance has used backup space. Unit: GB.
    chargeDetails GetInstancesInstanceChargeDetail[]
    Payment methods.
    createTime string
    Node creation local time.
    dataSyncMode string
    Data synchronization mode.
    dbEngineVersion string
    The version of the RDS PostgreSQL instance.
    endpoints GetInstancesInstanceEndpoint[]
    The endpoint info of the RDS instance.
    id string
    The ID of the RDS PostgreSQL instance.
    instanceId string
    The id of the RDS PostgreSQL instance.
    instanceName string
    The name of the RDS PostgreSQL instance.
    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.
    nodeSpec string
    General instance type, different from Custom instance type.
    nodes GetInstancesInstanceNode[]
    Instance node information.
    projectName string
    The project name of the RDS PostgreSQL instance.
    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.
    storageSpace number
    Total instance storage space. Unit: GB.
    storageTempUse number
    The instance's primary node has used temporary storage space. Unit: Byte.
    storageType string
    The storage type of the RDS PostgreSQL instance.
    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
    The subnet ID of the RDS PostgreSQL instance.
    tags GetInstancesInstanceTag[]
    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.
    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[GetInstancesInstanceChargeDetail]
    Payment methods.
    create_time str
    Node creation local time.
    data_sync_mode str
    Data synchronization mode.
    db_engine_version str
    The version of the RDS PostgreSQL instance.
    endpoints Sequence[GetInstancesInstanceEndpoint]
    The endpoint info of the RDS instance.
    id str
    The ID of the RDS PostgreSQL instance.
    instance_id str
    The id of the RDS PostgreSQL instance.
    instance_name str
    The name of the RDS PostgreSQL instance.
    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.
    node_spec str
    General instance type, different from Custom instance type.
    nodes Sequence[GetInstancesInstanceNode]
    Instance node information.
    project_name str
    The project name of the RDS PostgreSQL instance.
    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_space int
    Total instance storage space. Unit: GB.
    storage_temp_use int
    The instance's primary node has used temporary storage space. Unit: Byte.
    storage_type str
    The storage type of the RDS PostgreSQL instance.
    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
    The subnet ID of the RDS PostgreSQL instance.
    tags Sequence[GetInstancesInstanceTag]
    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.
    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.
    dbEngineVersion String
    The version of the RDS PostgreSQL instance.
    endpoints List<Property Map>
    The endpoint info of the RDS instance.
    id String
    The ID of the RDS PostgreSQL instance.
    instanceId String
    The id of the RDS PostgreSQL instance.
    instanceName String
    The name of the RDS PostgreSQL instance.
    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.
    nodeSpec String
    General instance type, different from Custom instance type.
    nodes List<Property Map>
    Instance node information.
    projectName String
    The project name of the RDS PostgreSQL instance.
    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.
    storageSpace Number
    Total instance storage space. Unit: GB.
    storageTempUse Number
    The instance's primary node has used temporary storage space. Unit: Byte.
    storageType String
    The storage type of the RDS PostgreSQL instance.
    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
    The 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.

    GetInstancesInstanceChargeDetail

    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
    The charge type of the RDS instance.
    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
    The charge type of the RDS instance.
    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
    The charge type of the RDS instance.
    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
    The charge type of the RDS instance.
    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
    The charge type of the RDS instance.
    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
    The charge type of the RDS instance.
    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.

    GetInstancesInstanceEndpoint

    Addresses List<GetInstancesInstanceEndpointAddress>
    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<GetInstancesInstanceEndpointReadOnlyNodeWeight>
    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 []GetInstancesInstanceEndpointAddress
    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 []GetInstancesInstanceEndpointReadOnlyNodeWeight
    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<GetInstancesInstanceEndpointAddress>
    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<GetInstancesInstanceEndpointReadOnlyNodeWeight>
    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 GetInstancesInstanceEndpointAddress[]
    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 GetInstancesInstanceEndpointReadOnlyNodeWeight[]
    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[GetInstancesInstanceEndpointAddress]
    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[GetInstancesInstanceEndpointReadOnlyNodeWeight]
    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.

    GetInstancesInstanceEndpointAddress

    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
    The 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
    The 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
    The 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
    The 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
    The 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
    The subnet ID of the RDS PostgreSQL instance.

    GetInstancesInstanceEndpointReadOnlyNodeWeight

    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.

    GetInstancesInstanceNode

    CreateTime string
    Node creation local time.
    InstanceId string
    The id of the RDS PostgreSQL instance.
    Memory int
    Memory size in GB.
    NodeId string
    Node ID.
    NodeSpec string
    General instance type, different from Custom instance type.
    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
    The id of the RDS PostgreSQL instance.
    Memory int
    Memory size in GB.
    NodeId string
    Node ID.
    NodeSpec string
    General instance type, different from Custom instance type.
    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
    The id of the RDS PostgreSQL instance.
    memory Integer
    Memory size in GB.
    nodeId String
    Node ID.
    nodeSpec String
    General instance type, different from Custom instance type.
    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
    The id of the RDS PostgreSQL instance.
    memory number
    Memory size in GB.
    nodeId string
    Node ID.
    nodeSpec string
    General instance type, different from Custom instance type.
    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
    The id of the RDS PostgreSQL instance.
    memory int
    Memory size in GB.
    node_id str
    Node ID.
    node_spec str
    General instance type, different from Custom instance type.
    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
    The id of the RDS PostgreSQL instance.
    memory Number
    Memory size in GB.
    nodeId String
    Node ID.
    nodeSpec String
    General instance type, different from Custom instance type.
    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.

    GetInstancesInstanceTag

    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.

    GetInstancesTag

    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.

    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
      Meet Neo: Your AI Platform Teammate