Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. rds_postgresql
  5. Instance
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
volcengine/pulumi-volcengine

volcengine.rds_postgresql.Instance

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.27 published on Tuesday, Dec 10, 2024 by Volcengine
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.ecs.Zones({});
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",
        },
    ],
});

    import pulumi
import pulumi_volcengine as volcengine

foo_zones = volcengine.ecs.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",
        ),
    ])

    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.Zones(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
		}
		_, 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
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var fooZones = Volcengine.Ecs.Zones.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(zonesResult => zonesResult.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(zonesResult => zonesResult.Zones[0]?.Id),
        SecondaryZoneId = fooZones.Apply(zonesResult => zonesResult.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",
            },
        },
    });

});

    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.ZonesArgs;
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 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.Zones();

        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(zonesResult -> zonesResult.zones()[0].id()))
            .vpcId(fooVpc.id())
            .build());

        var fooInstance = new Instance("fooInstance", InstanceArgs.builder()        
            .dbEngineVersion("PostgreSQL_12")
            .nodeSpec("rds.postgres.1c2g")
            .primaryZoneId(fooZones.applyValue(zonesResult -> zonesResult.zones()[0].id()))
            .secondaryZoneId(fooZones.applyValue(zonesResult -> zonesResult.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());

    }
}

    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:Zones
      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,
             charge_info: Optional[InstanceChargeInfoArgs] = None,
             db_engine_version: Optional[str] = None,
             node_spec: Optional[str] = None,
             primary_zone_id: Optional[str] = None,
             secondary_zone_id: Optional[str] = None,
             subnet_id: Optional[str] = None,
             instance_name: Optional[str] = None,
             parameters: Optional[Sequence[InstanceParameterArgs]] = None,
             project_name: Optional[str] = None,
             storage_space: Optional[int] = None,
             tags: Optional[Sequence[InstanceTagArgs]] = 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()
{
    ChargeInfo = new Volcengine.Rds_postgresql.Inputs.InstanceChargeInfoArgs
    {
        ChargeType = "string",
        AutoRenew = false,
        Period = 0,
        PeriodUnit = "string",
    },
    DbEngineVersion = "string",
    NodeSpec = "string",
    PrimaryZoneId = "string",
    SecondaryZoneId = "string",
    SubnetId = "string",
    InstanceName = "string",
    Parameters = new[]
    {
        new Volcengine.Rds_postgresql.Inputs.InstanceParameterArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    ProjectName = "string",
    StorageSpace = 0,
    Tags = new[]
    {
        new Volcengine.Rds_postgresql.Inputs.InstanceTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := rds_postgresql.NewInstance(ctx, "exampleinstanceResourceResourceFromRds_postgresqlinstance", &rds_postgresql.InstanceArgs{
	ChargeInfo: &rds_postgresql.InstanceChargeInfoArgs{
		ChargeType: pulumi.String("string"),
		AutoRenew:  pulumi.Bool(false),
		Period:     pulumi.Int(0),
		PeriodUnit: pulumi.String("string"),
	},
	DbEngineVersion: pulumi.String("string"),
	NodeSpec:        pulumi.String("string"),
	PrimaryZoneId:   pulumi.String("string"),
	SecondaryZoneId: pulumi.String("string"),
	SubnetId:        pulumi.String("string"),
	InstanceName:    pulumi.String("string"),
	Parameters: rds_postgresql.InstanceParameterArray{
		&rds_postgresql.InstanceParameterArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	ProjectName:  pulumi.String("string"),
	StorageSpace: pulumi.Int(0),
	Tags: rds_postgresql.InstanceTagArray{
		&rds_postgresql.InstanceTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

    var exampleinstanceResourceResourceFromRds_postgresqlinstance = new Instance("exampleinstanceResourceResourceFromRds_postgresqlinstance", InstanceArgs.builder()
    .chargeInfo(InstanceChargeInfoArgs.builder()
        .chargeType("string")
        .autoRenew(false)
        .period(0)
        .periodUnit("string")
        .build())
    .dbEngineVersion("string")
    .nodeSpec("string")
    .primaryZoneId("string")
    .secondaryZoneId("string")
    .subnetId("string")
    .instanceName("string")
    .parameters(InstanceParameterArgs.builder()
        .name("string")
        .value("string")
        .build())
    .projectName("string")
    .storageSpace(0)
    .tags(InstanceTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    exampleinstance_resource_resource_from_rds_postgresqlinstance = volcengine.rds_postgresql.Instance("exampleinstanceResourceResourceFromRds_postgresqlinstance",
    charge_info={
        "charge_type": "string",
        "auto_renew": False,
        "period": 0,
        "period_unit": "string",
    },
    db_engine_version="string",
    node_spec="string",
    primary_zone_id="string",
    secondary_zone_id="string",
    subnet_id="string",
    instance_name="string",
    parameters=[{
        "name": "string",
        "value": "string",
    }],
    project_name="string",
    storage_space=0,
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const exampleinstanceResourceResourceFromRds_postgresqlinstance = new volcengine.rds_postgresql.Instance("exampleinstanceResourceResourceFromRds_postgresqlinstance", {
    chargeInfo: {
        chargeType: "string",
        autoRenew: false,
        period: 0,
        periodUnit: "string",
    },
    dbEngineVersion: "string",
    nodeSpec: "string",
    primaryZoneId: "string",
    secondaryZoneId: "string",
    subnetId: "string",
    instanceName: "string",
    parameters: [{
        name: "string",
        value: "string",
    }],
    projectName: "string",
    storageSpace: 0,
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: volcengine:rds_postgresql:Instance
properties:
    chargeInfo:
        autoRenew: false
        chargeType: string
        period: 0
        periodUnit: string
    dbEngineVersion: string
    instanceName: string
    nodeSpec: string
    parameters:
        - name: string
          value: string
    primaryZoneId: string
    projectName: string
    secondaryZoneId: string
    storageSpace: 0
    subnetId: string
    tags:
        - key: string
          value: 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.
    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.
    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.
    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.
    StorageSpace int
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    Tags List<InstanceTag>
    Tags.
    ChargeInfo InstanceChargeInfoArgs
    Payment methods.
    DbEngineVersion string
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13.
    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.
    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.
    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.
    StorageSpace int
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    Tags []InstanceTagArgs
    Tags.
    chargeInfo InstanceChargeInfo
    Payment methods.
    dbEngineVersion String
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13.
    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.
    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.
    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.
    storageSpace Integer
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    tags List<InstanceTag>
    Tags.
    chargeInfo InstanceChargeInfo
    Payment methods.
    dbEngineVersion string
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13.
    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.
    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.
    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.
    storageSpace number
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    tags InstanceTag[]
    Tags.
    charge_info InstanceChargeInfoArgs
    Payment methods.
    db_engine_version str
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13.
    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.
    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.
    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.
    storage_space int
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    tags Sequence[InstanceTagArgs]
    Tags.
    chargeInfo Property Map
    Payment methods.
    dbEngineVersion String
    Instance type. Value: PostgreSQL_11, PostgreSQL_12, PostgreSQL_13.
    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.
    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.
    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.
    storageSpace Number
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    tags List<Property Map>
    Tags.

    Outputs

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

    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.
    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.
    StorageType string
    Instance storage type.
    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.
    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.
    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.
    StorageType string
    Instance storage type.
    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.
    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.
    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.
    storageType String
    Instance storage type.
    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.
    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.
    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.
    storageType string
    Instance storage type.
    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.
    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.
    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_type str
    Instance storage type.
    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.
    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.
    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.
    storageType String
    Instance storage type.
    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,
        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,
        instance_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_status: Optional[str] = None,
        instance_type: Optional[str] = None,
        memory: Optional[int] = 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,
        secondary_zone_id: Optional[str] = None,
        storage_space: Optional[int] = None,
        storage_type: Optional[str] = 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) -> 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:
    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.
    Endpoints List<InstanceEndpoint>
    The endpoint info of the RDS instance.
    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.
    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.
    SecondaryZoneId string
    The available zone of secondary node.
    StorageSpace int
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    StorageType string
    Instance storage type.
    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.
    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.
    Endpoints []InstanceEndpointArgs
    The endpoint info of the RDS instance.
    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.
    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.
    SecondaryZoneId string
    The available zone of secondary node.
    StorageSpace int
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    StorageType string
    Instance storage type.
    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.
    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.
    endpoints List<InstanceEndpoint>
    The endpoint info of the RDS instance.
    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.
    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.
    secondaryZoneId String
    The available zone of secondary node.
    storageSpace Integer
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    storageType String
    Instance storage type.
    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.
    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.
    endpoints InstanceEndpoint[]
    The endpoint info of the RDS instance.
    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.
    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.
    secondaryZoneId string
    The available zone of secondary node.
    storageSpace number
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    storageType string
    Instance storage type.
    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.
    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.
    endpoints Sequence[InstanceEndpointArgs]
    The endpoint info of the RDS instance.
    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.
    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.
    secondary_zone_id str
    The available zone of secondary node.
    storage_space int
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    storage_type str
    Instance storage type.
    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.
    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.
    endpoints List<Property Map>
    The endpoint info of the RDS instance.
    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.
    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.
    secondaryZoneId String
    The available zone of secondary node.
    storageSpace Number
    Instance storage space. Value range: [20, 3000], unit: GB, increments every 100GB. Default value: 100.
    storageType String
    Instance storage type.
    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.

    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 .
    ChargeType string
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    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 .
    ChargeType string
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    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 .
    chargeType String
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    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 .
    chargeType string
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    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 .
    charge_type str
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    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 .
    chargeType String
    Payment type. Value: PostPaid - Pay-As-You-Go PrePaid - Yearly and monthly (default).
    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.
    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.
    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.
    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.
    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.
    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.
    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).
    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).
    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).
    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).
    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).
    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).
    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).
    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).
    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_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).
    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).
    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).

    InstanceEndpointAddress, InstanceEndpointAddressArgs

    DnsVisibility bool
    DNS Visibility.
    Domain string
    Connect domain name.
    EipId string
    The ID of the EIP, only valid for Public addresses.
    IpAddress string
    The IP Address.
    NetworkType string
    Network address type, temporarily Private, Public, PublicService.
    Port string
    The Port.
    SubnetId string
    Subnet ID of the RDS PostgreSQL instance.
    DnsVisibility bool
    DNS Visibility.
    Domain string
    Connect domain name.
    EipId string
    The ID of the EIP, only valid for Public addresses.
    IpAddress string
    The IP Address.
    NetworkType string
    Network address type, temporarily Private, Public, PublicService.
    Port string
    The Port.
    SubnetId string
    Subnet ID of the RDS PostgreSQL instance.
    dnsVisibility Boolean
    DNS Visibility.
    domain String
    Connect domain name.
    eipId String
    The ID of the EIP, only valid for Public addresses.
    ipAddress String
    The IP Address.
    networkType String
    Network address type, temporarily Private, Public, PublicService.
    port String
    The Port.
    subnetId String
    Subnet ID of the RDS PostgreSQL instance.
    dnsVisibility boolean
    DNS Visibility.
    domain string
    Connect domain name.
    eipId string
    The ID of the EIP, only valid for Public addresses.
    ipAddress string
    The IP Address.
    networkType string
    Network address type, temporarily Private, Public, PublicService.
    port string
    The Port.
    subnetId string
    Subnet ID of the RDS PostgreSQL instance.
    dns_visibility bool
    DNS Visibility.
    domain str
    Connect domain name.
    eip_id str
    The ID of the EIP, only valid for Public addresses.
    ip_address str
    The IP 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.
    dnsVisibility Boolean
    DNS Visibility.
    domain String
    Connect domain name.
    eipId String
    The ID of the EIP, only valid for Public addresses.
    ipAddress String
    The IP 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.

    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.

    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.27 published on Tuesday, Dec 10, 2024 by Volcengine
    volcengine/pulumi-volcengine