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

flexibleengine.getDcsInstances

Explore with Pulumi AI

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

Example Usage

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

const test = flexibleengine.getDcsInstances({
    name: "test_name",
    status: "RUNNING",
});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

test = flexibleengine.get_dcs_instances(name="test_name",
    status="RUNNING")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := flexibleengine.GetDcsInstances(ctx, &flexibleengine.GetDcsInstancesArgs{
			Name:   pulumi.StringRef("test_name"),
			Status: pulumi.StringRef("RUNNING"),
		}, 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 test = Flexibleengine.GetDcsInstances.Invoke(new()
    {
        Name = "test_name",
        Status = "RUNNING",
    });

});
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.GetDcsInstancesArgs;
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 test = FlexibleengineFunctions.getDcsInstances(GetDcsInstancesArgs.builder()
            .name("test_name")
            .status("RUNNING")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      function: flexibleengine:getDcsInstances
      arguments:
        name: test_name
        status: RUNNING
Copy

Using getDcsInstances

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 getDcsInstances(args: GetDcsInstancesArgs, opts?: InvokeOptions): Promise<GetDcsInstancesResult>
function getDcsInstancesOutput(args: GetDcsInstancesOutputArgs, opts?: InvokeOptions): Output<GetDcsInstancesResult>
Copy
def get_dcs_instances(capacity: Optional[float] = None,
                      id: Optional[str] = None,
                      name: Optional[str] = None,
                      private_ip: Optional[str] = None,
                      region: Optional[str] = None,
                      status: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDcsInstancesResult
def get_dcs_instances_output(capacity: Optional[pulumi.Input[float]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      private_ip: Optional[pulumi.Input[str]] = None,
                      region: Optional[pulumi.Input[str]] = None,
                      status: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDcsInstancesResult]
Copy
func GetDcsInstances(ctx *Context, args *GetDcsInstancesArgs, opts ...InvokeOption) (*GetDcsInstancesResult, error)
func GetDcsInstancesOutput(ctx *Context, args *GetDcsInstancesOutputArgs, opts ...InvokeOption) GetDcsInstancesResultOutput
Copy

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

public static class GetDcsInstances 
{
    public static Task<GetDcsInstancesResult> InvokeAsync(GetDcsInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetDcsInstancesResult> Invoke(GetDcsInstancesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDcsInstancesResult> getDcsInstances(GetDcsInstancesArgs args, InvokeOptions options)
public static Output<GetDcsInstancesResult> getDcsInstances(GetDcsInstancesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: flexibleengine:index/getDcsInstances:getDcsInstances
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Capacity double
Specifies the cache capacity. Unit: GB.
Id string
Indicates the ID of the instance.
Name string
Specifies the name of an instance.
PrivateIp string
Specifies the subnet Network ID.
Region string
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
Status string
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
Capacity float64
Specifies the cache capacity. Unit: GB.
Id string
Indicates the ID of the instance.
Name string
Specifies the name of an instance.
PrivateIp string
Specifies the subnet Network ID.
Region string
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
Status string
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
capacity Double
Specifies the cache capacity. Unit: GB.
id String
Indicates the ID of the instance.
name String
Specifies the name of an instance.
privateIp String
Specifies the subnet Network ID.
region String
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
status String
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
capacity number
Specifies the cache capacity. Unit: GB.
id string
Indicates the ID of the instance.
name string
Specifies the name of an instance.
privateIp string
Specifies the subnet Network ID.
region string
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
status string
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
capacity float
Specifies the cache capacity. Unit: GB.
id str
Indicates the ID of the instance.
name str
Specifies the name of an instance.
private_ip str
Specifies the subnet Network ID.
region str
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
status str
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
capacity Number
Specifies the cache capacity. Unit: GB.
id String
Indicates the ID of the instance.
name String
Specifies the name of an instance.
privateIp String
Specifies the subnet Network ID.
region String
Specifies the region in which to query the data source. If omitted, the provider-level region will be used.
status String
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.

getDcsInstances Result

The following output properties are available:

Id string
Indicates the ID of the instance.
Instances List<GetDcsInstancesInstance>
Indicates the list of DCS instances. The Instance structure is documented below.
Region string
Capacity double
Indicates the cache capacity. Unit: GB.
Name string
Indicates the name of an instance.
PrivateIp string
Indicates the IP address of the DCS instance.
Status string
Indicates the cache instance status.
Id string
Indicates the ID of the instance.
Instances []GetDcsInstancesInstance
Indicates the list of DCS instances. The Instance structure is documented below.
Region string
Capacity float64
Indicates the cache capacity. Unit: GB.
Name string
Indicates the name of an instance.
PrivateIp string
Indicates the IP address of the DCS instance.
Status string
Indicates the cache instance status.
id String
Indicates the ID of the instance.
instances List<GetDcsInstancesInstance>
Indicates the list of DCS instances. The Instance structure is documented below.
region String
capacity Double
Indicates the cache capacity. Unit: GB.
name String
Indicates the name of an instance.
privateIp String
Indicates the IP address of the DCS instance.
status String
Indicates the cache instance status.
id string
Indicates the ID of the instance.
instances GetDcsInstancesInstance[]
Indicates the list of DCS instances. The Instance structure is documented below.
region string
capacity number
Indicates the cache capacity. Unit: GB.
name string
Indicates the name of an instance.
privateIp string
Indicates the IP address of the DCS instance.
status string
Indicates the cache instance status.
id str
Indicates the ID of the instance.
instances Sequence[GetDcsInstancesInstance]
Indicates the list of DCS instances. The Instance structure is documented below.
region str
capacity float
Indicates the cache capacity. Unit: GB.
name str
Indicates the name of an instance.
private_ip str
Indicates the IP address of the DCS instance.
status str
Indicates the cache instance status.
id String
Indicates the ID of the instance.
instances List<Property Map>
Indicates the list of DCS instances. The Instance structure is documented below.
region String
capacity Number
Indicates the cache capacity. Unit: GB.
name String
Indicates the name of an instance.
privateIp String
Indicates the IP address of the DCS instance.
status String
Indicates the cache instance status.

Supporting Types

GetDcsInstancesInstance

AccessUser This property is required. string
Indicates the username used for accessing a DCS Memcached instance.
AvailabilityZones This property is required. List<string>
Specifies the code of the AZ where the cache node resides.
Capacity This property is required. double
Specifies the cache capacity. Unit: GB.
ChargingMode This property is required. string
Description This property is required. string
Indicates the description of an instance.
DomainName This property is required. string
Indicates the domain name of the instance.
Engine This property is required. string
Indicates a cache engine.
EngineVersion This property is required. string
Indicates the version of a cache engine.
EnterpriseProjectId This property is required. string
Indicates the enterprise project id of the dcs instance.
Flavor This property is required. string
Indicates the flavor of the cache instance.
Id This property is required. string
Indicates the ID of the instance.
MaintainBegin This property is required. string
Indicates the time at which the maintenance time window starts.
MaintainEnd This property is required. string
Indicates the time at which the maintenance time window ends.
MaxMemory This property is required. double
Indicates the total memory size. Unit: MB.
Name This property is required. string
Specifies the name of an instance.
OrderId This property is required. string
Indicates the ID of the order that created the instance.
Port This property is required. double
Indicates the port of the cache instance.
PrivateIp This property is required. string
Specifies the subnet Network ID.
SecurityGroupId This property is required. string
Indicates the ID of the security group which the instance belongs to.
SecurityGroupName This property is required. string
Indicates the name of security group which the instance belongs to.
Status This property is required. string
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
SubnetId This property is required. string
Indicates the ID of subnet which the instance belongs to.
SubnetName This property is required. string
Indicates the name of subnet which the instance belongs to.
Tags This property is required. Dictionary<string, string>
Indicates The key/value pairs to associate with the DCS instance.
UsedMemory This property is required. double
Indicates the size of the used memory. Unit: MB.
VpcId This property is required. string
Indicates the ID of VPC which the instance belongs to.
VpcName This property is required. string
Indicates the name of VPC which the instance belongs to.
AccessUser This property is required. string
Indicates the username used for accessing a DCS Memcached instance.
AvailabilityZones This property is required. []string
Specifies the code of the AZ where the cache node resides.
Capacity This property is required. float64
Specifies the cache capacity. Unit: GB.
ChargingMode This property is required. string
Description This property is required. string
Indicates the description of an instance.
DomainName This property is required. string
Indicates the domain name of the instance.
Engine This property is required. string
Indicates a cache engine.
EngineVersion This property is required. string
Indicates the version of a cache engine.
EnterpriseProjectId This property is required. string
Indicates the enterprise project id of the dcs instance.
Flavor This property is required. string
Indicates the flavor of the cache instance.
Id This property is required. string
Indicates the ID of the instance.
MaintainBegin This property is required. string
Indicates the time at which the maintenance time window starts.
MaintainEnd This property is required. string
Indicates the time at which the maintenance time window ends.
MaxMemory This property is required. float64
Indicates the total memory size. Unit: MB.
Name This property is required. string
Specifies the name of an instance.
OrderId This property is required. string
Indicates the ID of the order that created the instance.
Port This property is required. float64
Indicates the port of the cache instance.
PrivateIp This property is required. string
Specifies the subnet Network ID.
SecurityGroupId This property is required. string
Indicates the ID of the security group which the instance belongs to.
SecurityGroupName This property is required. string
Indicates the name of security group which the instance belongs to.
Status This property is required. string
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
SubnetId This property is required. string
Indicates the ID of subnet which the instance belongs to.
SubnetName This property is required. string
Indicates the name of subnet which the instance belongs to.
Tags This property is required. map[string]string
Indicates The key/value pairs to associate with the DCS instance.
UsedMemory This property is required. float64
Indicates the size of the used memory. Unit: MB.
VpcId This property is required. string
Indicates the ID of VPC which the instance belongs to.
VpcName This property is required. string
Indicates the name of VPC which the instance belongs to.
accessUser This property is required. String
Indicates the username used for accessing a DCS Memcached instance.
availabilityZones This property is required. List<String>
Specifies the code of the AZ where the cache node resides.
capacity This property is required. Double
Specifies the cache capacity. Unit: GB.
chargingMode This property is required. String
description This property is required. String
Indicates the description of an instance.
domainName This property is required. String
Indicates the domain name of the instance.
engine This property is required. String
Indicates a cache engine.
engineVersion This property is required. String
Indicates the version of a cache engine.
enterpriseProjectId This property is required. String
Indicates the enterprise project id of the dcs instance.
flavor This property is required. String
Indicates the flavor of the cache instance.
id This property is required. String
Indicates the ID of the instance.
maintainBegin This property is required. String
Indicates the time at which the maintenance time window starts.
maintainEnd This property is required. String
Indicates the time at which the maintenance time window ends.
maxMemory This property is required. Double
Indicates the total memory size. Unit: MB.
name This property is required. String
Specifies the name of an instance.
orderId This property is required. String
Indicates the ID of the order that created the instance.
port This property is required. Double
Indicates the port of the cache instance.
privateIp This property is required. String
Specifies the subnet Network ID.
securityGroupId This property is required. String
Indicates the ID of the security group which the instance belongs to.
securityGroupName This property is required. String
Indicates the name of security group which the instance belongs to.
status This property is required. String
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
subnetId This property is required. String
Indicates the ID of subnet which the instance belongs to.
subnetName This property is required. String
Indicates the name of subnet which the instance belongs to.
tags This property is required. Map<String,String>
Indicates The key/value pairs to associate with the DCS instance.
usedMemory This property is required. Double
Indicates the size of the used memory. Unit: MB.
vpcId This property is required. String
Indicates the ID of VPC which the instance belongs to.
vpcName This property is required. String
Indicates the name of VPC which the instance belongs to.
accessUser This property is required. string
Indicates the username used for accessing a DCS Memcached instance.
availabilityZones This property is required. string[]
Specifies the code of the AZ where the cache node resides.
capacity This property is required. number
Specifies the cache capacity. Unit: GB.
chargingMode This property is required. string
description This property is required. string
Indicates the description of an instance.
domainName This property is required. string
Indicates the domain name of the instance.
engine This property is required. string
Indicates a cache engine.
engineVersion This property is required. string
Indicates the version of a cache engine.
enterpriseProjectId This property is required. string
Indicates the enterprise project id of the dcs instance.
flavor This property is required. string
Indicates the flavor of the cache instance.
id This property is required. string
Indicates the ID of the instance.
maintainBegin This property is required. string
Indicates the time at which the maintenance time window starts.
maintainEnd This property is required. string
Indicates the time at which the maintenance time window ends.
maxMemory This property is required. number
Indicates the total memory size. Unit: MB.
name This property is required. string
Specifies the name of an instance.
orderId This property is required. string
Indicates the ID of the order that created the instance.
port This property is required. number
Indicates the port of the cache instance.
privateIp This property is required. string
Specifies the subnet Network ID.
securityGroupId This property is required. string
Indicates the ID of the security group which the instance belongs to.
securityGroupName This property is required. string
Indicates the name of security group which the instance belongs to.
status This property is required. string
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
subnetId This property is required. string
Indicates the ID of subnet which the instance belongs to.
subnetName This property is required. string
Indicates the name of subnet which the instance belongs to.
tags This property is required. {[key: string]: string}
Indicates The key/value pairs to associate with the DCS instance.
usedMemory This property is required. number
Indicates the size of the used memory. Unit: MB.
vpcId This property is required. string
Indicates the ID of VPC which the instance belongs to.
vpcName This property is required. string
Indicates the name of VPC which the instance belongs to.
access_user This property is required. str
Indicates the username used for accessing a DCS Memcached instance.
availability_zones This property is required. Sequence[str]
Specifies the code of the AZ where the cache node resides.
capacity This property is required. float
Specifies the cache capacity. Unit: GB.
charging_mode This property is required. str
description This property is required. str
Indicates the description of an instance.
domain_name This property is required. str
Indicates the domain name of the instance.
engine This property is required. str
Indicates a cache engine.
engine_version This property is required. str
Indicates the version of a cache engine.
enterprise_project_id This property is required. str
Indicates the enterprise project id of the dcs instance.
flavor This property is required. str
Indicates the flavor of the cache instance.
id This property is required. str
Indicates the ID of the instance.
maintain_begin This property is required. str
Indicates the time at which the maintenance time window starts.
maintain_end This property is required. str
Indicates the time at which the maintenance time window ends.
max_memory This property is required. float
Indicates the total memory size. Unit: MB.
name This property is required. str
Specifies the name of an instance.
order_id This property is required. str
Indicates the ID of the order that created the instance.
port This property is required. float
Indicates the port of the cache instance.
private_ip This property is required. str
Specifies the subnet Network ID.
security_group_id This property is required. str
Indicates the ID of the security group which the instance belongs to.
security_group_name This property is required. str
Indicates the name of security group which the instance belongs to.
status This property is required. str
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
subnet_id This property is required. str
Indicates the ID of subnet which the instance belongs to.
subnet_name This property is required. str
Indicates the name of subnet which the instance belongs to.
tags This property is required. Mapping[str, str]
Indicates The key/value pairs to associate with the DCS instance.
used_memory This property is required. float
Indicates the size of the used memory. Unit: MB.
vpc_id This property is required. str
Indicates the ID of VPC which the instance belongs to.
vpc_name This property is required. str
Indicates the name of VPC which the instance belongs to.
accessUser This property is required. String
Indicates the username used for accessing a DCS Memcached instance.
availabilityZones This property is required. List<String>
Specifies the code of the AZ where the cache node resides.
capacity This property is required. Number
Specifies the cache capacity. Unit: GB.
chargingMode This property is required. String
description This property is required. String
Indicates the description of an instance.
domainName This property is required. String
Indicates the domain name of the instance.
engine This property is required. String
Indicates a cache engine.
engineVersion This property is required. String
Indicates the version of a cache engine.
enterpriseProjectId This property is required. String
Indicates the enterprise project id of the dcs instance.
flavor This property is required. String
Indicates the flavor of the cache instance.
id This property is required. String
Indicates the ID of the instance.
maintainBegin This property is required. String
Indicates the time at which the maintenance time window starts.
maintainEnd This property is required. String
Indicates the time at which the maintenance time window ends.
maxMemory This property is required. Number
Indicates the total memory size. Unit: MB.
name This property is required. String
Specifies the name of an instance.
orderId This property is required. String
Indicates the ID of the order that created the instance.
port This property is required. Number
Indicates the port of the cache instance.
privateIp This property is required. String
Specifies the subnet Network ID.
securityGroupId This property is required. String
Indicates the ID of the security group which the instance belongs to.
securityGroupName This property is required. String
Indicates the name of security group which the instance belongs to.
status This property is required. String
Specifies the cache instance status. The valid values are RUNNING, ERROR, RESTARTING, FROZEN, EXTENDING, RESTORING, FLUSHING.
subnetId This property is required. String
Indicates the ID of subnet which the instance belongs to.
subnetName This property is required. String
Indicates the name of subnet which the instance belongs to.
tags This property is required. Map<String>
Indicates The key/value pairs to associate with the DCS instance.
usedMemory This property is required. Number
Indicates the size of the used memory. Unit: MB.
vpcId This property is required. String
Indicates the ID of VPC which the instance belongs to.
vpcName This property is required. String
Indicates the name of VPC which the instance belongs to.

Package Details

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