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

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud

    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,
    });
    
    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)
    
    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
    	})
    }
    
    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,
        });
    
    });
    
    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());
    
        }
    }
    
    configuration:
      vpcId:
        type: dynamic
      subnetId:
        type: dynamic
    variables:
      test:
        fn::invoke:
          function: flexibleengine:getDdsInstances
          arguments:
            name: test_name
            mode: Sharding
            vpcId: ${vpcId}
            subnetId: ${subnetId}
    

    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>
    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]
    func GetDdsInstances(ctx *Context, args *GetDdsInstancesArgs, opts ...InvokeOption) (*GetDdsInstancesResult, error)
    func GetDdsInstancesOutput(ctx *Context, args *GetDdsInstancesOutputArgs, opts ...InvokeOption) GetDdsInstancesResultOutput

    > 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)
    }
    public static CompletableFuture<GetDdsInstancesResult> getDdsInstances(GetDdsInstancesArgs args, InvokeOptions options)
    public static Output<GetDdsInstancesResult> getDdsInstances(GetDdsInstancesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: flexibleengine:index/getDdsInstances:getDdsInstances
      arguments:
        # arguments dictionary

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

    GetDdsInstancesInstanceBackupStrategy

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

    GetDdsInstancesInstanceDatastore

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

    GetDdsInstancesInstanceNode

    Id string
    Indicates the node ID.
    Name string
    Specifies the DB instance name.
    PrivateIp string
    Indicates the private IP address of a node.
    PublicIp string
    Indicates the EIP that has been bound on a node.
    Role string
    Indicates the node role.
    Status string
    Indicates the node status.
    Type string
    Indicates the node type.
    Id string
    Indicates the node ID.
    Name string
    Specifies the DB instance name.
    PrivateIp string
    Indicates the private IP address of a node.
    PublicIp string
    Indicates the EIP that has been bound on a node.
    Role string
    Indicates the node role.
    Status string
    Indicates the node status.
    Type string
    Indicates the node type.
    id String
    Indicates the node ID.
    name String
    Specifies the DB instance name.
    privateIp String
    Indicates the private IP address of a node.
    publicIp String
    Indicates the EIP that has been bound on a node.
    role String
    Indicates the node role.
    status String
    Indicates the node status.
    type String
    Indicates the node type.
    id string
    Indicates the node ID.
    name string
    Specifies the DB instance name.
    privateIp string
    Indicates the private IP address of a node.
    publicIp string
    Indicates the EIP that has been bound on a node.
    role string
    Indicates the node role.
    status string
    Indicates the node status.
    type string
    Indicates the node type.
    id str
    Indicates the node ID.
    name str
    Specifies the DB instance name.
    private_ip str
    Indicates the private IP address of a node.
    public_ip str
    Indicates the EIP that has been bound on a node.
    role str
    Indicates the node role.
    status str
    Indicates the node status.
    type str
    Indicates the node type.
    id String
    Indicates the node ID.
    name String
    Specifies the DB instance name.
    privateIp String
    Indicates the private IP address of a node.
    publicIp String
    Indicates the EIP that has been bound on a node.
    role String
    Indicates the node role.
    status String
    Indicates the node status.
    type 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.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud