1. Packages
  2. DigitalOcean Provider
  3. API Docs
  4. getDropletAutoscale
DigitalOcean v4.42.0 published on Thursday, Apr 17, 2025 by Pulumi

digitalocean.getDropletAutoscale

Explore with Pulumi AI

DigitalOcean v4.42.0 published on Thursday, Apr 17, 2025 by Pulumi

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,
});
Copy
import pulumi
import pulumi_digitalocean as digitalocean

my_imported_autoscale_pool = digitalocean.get_droplet_autoscale(name=my_existing_autoscale_pool["name"])
Copy
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
	})
}
Copy
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,
    });

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

    }
}
Copy
variables:
  my-imported-autoscale-pool:
    fn::invoke:
      function: digitalocean:getDropletAutoscale
      arguments:
        name: ${["my-existing-autoscale-pool"].name}
Copy

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,
});
Copy
import pulumi
import pulumi_digitalocean as digitalocean

my_imported_autoscale_pool = digitalocean.get_droplet_autoscale(id=my_existing_autoscale_pool["id"])
Copy
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
	})
}
Copy
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,
    });

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

    }
}
Copy
variables:
  my-imported-autoscale-pool:
    fn::invoke:
      function: digitalocean:getDropletAutoscale
      arguments:
        id: ${["my-existing-autoscale-pool"].id}
Copy

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>
Copy
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]
Copy
func LookupDropletAutoscale(ctx *Context, args *LookupDropletAutoscaleArgs, opts ...InvokeOption) (*LookupDropletAutoscaleResult, error)
func LookupDropletAutoscaleOutput(ctx *Context, args *LookupDropletAutoscaleOutputArgs, opts ...InvokeOption) LookupDropletAutoscaleResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetDropletAutoscaleResult> getDropletAutoscale(GetDropletAutoscaleArgs args, InvokeOptions options)
public static Output<GetDropletAutoscaleResult> getDropletAutoscale(GetDropletAutoscaleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: digitalocean:index/getDropletAutoscale:getDropletAutoscale
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id string
The ID of Droplet Autoscale pool.
Name string
The name of Droplet Autoscale pool.
Id string
The ID of Droplet Autoscale pool.
Name string
The name of Droplet Autoscale pool.
id String
The ID of Droplet Autoscale pool.
name String
The name of Droplet Autoscale pool.
id string
The ID of Droplet Autoscale pool.
name string
The name of Droplet Autoscale pool.
id str
The ID of Droplet Autoscale pool.
name str
The name of Droplet Autoscale pool.
id String
The ID of Droplet Autoscale pool.
name String
The name of Droplet Autoscale pool.

getDropletAutoscale Result

The following output properties are available:

Supporting Types

GetDropletAutoscaleConfig

CooldownMinutes This property is required. int
Cooldown duration
MaxInstances This property is required. int
Max number of members
MinInstances This property is required. int
Min number of members
TargetCpuUtilization This property is required. double
CPU target threshold
TargetMemoryUtilization This property is required. double
Memory target threshold
TargetNumberInstances This property is required. int
Target number of members
CooldownMinutes This property is required. int
Cooldown duration
MaxInstances This property is required. int
Max number of members
MinInstances This property is required. int
Min number of members
TargetCpuUtilization This property is required. float64
CPU target threshold
TargetMemoryUtilization This property is required. float64
Memory target threshold
TargetNumberInstances This property is required. int
Target number of members
cooldownMinutes This property is required. Integer
Cooldown duration
maxInstances This property is required. Integer
Max number of members
minInstances This property is required. Integer
Min number of members
targetCpuUtilization This property is required. Double
CPU target threshold
targetMemoryUtilization This property is required. Double
Memory target threshold
targetNumberInstances This property is required. Integer
Target number of members
cooldownMinutes This property is required. number
Cooldown duration
maxInstances This property is required. number
Max number of members
minInstances This property is required. number
Min number of members
targetCpuUtilization This property is required. number
CPU target threshold
targetMemoryUtilization This property is required. number
Memory target threshold
targetNumberInstances This property is required. number
Target number of members
cooldown_minutes This property is required. int
Cooldown duration
max_instances This property is required. int
Max number of members
min_instances This property is required. int
Min number of members
target_cpu_utilization This property is required. float
CPU target threshold
target_memory_utilization This property is required. float
Memory target threshold
target_number_instances This property is required. int
Target number of members
cooldownMinutes This property is required. Number
Cooldown duration
maxInstances This property is required. Number
Max number of members
minInstances This property is required. Number
Min number of members
targetCpuUtilization This property is required. Number
CPU target threshold
targetMemoryUtilization This property is required. Number
Memory target threshold
targetNumberInstances This property is required. Number
Target number of members

GetDropletAutoscaleCurrentUtilization

Cpu This property is required. double
Average CPU utilization
Memory This property is required. double
Average Memory utilization
Cpu This property is required. float64
Average CPU utilization
Memory This property is required. float64
Average Memory utilization
cpu This property is required. Double
Average CPU utilization
memory This property is required. Double
Average Memory utilization
cpu This property is required. number
Average CPU utilization
memory This property is required. number
Average Memory utilization
cpu This property is required. float
Average CPU utilization
memory This property is required. float
Average Memory utilization
cpu This property is required. Number
Average CPU utilization
memory This property is required. Number
Average Memory utilization

GetDropletAutoscaleDropletTemplate

Image This property is required. string
Droplet image
Ipv6 This property is required. bool
Enable droplet IPv6
ProjectId This property is required. string
Droplet project ID
Region This property is required. string
Droplet region
Size This property is required. string
Droplet size
SshKeys This property is required. List<string>
Droplet SSH keys
Tags This property is required. List<string>
Droplet tags
UserData This property is required. string
Droplet user data
VpcUuid This property is required. string
Droplet VPC UUID
WithDropletAgent This property is required. bool
Enable droplet agent
Image This property is required. string
Droplet image
Ipv6 This property is required. bool
Enable droplet IPv6
ProjectId This property is required. string
Droplet project ID
Region This property is required. string
Droplet region
Size This property is required. string
Droplet size
SshKeys This property is required. []string
Droplet SSH keys
Tags This property is required. []string
Droplet tags
UserData This property is required. string
Droplet user data
VpcUuid This property is required. string
Droplet VPC UUID
WithDropletAgent This property is required. bool
Enable droplet agent
image This property is required. String
Droplet image
ipv6 This property is required. Boolean
Enable droplet IPv6
projectId This property is required. String
Droplet project ID
region This property is required. String
Droplet region
size This property is required. String
Droplet size
sshKeys This property is required. List<String>
Droplet SSH keys
tags This property is required. List<String>
Droplet tags
userData This property is required. String
Droplet user data
vpcUuid This property is required. String
Droplet VPC UUID
withDropletAgent This property is required. Boolean
Enable droplet agent
image This property is required. string
Droplet image
ipv6 This property is required. boolean
Enable droplet IPv6
projectId This property is required. string
Droplet project ID
region This property is required. string
Droplet region
size This property is required. string
Droplet size
sshKeys This property is required. string[]
Droplet SSH keys
tags This property is required. string[]
Droplet tags
userData This property is required. string
Droplet user data
vpcUuid This property is required. string
Droplet VPC UUID
withDropletAgent This property is required. boolean
Enable droplet agent
image This property is required. str
Droplet image
ipv6 This property is required. bool
Enable droplet IPv6
project_id This property is required. str
Droplet project ID
region This property is required. str
Droplet region
size This property is required. str
Droplet size
ssh_keys This property is required. Sequence[str]
Droplet SSH keys
tags This property is required. Sequence[str]
Droplet tags
user_data This property is required. str
Droplet user data
vpc_uuid This property is required. str
Droplet VPC UUID
with_droplet_agent This property is required. bool
Enable droplet agent
image This property is required. String
Droplet image
ipv6 This property is required. Boolean
Enable droplet IPv6
projectId This property is required. String
Droplet project ID
region This property is required. String
Droplet region
size This property is required. String
Droplet size
sshKeys This property is required. List<String>
Droplet SSH keys
tags This property is required. List<String>
Droplet tags
userData This property is required. String
Droplet user data
vpcUuid This property is required. String
Droplet VPC UUID
withDropletAgent This property is required. Boolean
Enable droplet agent

Package Details

Repository
DigitalOcean pulumi/pulumi-digitalocean
License
Apache-2.0
Notes
This Pulumi package is based on the digitalocean Terraform Provider.
DigitalOcean v4.42.0 published on Thursday, Apr 17, 2025 by Pulumi