1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. drds
  5. getInstances
Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi

alicloud.drds.getInstances

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi

    The alicloud.drds.Instance data source provides a collection of DRDS instances available in Alibaba Cloud account. Filters support regular expression for the instance name, searches by tags, and other filters which are listed below.

    NOTE: Available in 1.35.0+.

    Using getInstances

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getInstances(args: GetInstancesArgs, opts?: InvokeOptions): Promise<GetInstancesResult>
    function getInstancesOutput(args: GetInstancesOutputArgs, opts?: InvokeOptions): Output<GetInstancesResult>
    def get_instances(description_regex: Optional[str] = None,
                      ids: Optional[Sequence[str]] = None,
                      name_regex: Optional[str] = None,
                      output_file: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetInstancesResult
    def get_instances_output(description_regex: Optional[pulumi.Input[str]] = None,
                      ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      name_regex: Optional[pulumi.Input[str]] = None,
                      output_file: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetInstancesResult]
    func GetInstances(ctx *Context, args *GetInstancesArgs, opts ...InvokeOption) (*GetInstancesResult, error)
    func GetInstancesOutput(ctx *Context, args *GetInstancesOutputArgs, opts ...InvokeOption) GetInstancesResultOutput

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

    public static class GetInstances 
    {
        public static Task<GetInstancesResult> InvokeAsync(GetInstancesArgs args, InvokeOptions? opts = null)
        public static Output<GetInstancesResult> Invoke(GetInstancesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInstancesResult> getInstances(GetInstancesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: alicloud:drds/getInstances:getInstances
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DescriptionRegex string

    A regex string to filter results by instance description.

    Ids List<string>

    A list of DRDS instance IDs.

    NameRegex string

    A regex string to filter results by instance description. It is deprecated since v1.91.0 and will be removed in a future release, please use 'description_regex' instead.

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    OutputFile string
    DescriptionRegex string

    A regex string to filter results by instance description.

    Ids []string

    A list of DRDS instance IDs.

    NameRegex string

    A regex string to filter results by instance description. It is deprecated since v1.91.0 and will be removed in a future release, please use 'description_regex' instead.

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    OutputFile string
    descriptionRegex String

    A regex string to filter results by instance description.

    ids List<String>

    A list of DRDS instance IDs.

    nameRegex String

    A regex string to filter results by instance description. It is deprecated since v1.91.0 and will be removed in a future release, please use 'description_regex' instead.

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    outputFile String
    descriptionRegex string

    A regex string to filter results by instance description.

    ids string[]

    A list of DRDS instance IDs.

    nameRegex string

    A regex string to filter results by instance description. It is deprecated since v1.91.0 and will be removed in a future release, please use 'description_regex' instead.

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    outputFile string
    description_regex str

    A regex string to filter results by instance description.

    ids Sequence[str]

    A list of DRDS instance IDs.

    name_regex str

    A regex string to filter results by instance description. It is deprecated since v1.91.0 and will be removed in a future release, please use 'description_regex' instead.

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    output_file str
    descriptionRegex String

    A regex string to filter results by instance description.

    ids List<String>

    A list of DRDS instance IDs.

    nameRegex String

    A regex string to filter results by instance description. It is deprecated since v1.91.0 and will be removed in a future release, please use 'description_regex' instead.

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    outputFile String

    getInstances Result

    The following output properties are available:

    Descriptions List<string>

    A list of DRDS descriptions.

    Id string

    The provider-assigned unique ID for this managed resource.

    Ids List<string>

    A list of DRDS instance IDs.

    Instances List<Pulumi.AliCloud.Drds.Outputs.GetInstancesInstance>

    A list of DRDS instances.

    DescriptionRegex string
    NameRegex string

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    OutputFile string
    Descriptions []string

    A list of DRDS descriptions.

    Id string

    The provider-assigned unique ID for this managed resource.

    Ids []string

    A list of DRDS instance IDs.

    Instances []GetInstancesInstance

    A list of DRDS instances.

    DescriptionRegex string
    NameRegex string

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    OutputFile string
    descriptions List<String>

    A list of DRDS descriptions.

    id String

    The provider-assigned unique ID for this managed resource.

    ids List<String>

    A list of DRDS instance IDs.

    instances List<GetInstancesInstance>

    A list of DRDS instances.

    descriptionRegex String
    nameRegex String

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    outputFile String
    descriptions string[]

    A list of DRDS descriptions.

    id string

    The provider-assigned unique ID for this managed resource.

    ids string[]

    A list of DRDS instance IDs.

    instances GetInstancesInstance[]

    A list of DRDS instances.

    descriptionRegex string
    nameRegex string

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    outputFile string
    descriptions Sequence[str]

    A list of DRDS descriptions.

    id str

    The provider-assigned unique ID for this managed resource.

    ids Sequence[str]

    A list of DRDS instance IDs.

    instances Sequence[GetInstancesInstance]

    A list of DRDS instances.

    description_regex str
    name_regex str

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    output_file str
    descriptions List<String>

    A list of DRDS descriptions.

    id String

    The provider-assigned unique ID for this managed resource.

    ids List<String>

    A list of DRDS instance IDs.

    instances List<Property Map>

    A list of DRDS instances.

    descriptionRegex String
    nameRegex String

    Deprecated:

    Field 'name_regex' is deprecated and will be removed in a future release. Please use 'description_regex' instead.

    outputFile String

    Supporting Types

    GetInstancesInstance

    ConnectionString string

    (Available in 1.196.0+) The connection string of the DRDS instance.

    CreateTime int

    Creation time of the instance.

    Description string

    The DRDS instance description.

    Id string

    The ID of the DRDS instance.

    NetworkType string

    Classic for public classic network or VPC for private network.

    Port string

    (Available in 1.196.0+) The connection port of the DRDS instance.

    Status string

    Status of the instance.

    Type string

    The DRDS Instance type.

    Version int

    The DRDS Instance version.

    ZoneId string

    Zone ID the instance belongs to.

    ConnectionString string

    (Available in 1.196.0+) The connection string of the DRDS instance.

    CreateTime int

    Creation time of the instance.

    Description string

    The DRDS instance description.

    Id string

    The ID of the DRDS instance.

    NetworkType string

    Classic for public classic network or VPC for private network.

    Port string

    (Available in 1.196.0+) The connection port of the DRDS instance.

    Status string

    Status of the instance.

    Type string

    The DRDS Instance type.

    Version int

    The DRDS Instance version.

    ZoneId string

    Zone ID the instance belongs to.

    connectionString String

    (Available in 1.196.0+) The connection string of the DRDS instance.

    createTime Integer

    Creation time of the instance.

    description String

    The DRDS instance description.

    id String

    The ID of the DRDS instance.

    networkType String

    Classic for public classic network or VPC for private network.

    port String

    (Available in 1.196.0+) The connection port of the DRDS instance.

    status String

    Status of the instance.

    type String

    The DRDS Instance type.

    version Integer

    The DRDS Instance version.

    zoneId String

    Zone ID the instance belongs to.

    connectionString string

    (Available in 1.196.0+) The connection string of the DRDS instance.

    createTime number

    Creation time of the instance.

    description string

    The DRDS instance description.

    id string

    The ID of the DRDS instance.

    networkType string

    Classic for public classic network or VPC for private network.

    port string

    (Available in 1.196.0+) The connection port of the DRDS instance.

    status string

    Status of the instance.

    type string

    The DRDS Instance type.

    version number

    The DRDS Instance version.

    zoneId string

    Zone ID the instance belongs to.

    connection_string str

    (Available in 1.196.0+) The connection string of the DRDS instance.

    create_time int

    Creation time of the instance.

    description str

    The DRDS instance description.

    id str

    The ID of the DRDS instance.

    network_type str

    Classic for public classic network or VPC for private network.

    port str

    (Available in 1.196.0+) The connection port of the DRDS instance.

    status str

    Status of the instance.

    type str

    The DRDS Instance type.

    version int

    The DRDS Instance version.

    zone_id str

    Zone ID the instance belongs to.

    connectionString String

    (Available in 1.196.0+) The connection string of the DRDS instance.

    createTime Number

    Creation time of the instance.

    description String

    The DRDS instance description.

    id String

    The ID of the DRDS instance.

    networkType String

    Classic for public classic network or VPC for private network.

    port String

    (Available in 1.196.0+) The connection port of the DRDS instance.

    status String

    Status of the instance.

    type String

    The DRDS Instance type.

    version Number

    The DRDS Instance version.

    zoneId String

    Zone ID the instance belongs to.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the alicloud Terraform Provider.

    alicloud logo
    Alibaba Cloud v3.43.1 published on Monday, Sep 11, 2023 by Pulumi