Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. getDcsInstances
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.getDcsInstances

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

    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",
});

    import pulumi
import pulumi_flexibleengine as flexibleengine

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

    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
	})
}

    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",
    });

});

    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());

    }
}

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

    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>
    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]
    func GetDcsInstances(ctx *Context, args *GetDcsInstancesArgs, opts ...InvokeOption) (*GetDcsInstancesResult, error)
func GetDcsInstancesOutput(ctx *Context, args *GetDcsInstancesOutputArgs, opts ...InvokeOption) GetDcsInstancesResultOutput

    > 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)
}
    public static CompletableFuture<GetDcsInstancesResult> getDcsInstances(GetDcsInstancesArgs args, InvokeOptions options)
public static Output<GetDcsInstancesResult> getDcsInstances(GetDcsInstancesArgs args, InvokeOptions options)

    fn::invoke:
  function: flexibleengine:index/getDcsInstances:getDcsInstances
  arguments:
    # arguments dictionary

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