1. Packages
  2. Civo
  3. API Docs
  4. getInstances
Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi

civo.getInstances

Explore with Pulumi AI

civo logo
Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi

    Get information on instances for use in other resources, with the ability to filter and sort the results. If no filters are specified, all instances will be returned.

    Note: You can use the civo.Instance data source to obtain metadata about a single instance if you already know the id, unique hostname, or unique tag to retrieve.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as civo from "@pulumi/civo";
    
    const small-size = civo.getInstances({
        region: "LON1",
        filters: [{
            key: "size",
            values: [small],
        }],
    });
    
    import pulumi
    import pulumi_civo as civo
    
    small_size = civo.get_instances(region="LON1",
        filters=[civo.GetInstancesFilterArgs(
            key="size",
            values=[small],
        )])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-civo/sdk/v2/go/civo"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
    _, err := civo.GetInstances(ctx, &civo.GetInstancesArgs{
    Region: pulumi.StringRef("LON1"),
    Filters: []civo.GetInstancesFilter{
    {
    Key: "size",
    Values: interface{}{
    small,
    },
    },
    },
    }, nil);
    if err != nil {
    return err
    }
    return nil
    })
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Civo = Pulumi.Civo;
    
    return await Deployment.RunAsync(() => 
    {
        var small_size = Civo.GetInstances.Invoke(new()
        {
            Region = "LON1",
            Filters = new[]
            {
                new Civo.Inputs.GetInstancesFilterInputArgs
                {
                    Key = "size",
                    Values = new[]
                    {
                        small,
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.civo.CivoFunctions;
    import com.pulumi.civo.inputs.GetInstancesArgs;
    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 small-size = CivoFunctions.getInstances(GetInstancesArgs.builder()
                .region("LON1")
                .filters(GetInstancesFilterArgs.builder()
                    .key("size")
                    .values(small)
                    .build())
                .build());
    
        }
    }
    
    variables:
      small-size:
        fn::invoke:
          Function: civo:getInstances
          Arguments:
            region: LON1
            filters:
              - key: size
                values:
                  - ${small}
    

    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(filters: Optional[Sequence[GetInstancesFilter]] = None,
                      region: Optional[str] = None,
                      sorts: Optional[Sequence[GetInstancesSort]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetInstancesResult
    def get_instances_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetInstancesFilterArgs]]]] = None,
                      region: Optional[pulumi.Input[str]] = None,
                      sorts: Optional[pulumi.Input[Sequence[pulumi.Input[GetInstancesSortArgs]]]] = 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: civo:index/getInstances:getInstances
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filters List<GetInstancesFilter>
    One or more key/value pairs on which to filter results
    Region string
    If used, all instances will be from the provided region
    Sorts List<GetInstancesSort>
    One or more key/direction pairs on which to sort results
    Filters []GetInstancesFilter
    One or more key/value pairs on which to filter results
    Region string
    If used, all instances will be from the provided region
    Sorts []GetInstancesSort
    One or more key/direction pairs on which to sort results
    filters List<GetInstancesFilter>
    One or more key/value pairs on which to filter results
    region String
    If used, all instances will be from the provided region
    sorts List<GetInstancesSort>
    One or more key/direction pairs on which to sort results
    filters GetInstancesFilter[]
    One or more key/value pairs on which to filter results
    region string
    If used, all instances will be from the provided region
    sorts GetInstancesSort[]
    One or more key/direction pairs on which to sort results
    filters Sequence[GetInstancesFilter]
    One or more key/value pairs on which to filter results
    region str
    If used, all instances will be from the provided region
    sorts Sequence[GetInstancesSort]
    One or more key/direction pairs on which to sort results
    filters List<Property Map>
    One or more key/value pairs on which to filter results
    region String
    If used, all instances will be from the provided region
    sorts List<Property Map>
    One or more key/direction pairs on which to sort results

    getInstances Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Instances List<GetInstancesInstance>
    Filters List<GetInstancesFilter>
    One or more key/value pairs on which to filter results
    Region string
    If used, all instances will be from the provided region
    Sorts List<GetInstancesSort>
    One or more key/direction pairs on which to sort results
    Id string
    The provider-assigned unique ID for this managed resource.
    Instances []GetInstancesInstance
    Filters []GetInstancesFilter
    One or more key/value pairs on which to filter results
    Region string
    If used, all instances will be from the provided region
    Sorts []GetInstancesSort
    One or more key/direction pairs on which to sort results
    id String
    The provider-assigned unique ID for this managed resource.
    instances List<GetInstancesInstance>
    filters List<GetInstancesFilter>
    One or more key/value pairs on which to filter results
    region String
    If used, all instances will be from the provided region
    sorts List<GetInstancesSort>
    One or more key/direction pairs on which to sort results
    id string
    The provider-assigned unique ID for this managed resource.
    instances GetInstancesInstance[]
    filters GetInstancesFilter[]
    One or more key/value pairs on which to filter results
    region string
    If used, all instances will be from the provided region
    sorts GetInstancesSort[]
    One or more key/direction pairs on which to sort results
    id str
    The provider-assigned unique ID for this managed resource.
    instances Sequence[GetInstancesInstance]
    filters Sequence[GetInstancesFilter]
    One or more key/value pairs on which to filter results
    region str
    If used, all instances will be from the provided region
    sorts Sequence[GetInstancesSort]
    One or more key/direction pairs on which to sort results
    id String
    The provider-assigned unique ID for this managed resource.
    instances List<Property Map>
    filters List<Property Map>
    One or more key/value pairs on which to filter results
    region String
    If used, all instances will be from the provided region
    sorts List<Property Map>
    One or more key/direction pairs on which to sort results

    Supporting Types

    GetInstancesFilter

    Key string
    Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
    Values List<string>
    Only retrieves instances which keys has value that matches one of the values provided here
    All bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    MatchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    Key string
    Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
    Values []string
    Only retrieves instances which keys has value that matches one of the values provided here
    All bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    MatchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key String
    Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
    values List<String>
    Only retrieves instances which keys has value that matches one of the values provided here
    all Boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy String
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key string
    Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
    values string[]
    Only retrieves instances which keys has value that matches one of the values provided here
    all boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key str
    Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
    values Sequence[str]
    Only retrieves instances which keys has value that matches one of the values provided here
    all bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    match_by str
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key String
    Filter instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, tags, template.
    values List<String>
    Only retrieves instances which keys has value that matches one of the values provided here
    all Boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy String
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.

    GetInstancesInstance

    CpuCores int
    CPU of the instance
    CreatedAt string
    Creation date of the instance
    DiskGb int
    SSD size of the instance
    FirewallId string
    Firewall ID of the instance
    Hostname string
    Hostname of the instance
    Id string
    ID of the instance
    InitialPassword string
    Initial password of the instance
    InitialUser string
    Initial user of the instance
    NetworkId string
    Network id of the instance
    Notes string
    Note of the instance
    PrivateIp string
    Private IP of the instance
    PseudoIp string
    Pseudo IP of the instance
    PublicIp string
    Public IP of the instance
    RamMb int
    RAM of the instance
    Region string
    Region of the instance
    ReverseDns string
    Reverse DNS of the instance
    Script string
    Script of the instance
    Size string
    Size of the instance
    SshkeyId string
    SSH key id of the instance
    Status string
    Status of the instance
    Tags List<string>
    Tags of the instance
    Template string
    Disk image/template of the instance
    CpuCores int
    CPU of the instance
    CreatedAt string
    Creation date of the instance
    DiskGb int
    SSD size of the instance
    FirewallId string
    Firewall ID of the instance
    Hostname string
    Hostname of the instance
    Id string
    ID of the instance
    InitialPassword string
    Initial password of the instance
    InitialUser string
    Initial user of the instance
    NetworkId string
    Network id of the instance
    Notes string
    Note of the instance
    PrivateIp string
    Private IP of the instance
    PseudoIp string
    Pseudo IP of the instance
    PublicIp string
    Public IP of the instance
    RamMb int
    RAM of the instance
    Region string
    Region of the instance
    ReverseDns string
    Reverse DNS of the instance
    Script string
    Script of the instance
    Size string
    Size of the instance
    SshkeyId string
    SSH key id of the instance
    Status string
    Status of the instance
    Tags []string
    Tags of the instance
    Template string
    Disk image/template of the instance
    cpuCores Integer
    CPU of the instance
    createdAt String
    Creation date of the instance
    diskGb Integer
    SSD size of the instance
    firewallId String
    Firewall ID of the instance
    hostname String
    Hostname of the instance
    id String
    ID of the instance
    initialPassword String
    Initial password of the instance
    initialUser String
    Initial user of the instance
    networkId String
    Network id of the instance
    notes String
    Note of the instance
    privateIp String
    Private IP of the instance
    pseudoIp String
    Pseudo IP of the instance
    publicIp String
    Public IP of the instance
    ramMb Integer
    RAM of the instance
    region String
    Region of the instance
    reverseDns String
    Reverse DNS of the instance
    script String
    Script of the instance
    size String
    Size of the instance
    sshkeyId String
    SSH key id of the instance
    status String
    Status of the instance
    tags List<String>
    Tags of the instance
    template String
    Disk image/template of the instance
    cpuCores number
    CPU of the instance
    createdAt string
    Creation date of the instance
    diskGb number
    SSD size of the instance
    firewallId string
    Firewall ID of the instance
    hostname string
    Hostname of the instance
    id string
    ID of the instance
    initialPassword string
    Initial password of the instance
    initialUser string
    Initial user of the instance
    networkId string
    Network id of the instance
    notes string
    Note of the instance
    privateIp string
    Private IP of the instance
    pseudoIp string
    Pseudo IP of the instance
    publicIp string
    Public IP of the instance
    ramMb number
    RAM of the instance
    region string
    Region of the instance
    reverseDns string
    Reverse DNS of the instance
    script string
    Script of the instance
    size string
    Size of the instance
    sshkeyId string
    SSH key id of the instance
    status string
    Status of the instance
    tags string[]
    Tags of the instance
    template string
    Disk image/template of the instance
    cpu_cores int
    CPU of the instance
    created_at str
    Creation date of the instance
    disk_gb int
    SSD size of the instance
    firewall_id str
    Firewall ID of the instance
    hostname str
    Hostname of the instance
    id str
    ID of the instance
    initial_password str
    Initial password of the instance
    initial_user str
    Initial user of the instance
    network_id str
    Network id of the instance
    notes str
    Note of the instance
    private_ip str
    Private IP of the instance
    pseudo_ip str
    Pseudo IP of the instance
    public_ip str
    Public IP of the instance
    ram_mb int
    RAM of the instance
    region str
    Region of the instance
    reverse_dns str
    Reverse DNS of the instance
    script str
    Script of the instance
    size str
    Size of the instance
    sshkey_id str
    SSH key id of the instance
    status str
    Status of the instance
    tags Sequence[str]
    Tags of the instance
    template str
    Disk image/template of the instance
    cpuCores Number
    CPU of the instance
    createdAt String
    Creation date of the instance
    diskGb Number
    SSD size of the instance
    firewallId String
    Firewall ID of the instance
    hostname String
    Hostname of the instance
    id String
    ID of the instance
    initialPassword String
    Initial password of the instance
    initialUser String
    Initial user of the instance
    networkId String
    Network id of the instance
    notes String
    Note of the instance
    privateIp String
    Private IP of the instance
    pseudoIp String
    Pseudo IP of the instance
    publicIp String
    Public IP of the instance
    ramMb Number
    RAM of the instance
    region String
    Region of the instance
    reverseDns String
    Reverse DNS of the instance
    script String
    Script of the instance
    size String
    Size of the instance
    sshkeyId String
    SSH key id of the instance
    status String
    Status of the instance
    tags List<String>
    Tags of the instance
    template String
    Disk image/template of the instance

    GetInstancesSort

    Key string
    Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
    Direction string
    The sort direction. This may be either asc or desc.
    Key string
    Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
    Direction string
    The sort direction. This may be either asc or desc.
    key String
    Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
    direction String
    The sort direction. This may be either asc or desc.
    key string
    Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
    direction string
    The sort direction. This may be either asc or desc.
    key str
    Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
    direction str
    The sort direction. This may be either asc or desc.
    key String
    Sort instances by this key. This may be one of cpu_cores, created_at, disk_gb, firewall_id, hostname, id, initial_password, initial_user, network_id, notes, private_ip, pseudo_ip, public_ip, ram_mb, region, reverse_dns, script, size, sshkey_id, status, template.
    direction String
    The sort direction. This may be either asc or desc.

    Package Details

    Repository
    Civo pulumi/pulumi-civo
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the civo Terraform Provider.
    civo logo
    Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi