1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. getDdsInstances
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

flexibleengine.getDdsInstances

Explore with Pulumi AI

Use this data source to get the list of DDS instances.

Example Usage

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

const config = new pulumi.Config();
const vpcId = config.requireObject("vpcId");
const subnetId = config.requireObject("subnetId");
const test = flexibleengine.getDdsInstances({
    name: "test_name",
    mode: "Sharding",
    vpcId: vpcId,
    subnetId: subnetId,
});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
vpc_id = config.require_object("vpcId")
subnet_id = config.require_object("subnetId")
test = flexibleengine.get_dds_instances(name="test_name",
    mode="Sharding",
    vpc_id=vpc_id,
    subnet_id=subnet_id)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		vpcId := cfg.RequireObject("vpcId")
		subnetId := cfg.RequireObject("subnetId")
		_, err := flexibleengine.GetDdsInstances(ctx, &flexibleengine.GetDdsInstancesArgs{
			Name:     pulumi.StringRef("test_name"),
			Mode:     pulumi.StringRef("Sharding"),
			VpcId:    pulumi.StringRef(vpcId),
			SubnetId: pulumi.StringRef(subnetId),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var vpcId = config.RequireObject<dynamic>("vpcId");
    var subnetId = config.RequireObject<dynamic>("subnetId");
    var test = Flexibleengine.GetDdsInstances.Invoke(new()
    {
        Name = "test_name",
        Mode = "Sharding",
        VpcId = vpcId,
        SubnetId = subnetId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.FlexibleengineFunctions;
import com.pulumi.flexibleengine.inputs.GetDdsInstancesArgs;
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 config = ctx.config();
        final var vpcId = config.get("vpcId");
        final var subnetId = config.get("subnetId");
        final var test = FlexibleengineFunctions.getDdsInstances(GetDdsInstancesArgs.builder()
            .name("test_name")
            .mode("Sharding")
            .vpcId(vpcId)
            .subnetId(subnetId)
            .build());

    }
}
Copy
configuration:
  vpcId:
    type: dynamic
  subnetId:
    type: dynamic
variables:
  test:
    fn::invoke:
      function: flexibleengine:getDdsInstances
      arguments:
        name: test_name
        mode: Sharding
        vpcId: ${vpcId}
        subnetId: ${subnetId}
Copy

Using getDdsInstances

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 getDdsInstances(args: GetDdsInstancesArgs, opts?: InvokeOptions): Promise<GetDdsInstancesResult>
function getDdsInstancesOutput(args: GetDdsInstancesOutputArgs, opts?: InvokeOptions): Output<GetDdsInstancesResult>
Copy
def get_dds_instances(id: Optional[str] = None,
                      mode: Optional[str] = None,
                      name: Optional[str] = None,
                      region: Optional[str] = None,
                      subnet_id: Optional[str] = None,
                      vpc_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDdsInstancesResult
def get_dds_instances_output(id: Optional[pulumi.Input[str]] = None,
                      mode: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      region: Optional[pulumi.Input[str]] = None,
                      subnet_id: Optional[pulumi.Input[str]] = None,
                      vpc_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDdsInstancesResult]
Copy
func GetDdsInstances(ctx *Context, args *GetDdsInstancesArgs, opts ...InvokeOption) (*GetDdsInstancesResult, error)
func GetDdsInstancesOutput(ctx *Context, args *GetDdsInstancesOutputArgs, opts ...InvokeOption) GetDdsInstancesResultOutput
Copy

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

public static class GetDdsInstances 
{
    public static Task<GetDdsInstancesResult> InvokeAsync(GetDdsInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetDdsInstancesResult> Invoke(GetDdsInstancesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDdsInstancesResult> getDdsInstances(GetDdsInstancesArgs args, InvokeOptions options)
public static Output<GetDdsInstancesResult> getDdsInstances(GetDdsInstancesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: flexibleengine:index/getDdsInstances:getDdsInstances
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
Indicates the node ID.
Mode string
Specifies the mode of the database instance.
Name string
Specifies the DB instance name.
Region string
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
SubnetId string
Specifies the subnet Network ID.
VpcId string
Specifies the VPC ID.
Id string
Indicates the node ID.
Mode string
Specifies the mode of the database instance.
Name string
Specifies the DB instance name.
Region string
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
SubnetId string
Specifies the subnet Network ID.
VpcId string
Specifies the VPC ID.
id String
Indicates the node ID.
mode String
Specifies the mode of the database instance.
name String
Specifies the DB instance name.
region String
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
subnetId String
Specifies the subnet Network ID.
vpcId String
Specifies the VPC ID.
id string
Indicates the node ID.
mode string
Specifies the mode of the database instance.
name string
Specifies the DB instance name.
region string
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
subnetId string
Specifies the subnet Network ID.
vpcId string
Specifies the VPC ID.
id str
Indicates the node ID.
mode str
Specifies the mode of the database instance.
name str
Specifies the DB instance name.
region str
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
subnet_id str
Specifies the subnet Network ID.
vpc_id str
Specifies the VPC ID.
id String
Indicates the node ID.
mode String
Specifies the mode of the database instance.
name String
Specifies the DB instance name.
region String
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
subnetId String
Specifies the subnet Network ID.
vpcId String
Specifies the VPC ID.

getDdsInstances Result

The following output properties are available:

Id string
Indicates the node ID.
Instances List<GetDdsInstancesInstance>
Indicates the list of DDS instances. The instances object structure is documented below.
Region string
Mode string
Specifies the mode of the database instance.
Name string
Indicates the node name.
SubnetId string
Indicates the subnet Network ID.
VpcId string
Indicates the VPC ID.
Id string
Indicates the node ID.
Instances []GetDdsInstancesInstance
Indicates the list of DDS instances. The instances object structure is documented below.
Region string
Mode string
Specifies the mode of the database instance.
Name string
Indicates the node name.
SubnetId string
Indicates the subnet Network ID.
VpcId string
Indicates the VPC ID.
id String
Indicates the node ID.
instances List<GetDdsInstancesInstance>
Indicates the list of DDS instances. The instances object structure is documented below.
region String
mode String
Specifies the mode of the database instance.
name String
Indicates the node name.
subnetId String
Indicates the subnet Network ID.
vpcId String
Indicates the VPC ID.
id string
Indicates the node ID.
instances GetDdsInstancesInstance[]
Indicates the list of DDS instances. The instances object structure is documented below.
region string
mode string
Specifies the mode of the database instance.
name string
Indicates the node name.
subnetId string
Indicates the subnet Network ID.
vpcId string
Indicates the VPC ID.
id str
Indicates the node ID.
instances Sequence[GetDdsInstancesInstance]
Indicates the list of DDS instances. The instances object structure is documented below.
region str
mode str
Specifies the mode of the database instance.
name str
Indicates the node name.
subnet_id str
Indicates the subnet Network ID.
vpc_id str
Indicates the VPC ID.
id String
Indicates the node ID.
instances List<Property Map>
Indicates the list of DDS instances. The instances object structure is documented below.
region String
mode String
Specifies the mode of the database instance.
name String
Indicates the node name.
subnetId String
Indicates the subnet Network ID.
vpcId String
Indicates the VPC ID.

Supporting Types

GetDdsInstancesInstance

BackupStrategies This property is required. List<GetDdsInstancesInstanceBackupStrategy>
Indicates backup strategy. The backup_strategy object structure is documented below.
Datastores This property is required. List<GetDdsInstancesInstanceDatastore>
Indicates database information. The datastore object structure is documented below.
DbUsername This property is required. string
Indicates the DB Administrator name.
DiskEncryptionId This property is required. string
Indicates the disk encryption ID of the instance.
EnterpriseProjectId This property is required. string
Indicates the enterprise project id of the dds instance.
Id This property is required. string
Indicates the node ID.
Mode This property is required. string
Specifies the mode of the database instance.
Name This property is required. string
Specifies the DB instance name.
Nodes This property is required. List<GetDdsInstancesInstanceNode>
Indicates the instance nodes information. The nodes object structure is documented below.
Port This property is required. double
Indicates the database port number. The port range is 2100 to 9500.
SecurityGroupId This property is required. string
Indicates the security group ID of the DDS instance.
Ssl This property is required. bool
Indicates whether to enable or disable SSL.
Status This property is required. string
Indicates the node status.
SubnetId This property is required. string
Specifies the subnet Network ID.
Tags This property is required. Dictionary<string, string>
Indicates the key/value pairs to associate with the DDS instance.
VpcId This property is required. string
Specifies the VPC ID.
BackupStrategies This property is required. []GetDdsInstancesInstanceBackupStrategy
Indicates backup strategy. The backup_strategy object structure is documented below.
Datastores This property is required. []GetDdsInstancesInstanceDatastore
Indicates database information. The datastore object structure is documented below.
DbUsername This property is required. string
Indicates the DB Administrator name.
DiskEncryptionId This property is required. string
Indicates the disk encryption ID of the instance.
EnterpriseProjectId This property is required. string
Indicates the enterprise project id of the dds instance.
Id This property is required. string
Indicates the node ID.
Mode This property is required. string
Specifies the mode of the database instance.
Name This property is required. string
Specifies the DB instance name.
Nodes This property is required. []GetDdsInstancesInstanceNode
Indicates the instance nodes information. The nodes object structure is documented below.
Port This property is required. float64
Indicates the database port number. The port range is 2100 to 9500.
SecurityGroupId This property is required. string
Indicates the security group ID of the DDS instance.
Ssl This property is required. bool
Indicates whether to enable or disable SSL.
Status This property is required. string
Indicates the node status.
SubnetId This property is required. string
Specifies the subnet Network ID.
Tags This property is required. map[string]string
Indicates the key/value pairs to associate with the DDS instance.
VpcId This property is required. string
Specifies the VPC ID.
backupStrategies This property is required. List<GetDdsInstancesInstanceBackupStrategy>
Indicates backup strategy. The backup_strategy object structure is documented below.
datastores This property is required. List<GetDdsInstancesInstanceDatastore>
Indicates database information. The datastore object structure is documented below.
dbUsername This property is required. String
Indicates the DB Administrator name.
diskEncryptionId This property is required. String
Indicates the disk encryption ID of the instance.
enterpriseProjectId This property is required. String
Indicates the enterprise project id of the dds instance.
id This property is required. String
Indicates the node ID.
mode This property is required. String
Specifies the mode of the database instance.
name This property is required. String
Specifies the DB instance name.
nodes This property is required. List<GetDdsInstancesInstanceNode>
Indicates the instance nodes information. The nodes object structure is documented below.
port This property is required. Double
Indicates the database port number. The port range is 2100 to 9500.
securityGroupId This property is required. String
Indicates the security group ID of the DDS instance.
ssl This property is required. Boolean
Indicates whether to enable or disable SSL.
status This property is required. String
Indicates the node status.
subnetId This property is required. String
Specifies the subnet Network ID.
tags This property is required. Map<String,String>
Indicates the key/value pairs to associate with the DDS instance.
vpcId This property is required. String
Specifies the VPC ID.
backupStrategies This property is required. GetDdsInstancesInstanceBackupStrategy[]
Indicates backup strategy. The backup_strategy object structure is documented below.
datastores This property is required. GetDdsInstancesInstanceDatastore[]
Indicates database information. The datastore object structure is documented below.
dbUsername This property is required. string
Indicates the DB Administrator name.
diskEncryptionId This property is required. string
Indicates the disk encryption ID of the instance.
enterpriseProjectId This property is required. string
Indicates the enterprise project id of the dds instance.
id This property is required. string
Indicates the node ID.
mode This property is required. string
Specifies the mode of the database instance.
name This property is required. string
Specifies the DB instance name.
nodes This property is required. GetDdsInstancesInstanceNode[]
Indicates the instance nodes information. The nodes object structure is documented below.
port This property is required. number
Indicates the database port number. The port range is 2100 to 9500.
securityGroupId This property is required. string
Indicates the security group ID of the DDS instance.
ssl This property is required. boolean
Indicates whether to enable or disable SSL.
status This property is required. string
Indicates the node status.
subnetId This property is required. string
Specifies the subnet Network ID.
tags This property is required. {[key: string]: string}
Indicates the key/value pairs to associate with the DDS instance.
vpcId This property is required. string
Specifies the VPC ID.
backup_strategies This property is required. Sequence[GetDdsInstancesInstanceBackupStrategy]
Indicates backup strategy. The backup_strategy object structure is documented below.
datastores This property is required. Sequence[GetDdsInstancesInstanceDatastore]
Indicates database information. The datastore object structure is documented below.
db_username This property is required. str
Indicates the DB Administrator name.
disk_encryption_id This property is required. str
Indicates the disk encryption ID of the instance.
enterprise_project_id This property is required. str
Indicates the enterprise project id of the dds instance.
id This property is required. str
Indicates the node ID.
mode This property is required. str
Specifies the mode of the database instance.
name This property is required. str
Specifies the DB instance name.
nodes This property is required. Sequence[GetDdsInstancesInstanceNode]
Indicates the instance nodes information. The nodes object structure is documented below.
port This property is required. float
Indicates the database port number. The port range is 2100 to 9500.
security_group_id This property is required. str
Indicates the security group ID of the DDS instance.
ssl This property is required. bool
Indicates whether to enable or disable SSL.
status This property is required. str
Indicates the node status.
subnet_id This property is required. str
Specifies the subnet Network ID.
tags This property is required. Mapping[str, str]
Indicates the key/value pairs to associate with the DDS instance.
vpc_id This property is required. str
Specifies the VPC ID.
backupStrategies This property is required. List<Property Map>
Indicates backup strategy. The backup_strategy object structure is documented below.
datastores This property is required. List<Property Map>
Indicates database information. The datastore object structure is documented below.
dbUsername This property is required. String
Indicates the DB Administrator name.
diskEncryptionId This property is required. String
Indicates the disk encryption ID of the instance.
enterpriseProjectId This property is required. String
Indicates the enterprise project id of the dds instance.
id This property is required. String
Indicates the node ID.
mode This property is required. String
Specifies the mode of the database instance.
name This property is required. String
Specifies the DB instance name.
nodes This property is required. List<Property Map>
Indicates the instance nodes information. The nodes object structure is documented below.
port This property is required. Number
Indicates the database port number. The port range is 2100 to 9500.
securityGroupId This property is required. String
Indicates the security group ID of the DDS instance.
ssl This property is required. Boolean
Indicates whether to enable or disable SSL.
status This property is required. String
Indicates the node status.
subnetId This property is required. String
Specifies the subnet Network ID.
tags This property is required. Map<String>
Indicates the key/value pairs to associate with the DDS instance.
vpcId This property is required. String
Specifies the VPC ID.

GetDdsInstancesInstanceBackupStrategy

KeepDays This property is required. double
Indicates the number of days to retain the generated backup files.
StartTime This property is required. string
Indicates the backup time window.
KeepDays This property is required. float64
Indicates the number of days to retain the generated backup files.
StartTime This property is required. string
Indicates the backup time window.
keepDays This property is required. Double
Indicates the number of days to retain the generated backup files.
startTime This property is required. String
Indicates the backup time window.
keepDays This property is required. number
Indicates the number of days to retain the generated backup files.
startTime This property is required. string
Indicates the backup time window.
keep_days This property is required. float
Indicates the number of days to retain the generated backup files.
start_time This property is required. str
Indicates the backup time window.
keepDays This property is required. Number
Indicates the number of days to retain the generated backup files.
startTime This property is required. String
Indicates the backup time window.

GetDdsInstancesInstanceDatastore

StorageEngine This property is required. string
Indicates the storage engine of the DB instance.
Type This property is required. string
Indicates the node type.
Version This property is required. string
Indicates the DB instance version.
StorageEngine This property is required. string
Indicates the storage engine of the DB instance.
Type This property is required. string
Indicates the node type.
Version This property is required. string
Indicates the DB instance version.
storageEngine This property is required. String
Indicates the storage engine of the DB instance.
type This property is required. String
Indicates the node type.
version This property is required. String
Indicates the DB instance version.
storageEngine This property is required. string
Indicates the storage engine of the DB instance.
type This property is required. string
Indicates the node type.
version This property is required. string
Indicates the DB instance version.
storage_engine This property is required. str
Indicates the storage engine of the DB instance.
type This property is required. str
Indicates the node type.
version This property is required. str
Indicates the DB instance version.
storageEngine This property is required. String
Indicates the storage engine of the DB instance.
type This property is required. String
Indicates the node type.
version This property is required. String
Indicates the DB instance version.

GetDdsInstancesInstanceNode

Id This property is required. string
Indicates the node ID.
Name This property is required. string
Specifies the DB instance name.
PrivateIp This property is required. string
Indicates the private IP address of a node.
PublicIp This property is required. string
Indicates the EIP that has been bound on a node.
Role This property is required. string
Indicates the node role.
Status This property is required. string
Indicates the node status.
Type This property is required. string
Indicates the node type.
Id This property is required. string
Indicates the node ID.
Name This property is required. string
Specifies the DB instance name.
PrivateIp This property is required. string
Indicates the private IP address of a node.
PublicIp This property is required. string
Indicates the EIP that has been bound on a node.
Role This property is required. string
Indicates the node role.
Status This property is required. string
Indicates the node status.
Type This property is required. string
Indicates the node type.
id This property is required. String
Indicates the node ID.
name This property is required. String
Specifies the DB instance name.
privateIp This property is required. String
Indicates the private IP address of a node.
publicIp This property is required. String
Indicates the EIP that has been bound on a node.
role This property is required. String
Indicates the node role.
status This property is required. String
Indicates the node status.
type This property is required. String
Indicates the node type.
id This property is required. string
Indicates the node ID.
name This property is required. string
Specifies the DB instance name.
privateIp This property is required. string
Indicates the private IP address of a node.
publicIp This property is required. string
Indicates the EIP that has been bound on a node.
role This property is required. string
Indicates the node role.
status This property is required. string
Indicates the node status.
type This property is required. string
Indicates the node type.
id This property is required. str
Indicates the node ID.
name This property is required. str
Specifies the DB instance name.
private_ip This property is required. str
Indicates the private IP address of a node.
public_ip This property is required. str
Indicates the EIP that has been bound on a node.
role This property is required. str
Indicates the node role.
status This property is required. str
Indicates the node status.
type This property is required. str
Indicates the node type.
id This property is required. String
Indicates the node ID.
name This property is required. String
Specifies the DB instance name.
privateIp This property is required. String
Indicates the private IP address of a node.
publicIp This property is required. String
Indicates the EIP that has been bound on a node.
role This property is required. String
Indicates the node role.
status This property is required. String
Indicates the node status.
type This property is required. String
Indicates the node type.

Package Details

Repository
flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
License
Notes
This Pulumi package is based on the flexibleengine Terraform Provider.