DigitalOcean v4.41.0 published on Wednesday, Mar 26, 2025 by Pulumi
digitalocean.getDropletAutoscale
Explore with Pulumi AI
Example Usage
Get the Droplet Autoscale pool by name:
import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const my_imported_autoscale_pool = digitalocean.getDropletAutoscale({
    name: my_existing_autoscale_pool.name,
});
import pulumi
import pulumi_digitalocean as digitalocean
my_imported_autoscale_pool = digitalocean.get_droplet_autoscale(name=my_existing_autoscale_pool["name"])
package main
import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitalocean.LookupDropletAutoscale(ctx, &digitalocean.LookupDropletAutoscaleArgs{
			Name: pulumi.StringRef(my_existing_autoscale_pool.Name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() => 
{
    var my_imported_autoscale_pool = DigitalOcean.GetDropletAutoscale.Invoke(new()
    {
        Name = my_existing_autoscale_pool.Name,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetDropletAutoscaleArgs;
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 my-imported-autoscale-pool = DigitaloceanFunctions.getDropletAutoscale(GetDropletAutoscaleArgs.builder()
            .name(my_existing_autoscale_pool.name())
            .build());
    }
}
variables:
  my-imported-autoscale-pool:
    fn::invoke:
      function: digitalocean:getDropletAutoscale
      arguments:
        name: ${["my-existing-autoscale-pool"].name}
Get the Droplet Autoscale pool by ID:
import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const my_imported_autoscale_pool = digitalocean.getDropletAutoscale({
    id: my_existing_autoscale_pool.id,
});
import pulumi
import pulumi_digitalocean as digitalocean
my_imported_autoscale_pool = digitalocean.get_droplet_autoscale(id=my_existing_autoscale_pool["id"])
package main
import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := digitalocean.LookupDropletAutoscale(ctx, &digitalocean.LookupDropletAutoscaleArgs{
			Id: pulumi.StringRef(my_existing_autoscale_pool.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() => 
{
    var my_imported_autoscale_pool = DigitalOcean.GetDropletAutoscale.Invoke(new()
    {
        Id = my_existing_autoscale_pool.Id,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DigitaloceanFunctions;
import com.pulumi.digitalocean.inputs.GetDropletAutoscaleArgs;
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 my-imported-autoscale-pool = DigitaloceanFunctions.getDropletAutoscale(GetDropletAutoscaleArgs.builder()
            .id(my_existing_autoscale_pool.id())
            .build());
    }
}
variables:
  my-imported-autoscale-pool:
    fn::invoke:
      function: digitalocean:getDropletAutoscale
      arguments:
        id: ${["my-existing-autoscale-pool"].id}
Using getDropletAutoscale
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 getDropletAutoscale(args: GetDropletAutoscaleArgs, opts?: InvokeOptions): Promise<GetDropletAutoscaleResult>
function getDropletAutoscaleOutput(args: GetDropletAutoscaleOutputArgs, opts?: InvokeOptions): Output<GetDropletAutoscaleResult>def get_droplet_autoscale(id: Optional[str] = None,
                          name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDropletAutoscaleResult
def get_droplet_autoscale_output(id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDropletAutoscaleResult]func LookupDropletAutoscale(ctx *Context, args *LookupDropletAutoscaleArgs, opts ...InvokeOption) (*LookupDropletAutoscaleResult, error)
func LookupDropletAutoscaleOutput(ctx *Context, args *LookupDropletAutoscaleOutputArgs, opts ...InvokeOption) LookupDropletAutoscaleResultOutput> Note: This function is named LookupDropletAutoscale in the Go SDK.
public static class GetDropletAutoscale 
{
    public static Task<GetDropletAutoscaleResult> InvokeAsync(GetDropletAutoscaleArgs args, InvokeOptions? opts = null)
    public static Output<GetDropletAutoscaleResult> Invoke(GetDropletAutoscaleInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDropletAutoscaleResult> getDropletAutoscale(GetDropletAutoscaleArgs args, InvokeOptions options)
public static Output<GetDropletAutoscaleResult> getDropletAutoscale(GetDropletAutoscaleArgs args, InvokeOptions options)
fn::invoke:
  function: digitalocean:index/getDropletAutoscale:getDropletAutoscale
  arguments:
    # arguments dictionaryThe following arguments are supported:
getDropletAutoscale Result
The following output properties are available:
- Configs
List<Pulumi.Digital Ocean. Outputs. Get Droplet Autoscale Config> 
- CreatedAt string
- CurrentUtilizations List<Pulumi.Digital Ocean. Outputs. Get Droplet Autoscale Current Utilization> 
- DropletTemplates List<Pulumi.Digital Ocean. Outputs. Get Droplet Autoscale Droplet Template> 
- Status string
- UpdatedAt string
- Id string
- Name string
- configs List<Property Map>
- createdAt String
- currentUtilizations List<Property Map>
- dropletTemplates List<Property Map>
- status String
- updatedAt String
- id String
- name String
Supporting Types
GetDropletAutoscaleConfig   
- CooldownMinutes int
- Cooldown duration
- MaxInstances int
- Max number of members
- MinInstances int
- Min number of members
- TargetCpu doubleUtilization 
- CPU target threshold
- TargetMemory doubleUtilization 
- Memory target threshold
- TargetNumber intInstances 
- Target number of members
- CooldownMinutes int
- Cooldown duration
- MaxInstances int
- Max number of members
- MinInstances int
- Min number of members
- TargetCpu float64Utilization 
- CPU target threshold
- TargetMemory float64Utilization 
- Memory target threshold
- TargetNumber intInstances 
- Target number of members
- cooldownMinutes Integer
- Cooldown duration
- maxInstances Integer
- Max number of members
- minInstances Integer
- Min number of members
- targetCpu DoubleUtilization 
- CPU target threshold
- targetMemory DoubleUtilization 
- Memory target threshold
- targetNumber IntegerInstances 
- Target number of members
- cooldownMinutes number
- Cooldown duration
- maxInstances number
- Max number of members
- minInstances number
- Min number of members
- targetCpu numberUtilization 
- CPU target threshold
- targetMemory numberUtilization 
- Memory target threshold
- targetNumber numberInstances 
- Target number of members
- cooldown_minutes int
- Cooldown duration
- max_instances int
- Max number of members
- min_instances int
- Min number of members
- target_cpu_ floatutilization 
- CPU target threshold
- target_memory_ floatutilization 
- Memory target threshold
- target_number_ intinstances 
- Target number of members
- cooldownMinutes Number
- Cooldown duration
- maxInstances Number
- Max number of members
- minInstances Number
- Min number of members
- targetCpu NumberUtilization 
- CPU target threshold
- targetMemory NumberUtilization 
- Memory target threshold
- targetNumber NumberInstances 
- Target number of members
GetDropletAutoscaleCurrentUtilization    
GetDropletAutoscaleDropletTemplate    
- Image string
- Droplet image
- Ipv6 bool
- Enable droplet IPv6
- ProjectId string
- Droplet project ID
- Region string
- Droplet region
- Size string
- Droplet size
- SshKeys List<string>
- Droplet SSH keys
- List<string>
- Droplet tags
- UserData string
- Droplet user data
- VpcUuid string
- Droplet VPC UUID
- WithDroplet boolAgent 
- Enable droplet agent
- image String
- Droplet image
- ipv6 Boolean
- Enable droplet IPv6
- projectId String
- Droplet project ID
- region String
- Droplet region
- size String
- Droplet size
- sshKeys List<String>
- Droplet SSH keys
- List<String>
- Droplet tags
- userData String
- Droplet user data
- vpcUuid String
- Droplet VPC UUID
- withDroplet BooleanAgent 
- Enable droplet agent
- image str
- Droplet image
- ipv6 bool
- Enable droplet IPv6
- project_id str
- Droplet project ID
- region str
- Droplet region
- size str
- Droplet size
- ssh_keys Sequence[str]
- Droplet SSH keys
- Sequence[str]
- Droplet tags
- user_data str
- Droplet user data
- vpc_uuid str
- Droplet VPC UUID
- with_droplet_ boolagent 
- Enable droplet agent
- image String
- Droplet image
- ipv6 Boolean
- Enable droplet IPv6
- projectId String
- Droplet project ID
- region String
- Droplet region
- size String
- Droplet size
- sshKeys List<String>
- Droplet SSH keys
- List<String>
- Droplet tags
- userData String
- Droplet user data
- vpcUuid String
- Droplet VPC UUID
- withDroplet BooleanAgent 
- Enable droplet agent
Package Details
- Repository
- DigitalOcean pulumi/pulumi-digitalocean
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the digitaloceanTerraform Provider.