1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. gpdb
  5. getInstances
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.gpdb.getInstances

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

This data source provides the AnalyticDB for PostgreSQL instances of the current Alibaba Cloud user.

NOTE: Available in 1.47.0+

Example Usage

Basic Usage

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

const ids = alicloud.gpdb.getInstances({});
export const gpdbDbInstanceId1 = ids.then(ids => ids.instances?.[0]?.id);
Copy
import pulumi
import pulumi_alicloud as alicloud

ids = alicloud.gpdb.get_instances()
pulumi.export("gpdbDbInstanceId1", ids.instances[0].id)
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/gpdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		ids, err := gpdb.GetInstances(ctx, &gpdb.GetInstancesArgs{}, nil)
		if err != nil {
			return err
		}
		ctx.Export("gpdbDbInstanceId1", ids.Instances[0].Id)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var ids = AliCloud.Gpdb.GetInstances.Invoke();

    return new Dictionary<string, object?>
    {
        ["gpdbDbInstanceId1"] = ids.Apply(getInstancesResult => getInstancesResult.Instances[0]?.Id),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.gpdb.GpdbFunctions;
import com.pulumi.alicloud.gpdb.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 ids = GpdbFunctions.getInstances();

        ctx.export("gpdbDbInstanceId1", ids.applyValue(getInstancesResult -> getInstancesResult.instances()[0].id()));
    }
}
Copy
variables:
  ids:
    fn::invoke:
      function: alicloud:gpdb:getInstances
      arguments: {}
outputs:
  gpdbDbInstanceId1: ${ids.instances[0].id}
Copy

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>
Copy
def get_instances(availability_zone: Optional[str] = None,
                  db_instance_categories: Optional[str] = None,
                  db_instance_modes: Optional[str] = None,
                  description: Optional[str] = None,
                  enable_details: Optional[bool] = None,
                  ids: Optional[Sequence[str]] = None,
                  instance_network_type: Optional[str] = None,
                  name_regex: Optional[str] = None,
                  output_file: Optional[str] = None,
                  resource_group_id: Optional[str] = None,
                  status: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None,
                  vswitch_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetInstancesResult
def get_instances_output(availability_zone: Optional[pulumi.Input[str]] = None,
                  db_instance_categories: Optional[pulumi.Input[str]] = None,
                  db_instance_modes: Optional[pulumi.Input[str]] = None,
                  description: Optional[pulumi.Input[str]] = None,
                  enable_details: Optional[pulumi.Input[bool]] = None,
                  ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  instance_network_type: Optional[pulumi.Input[str]] = None,
                  name_regex: Optional[pulumi.Input[str]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  resource_group_id: Optional[pulumi.Input[str]] = None,
                  status: Optional[pulumi.Input[str]] = None,
                  tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                  vswitch_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]
Copy
func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
public static Output<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: alicloud:gpdb/getInstances:getInstances
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AvailabilityZone string
Instance availability zone.
DbInstanceCategories Changes to this property will trigger replacement. string
The db instance categories.
DbInstanceModes Changes to this property will trigger replacement. string
The db instance modes.
Description string
The description of the instance.
EnableDetails bool
Default to false. Set it to true can output more details about resource attributes.
Ids Changes to this property will trigger replacement. List<string>
The ids list of AnalyticDB for PostgreSQL instances.
InstanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance.
NameRegex string
A regex string to apply to the instance name.
OutputFile string
File name where to save data source results (after running pulumi preview).
ResourceGroupId Changes to this property will trigger replacement. string
The ID of the enterprise resource group to which the instance belongs.
Status Changes to this property will trigger replacement. string
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
Tags Dictionary<string, string>
VswitchId string
Used to retrieve instances belong to specified vswitch resources.
AvailabilityZone string
Instance availability zone.
DbInstanceCategories Changes to this property will trigger replacement. string
The db instance categories.
DbInstanceModes Changes to this property will trigger replacement. string
The db instance modes.
Description string
The description of the instance.
EnableDetails bool
Default to false. Set it to true can output more details about resource attributes.
Ids Changes to this property will trigger replacement. []string
The ids list of AnalyticDB for PostgreSQL instances.
InstanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance.
NameRegex string
A regex string to apply to the instance name.
OutputFile string
File name where to save data source results (after running pulumi preview).
ResourceGroupId Changes to this property will trigger replacement. string
The ID of the enterprise resource group to which the instance belongs.
Status Changes to this property will trigger replacement. string
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
Tags map[string]string
VswitchId string
Used to retrieve instances belong to specified vswitch resources.
availabilityZone String
Instance availability zone.
dbInstanceCategories Changes to this property will trigger replacement. String
The db instance categories.
dbInstanceModes Changes to this property will trigger replacement. String
The db instance modes.
description String
The description of the instance.
enableDetails Boolean
Default to false. Set it to true can output more details about resource attributes.
ids Changes to this property will trigger replacement. List<String>
The ids list of AnalyticDB for PostgreSQL instances.
instanceNetworkType Changes to this property will trigger replacement. String
The network type of the instance.
nameRegex String
A regex string to apply to the instance name.
outputFile String
File name where to save data source results (after running pulumi preview).
resourceGroupId Changes to this property will trigger replacement. String
The ID of the enterprise resource group to which the instance belongs.
status Changes to this property will trigger replacement. String
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
tags Map<String,String>
vswitchId String
Used to retrieve instances belong to specified vswitch resources.
availabilityZone string
Instance availability zone.
dbInstanceCategories Changes to this property will trigger replacement. string
The db instance categories.
dbInstanceModes Changes to this property will trigger replacement. string
The db instance modes.
description string
The description of the instance.
enableDetails boolean
Default to false. Set it to true can output more details about resource attributes.
ids Changes to this property will trigger replacement. string[]
The ids list of AnalyticDB for PostgreSQL instances.
instanceNetworkType Changes to this property will trigger replacement. string
The network type of the instance.
nameRegex string
A regex string to apply to the instance name.
outputFile string
File name where to save data source results (after running pulumi preview).
resourceGroupId Changes to this property will trigger replacement. string
The ID of the enterprise resource group to which the instance belongs.
status Changes to this property will trigger replacement. string
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
tags {[key: string]: string}
vswitchId string
Used to retrieve instances belong to specified vswitch resources.
availability_zone str
Instance availability zone.
db_instance_categories Changes to this property will trigger replacement. str
The db instance categories.
db_instance_modes Changes to this property will trigger replacement. str
The db instance modes.
description str
The description of the instance.
enable_details bool
Default to false. Set it to true can output more details about resource attributes.
ids Changes to this property will trigger replacement. Sequence[str]
The ids list of AnalyticDB for PostgreSQL instances.
instance_network_type Changes to this property will trigger replacement. str
The network type of the instance.
name_regex str
A regex string to apply to the instance name.
output_file str
File name where to save data source results (after running pulumi preview).
resource_group_id Changes to this property will trigger replacement. str
The ID of the enterprise resource group to which the instance belongs.
status Changes to this property will trigger replacement. str
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
tags Mapping[str, str]
vswitch_id str
Used to retrieve instances belong to specified vswitch resources.
availabilityZone String
Instance availability zone.
dbInstanceCategories Changes to this property will trigger replacement. String
The db instance categories.
dbInstanceModes Changes to this property will trigger replacement. String
The db instance modes.
description String
The description of the instance.
enableDetails Boolean
Default to false. Set it to true can output more details about resource attributes.
ids Changes to this property will trigger replacement. List<String>
The ids list of AnalyticDB for PostgreSQL instances.
instanceNetworkType Changes to this property will trigger replacement. String
The network type of the instance.
nameRegex String
A regex string to apply to the instance name.
outputFile String
File name where to save data source results (after running pulumi preview).
resourceGroupId Changes to this property will trigger replacement. String
The ID of the enterprise resource group to which the instance belongs.
status Changes to this property will trigger replacement. String
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
tags Map<String>
vswitchId String
Used to retrieve instances belong to specified vswitch resources.

getInstances Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Ids List<string>
Instances List<Pulumi.AliCloud.Gpdb.Outputs.GetInstancesInstance>
Names List<string>
AvailabilityZone string
DbInstanceCategories string
DbInstanceModes string
Description string
EnableDetails bool
InstanceNetworkType string
NameRegex string
OutputFile string
ResourceGroupId string
Status string
Tags Dictionary<string, string>
VswitchId string
Id string
The provider-assigned unique ID for this managed resource.
Ids []string
Instances []GetInstancesInstance
Names []string
AvailabilityZone string
DbInstanceCategories string
DbInstanceModes string
Description string
EnableDetails bool
InstanceNetworkType string
NameRegex string
OutputFile string
ResourceGroupId string
Status string
Tags map[string]string
VswitchId string
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
instances List<GetInstancesInstance>
names List<String>
availabilityZone String
dbInstanceCategories String
dbInstanceModes String
description String
enableDetails Boolean
instanceNetworkType String
nameRegex String
outputFile String
resourceGroupId String
status String
tags Map<String,String>
vswitchId String
id string
The provider-assigned unique ID for this managed resource.
ids string[]
instances GetInstancesInstance[]
names string[]
availabilityZone string
dbInstanceCategories string
dbInstanceModes string
description string
enableDetails boolean
instanceNetworkType string
nameRegex string
outputFile string
resourceGroupId string
status string
tags {[key: string]: string}
vswitchId string
id str
The provider-assigned unique ID for this managed resource.
ids Sequence[str]
instances Sequence[GetInstancesInstance]
names Sequence[str]
availability_zone str
db_instance_categories str
db_instance_modes str
description str
enable_details bool
instance_network_type str
name_regex str
output_file str
resource_group_id str
status str
tags Mapping[str, str]
vswitch_id str
id String
The provider-assigned unique ID for this managed resource.
ids List<String>
instances List<Property Map>
names List<String>
availabilityZone String
dbInstanceCategories String
dbInstanceModes String
description String
enableDetails Boolean
instanceNetworkType String
nameRegex String
outputFile String
resourceGroupId String
status String
tags Map<String>
vswitchId String

Supporting Types

GetInstancesInstance

AvailabilityZone This property is required. string
Instance availability zone.
ChargeType This property is required. string
ConnectionString This property is required. string
The connection string of the instance.
CpuCores This property is required. string
The number of CPU cores of the computing node. Unit: Core.
CreateTime This property is required. string
The time when the instance was created. The time is in the YYYY-MM-DDThh:mm:ssZ format, such as 2011-05-30T12:11:4Z.
CreationTime This property is required. string
DbInstanceCategory This property is required. string
The db instance category. Valid values: HighAvailability, Basic.
DbInstanceClass This property is required. string
The db instance class.
DbInstanceId This property is required. string
The db instance id.
DbInstanceMode This property is required. string
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
Description This property is required. string
The description of the instance.
Engine This property is required. string
The database engine used by the instance.
EngineVersion This property is required. string
The version of the database engine used by the instance.
Id This property is required. string
The ID of the db Instance.
InstanceNetworkType This property is required. string
The network type of the instance.
IpWhitelists This property is required. List<Pulumi.AliCloud.Gpdb.Inputs.GetInstancesInstanceIpWhitelist>
The ip whitelist.
MaintainEndTime This property is required. string
The end time of the maintenance window for the instance.
MaintainStartTime This property is required. string
The start time of the maintenance window for the instance.
MasterNodeNum This property is required. string
The number of Master nodes. Valid values: 1 to 2. if it is not filled in, the default value is 1 Master node.
MemorySize This property is required. string
The memory size of the compute node.
PaymentType This property is required. string
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
RegionId This property is required. string
Region ID the instance belongs to.
SegNodeNum This property is required. string
Calculate the number of nodes. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.
Status This property is required. string
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
StorageSize This property is required. int
The storage capacity. Unit: GB. Value: 50 to 4000.
StorageType This property is required. string
The type of disks. Valid values: cloud_essd, cloud_efficiency.
Tags This property is required. Dictionary<string, string>
The tags of the instance.
VpcId This property is required. string
The ID of the VPC。.
VswitchId This property is required. string
The vswitch id.
ZoneId This property is required. string
The zone ID of the instance.
AvailabilityZone This property is required. string
Instance availability zone.
ChargeType This property is required. string
ConnectionString This property is required. string
The connection string of the instance.
CpuCores This property is required. string
The number of CPU cores of the computing node. Unit: Core.
CreateTime This property is required. string
The time when the instance was created. The time is in the YYYY-MM-DDThh:mm:ssZ format, such as 2011-05-30T12:11:4Z.
CreationTime This property is required. string
DbInstanceCategory This property is required. string
The db instance category. Valid values: HighAvailability, Basic.
DbInstanceClass This property is required. string
The db instance class.
DbInstanceId This property is required. string
The db instance id.
DbInstanceMode This property is required. string
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
Description This property is required. string
The description of the instance.
Engine This property is required. string
The database engine used by the instance.
EngineVersion This property is required. string
The version of the database engine used by the instance.
Id This property is required. string
The ID of the db Instance.
InstanceNetworkType This property is required. string
The network type of the instance.
IpWhitelists This property is required. []GetInstancesInstanceIpWhitelist
The ip whitelist.
MaintainEndTime This property is required. string
The end time of the maintenance window for the instance.
MaintainStartTime This property is required. string
The start time of the maintenance window for the instance.
MasterNodeNum This property is required. string
The number of Master nodes. Valid values: 1 to 2. if it is not filled in, the default value is 1 Master node.
MemorySize This property is required. string
The memory size of the compute node.
PaymentType This property is required. string
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
RegionId This property is required. string
Region ID the instance belongs to.
SegNodeNum This property is required. string
Calculate the number of nodes. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.
Status This property is required. string
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
StorageSize This property is required. int
The storage capacity. Unit: GB. Value: 50 to 4000.
StorageType This property is required. string
The type of disks. Valid values: cloud_essd, cloud_efficiency.
Tags This property is required. map[string]string
The tags of the instance.
VpcId This property is required. string
The ID of the VPC。.
VswitchId This property is required. string
The vswitch id.
ZoneId This property is required. string
The zone ID of the instance.
availabilityZone This property is required. String
Instance availability zone.
chargeType This property is required. String
connectionString This property is required. String
The connection string of the instance.
cpuCores This property is required. String
The number of CPU cores of the computing node. Unit: Core.
createTime This property is required. String
The time when the instance was created. The time is in the YYYY-MM-DDThh:mm:ssZ format, such as 2011-05-30T12:11:4Z.
creationTime This property is required. String
dbInstanceCategory This property is required. String
The db instance category. Valid values: HighAvailability, Basic.
dbInstanceClass This property is required. String
The db instance class.
dbInstanceId This property is required. String
The db instance id.
dbInstanceMode This property is required. String
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
description This property is required. String
The description of the instance.
engine This property is required. String
The database engine used by the instance.
engineVersion This property is required. String
The version of the database engine used by the instance.
id This property is required. String
The ID of the db Instance.
instanceNetworkType This property is required. String
The network type of the instance.
ipWhitelists This property is required. List<GetInstancesInstanceIpWhitelist>
The ip whitelist.
maintainEndTime This property is required. String
The end time of the maintenance window for the instance.
maintainStartTime This property is required. String
The start time of the maintenance window for the instance.
masterNodeNum This property is required. String
The number of Master nodes. Valid values: 1 to 2. if it is not filled in, the default value is 1 Master node.
memorySize This property is required. String
The memory size of the compute node.
paymentType This property is required. String
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
regionId This property is required. String
Region ID the instance belongs to.
segNodeNum This property is required. String
Calculate the number of nodes. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.
status This property is required. String
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
storageSize This property is required. Integer
The storage capacity. Unit: GB. Value: 50 to 4000.
storageType This property is required. String
The type of disks. Valid values: cloud_essd, cloud_efficiency.
tags This property is required. Map<String,String>
The tags of the instance.
vpcId This property is required. String
The ID of the VPC。.
vswitchId This property is required. String
The vswitch id.
zoneId This property is required. String
The zone ID of the instance.
availabilityZone This property is required. string
Instance availability zone.
chargeType This property is required. string
connectionString This property is required. string
The connection string of the instance.
cpuCores This property is required. string
The number of CPU cores of the computing node. Unit: Core.
createTime This property is required. string
The time when the instance was created. The time is in the YYYY-MM-DDThh:mm:ssZ format, such as 2011-05-30T12:11:4Z.
creationTime This property is required. string
dbInstanceCategory This property is required. string
The db instance category. Valid values: HighAvailability, Basic.
dbInstanceClass This property is required. string
The db instance class.
dbInstanceId This property is required. string
The db instance id.
dbInstanceMode This property is required. string
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
description This property is required. string
The description of the instance.
engine This property is required. string
The database engine used by the instance.
engineVersion This property is required. string
The version of the database engine used by the instance.
id This property is required. string
The ID of the db Instance.
instanceNetworkType This property is required. string
The network type of the instance.
ipWhitelists This property is required. GetInstancesInstanceIpWhitelist[]
The ip whitelist.
maintainEndTime This property is required. string
The end time of the maintenance window for the instance.
maintainStartTime This property is required. string
The start time of the maintenance window for the instance.
masterNodeNum This property is required. string
The number of Master nodes. Valid values: 1 to 2. if it is not filled in, the default value is 1 Master node.
memorySize This property is required. string
The memory size of the compute node.
paymentType This property is required. string
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
regionId This property is required. string
Region ID the instance belongs to.
segNodeNum This property is required. string
Calculate the number of nodes. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.
status This property is required. string
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
storageSize This property is required. number
The storage capacity. Unit: GB. Value: 50 to 4000.
storageType This property is required. string
The type of disks. Valid values: cloud_essd, cloud_efficiency.
tags This property is required. {[key: string]: string}
The tags of the instance.
vpcId This property is required. string
The ID of the VPC。.
vswitchId This property is required. string
The vswitch id.
zoneId This property is required. string
The zone ID of the instance.
availability_zone This property is required. str
Instance availability zone.
charge_type This property is required. str
connection_string This property is required. str
The connection string of the instance.
cpu_cores This property is required. str
The number of CPU cores of the computing node. Unit: Core.
create_time This property is required. str
The time when the instance was created. The time is in the YYYY-MM-DDThh:mm:ssZ format, such as 2011-05-30T12:11:4Z.
creation_time This property is required. str
db_instance_category This property is required. str
The db instance category. Valid values: HighAvailability, Basic.
db_instance_class This property is required. str
The db instance class.
db_instance_id This property is required. str
The db instance id.
db_instance_mode This property is required. str
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
description This property is required. str
The description of the instance.
engine This property is required. str
The database engine used by the instance.
engine_version This property is required. str
The version of the database engine used by the instance.
id This property is required. str
The ID of the db Instance.
instance_network_type This property is required. str
The network type of the instance.
ip_whitelists This property is required. Sequence[GetInstancesInstanceIpWhitelist]
The ip whitelist.
maintain_end_time This property is required. str
The end time of the maintenance window for the instance.
maintain_start_time This property is required. str
The start time of the maintenance window for the instance.
master_node_num This property is required. str
The number of Master nodes. Valid values: 1 to 2. if it is not filled in, the default value is 1 Master node.
memory_size This property is required. str
The memory size of the compute node.
payment_type This property is required. str
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
region_id This property is required. str
Region ID the instance belongs to.
seg_node_num This property is required. str
Calculate the number of nodes. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.
status This property is required. str
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
storage_size This property is required. int
The storage capacity. Unit: GB. Value: 50 to 4000.
storage_type This property is required. str
The type of disks. Valid values: cloud_essd, cloud_efficiency.
tags This property is required. Mapping[str, str]
The tags of the instance.
vpc_id This property is required. str
The ID of the VPC。.
vswitch_id This property is required. str
The vswitch id.
zone_id This property is required. str
The zone ID of the instance.
availabilityZone This property is required. String
Instance availability zone.
chargeType This property is required. String
connectionString This property is required. String
The connection string of the instance.
cpuCores This property is required. String
The number of CPU cores of the computing node. Unit: Core.
createTime This property is required. String
The time when the instance was created. The time is in the YYYY-MM-DDThh:mm:ssZ format, such as 2011-05-30T12:11:4Z.
creationTime This property is required. String
dbInstanceCategory This property is required. String
The db instance category. Valid values: HighAvailability, Basic.
dbInstanceClass This property is required. String
The db instance class.
dbInstanceId This property is required. String
The db instance id.
dbInstanceMode This property is required. String
The db instance mode. Valid values: StorageElastic, Serverless, Classic.
description This property is required. String
The description of the instance.
engine This property is required. String
The database engine used by the instance.
engineVersion This property is required. String
The version of the database engine used by the instance.
id This property is required. String
The ID of the db Instance.
instanceNetworkType This property is required. String
The network type of the instance.
ipWhitelists This property is required. List<Property Map>
The ip whitelist.
maintainEndTime This property is required. String
The end time of the maintenance window for the instance.
maintainStartTime This property is required. String
The start time of the maintenance window for the instance.
masterNodeNum This property is required. String
The number of Master nodes. Valid values: 1 to 2. if it is not filled in, the default value is 1 Master node.
memorySize This property is required. String
The memory size of the compute node.
paymentType This property is required. String
The billing method of the instance. Valid values: Subscription, PayAsYouGo.
regionId This property is required. String
Region ID the instance belongs to.
segNodeNum This property is required. String
Calculate the number of nodes. The value range of the high-availability version of the storage elastic mode is 4 to 512, and the value must be a multiple of 4. The value range of the basic version of the storage elastic mode is 2 to 512, and the value must be a multiple of 2. The-Serverless version has a value range of 2 to 512. The value must be a multiple of 2.
status This property is required. String
The status of the instance. Valid values: Creating, DBInstanceClassChanging, DBInstanceNetTypeChanging, Deleting, EngineVersionUpgrading, GuardDBInstanceCreating, GuardSwitching, Importing, ImportingFromOtherInstance, Rebooting, Restoring, Running, Transfering, TransferingToOtherInstance.
storageSize This property is required. Number
The storage capacity. Unit: GB. Value: 50 to 4000.
storageType This property is required. String
The type of disks. Valid values: cloud_essd, cloud_efficiency.
tags This property is required. Map<String>
The tags of the instance.
vpcId This property is required. String
The ID of the VPC。.
vswitchId This property is required. String
The vswitch id.
zoneId This property is required. String
The zone ID of the instance.

GetInstancesInstanceIpWhitelist

IpGroupAttribute This property is required. string
The value of this parameter is empty by default. The attribute of the whitelist group. The console does not display the whitelist group whose value of this parameter is hidden.
IpGroupName This property is required. string
IP whitelist group name
SecurityIpList This property is required. string
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
IpGroupAttribute This property is required. string
The value of this parameter is empty by default. The attribute of the whitelist group. The console does not display the whitelist group whose value of this parameter is hidden.
IpGroupName This property is required. string
IP whitelist group name
SecurityIpList This property is required. string
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ipGroupAttribute This property is required. String
The value of this parameter is empty by default. The attribute of the whitelist group. The console does not display the whitelist group whose value of this parameter is hidden.
ipGroupName This property is required. String
IP whitelist group name
securityIpList This property is required. String
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ipGroupAttribute This property is required. string
The value of this parameter is empty by default. The attribute of the whitelist group. The console does not display the whitelist group whose value of this parameter is hidden.
ipGroupName This property is required. string
IP whitelist group name
securityIpList This property is required. string
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ip_group_attribute This property is required. str
The value of this parameter is empty by default. The attribute of the whitelist group. The console does not display the whitelist group whose value of this parameter is hidden.
ip_group_name This property is required. str
IP whitelist group name
security_ip_list This property is required. str
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].
ipGroupAttribute This property is required. String
The value of this parameter is empty by default. The attribute of the whitelist group. The console does not display the whitelist group whose value of this parameter is hidden.
ipGroupName This property is required. String
IP whitelist group name
securityIpList This property is required. String
List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). System default to ["127.0.0.1"].

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi