DigitalOcean

v4.16.0 published on Wednesday, Sep 28, 2022 by Pulumi

getSizes

Retrieves information about the Droplet sizes that DigitalOcean supports, with the ability to filter and sort the results. If no filters are specified, all sizes will be returned.

Using getSizes

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 getSizes(args: GetSizesArgs, opts?: InvokeOptions): Promise<GetSizesResult>
function getSizesOutput(args: GetSizesOutputArgs, opts?: InvokeOptions): Output<GetSizesResult>
def get_sizes(filters: Optional[Sequence[GetSizesFilter]] = None,
              sorts: Optional[Sequence[GetSizesSort]] = None,
              opts: Optional[InvokeOptions] = None) -> GetSizesResult
def get_sizes_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetSizesFilterArgs]]]] = None,
              sorts: Optional[pulumi.Input[Sequence[pulumi.Input[GetSizesSortArgs]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetSizesResult]
func GetSizes(ctx *Context, args *GetSizesArgs, opts ...InvokeOption) (*GetSizesResult, error)
func GetSizesOutput(ctx *Context, args *GetSizesOutputArgs, opts ...InvokeOption) GetSizesResultOutput

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

public static class GetSizes 
{
    public static Task<GetSizesResult> InvokeAsync(GetSizesArgs args, InvokeOptions? opts = null)
    public static Output<GetSizesResult> Invoke(GetSizesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSizesResult> getSizes(GetSizesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: digitalocean:index/getSizes:getSizes
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<Pulumi.DigitalOcean.Inputs.GetSizesFilter>

Filter the results. The filter block is documented below.

Sorts List<Pulumi.DigitalOcean.Inputs.GetSizesSort>

Sort the results. The sort block is documented below.

Filters []GetSizesFilter

Filter the results. The filter block is documented below.

Sorts []GetSizesSort

Sort the results. The sort block is documented below.

filters List<GetSizesFilter>

Filter the results. The filter block is documented below.

sorts List<GetSizesSort>

Sort the results. The sort block is documented below.

filters GetSizesFilter[]

Filter the results. The filter block is documented below.

sorts GetSizesSort[]

Sort the results. The sort block is documented below.

filters Sequence[GetSizesFilter]

Filter the results. The filter block is documented below.

sorts Sequence[GetSizesSort]

Sort the results. The sort block is documented below.

filters List<Property Map>

Filter the results. The filter block is documented below.

sorts List<Property Map>

Sort the results. The sort block is documented below.

getSizes Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Sizes []GetSizesSize
Filters []GetSizesFilter
Sorts []GetSizesSort
id String

The provider-assigned unique ID for this managed resource.

sizes List<GetSizesSize>
filters List<GetSizesFilter>
sorts List<GetSizesSort>
id string

The provider-assigned unique ID for this managed resource.

sizes GetSizesSize[]
filters GetSizesFilter[]
sorts GetSizesSort[]
id str

The provider-assigned unique ID for this managed resource.

sizes Sequence[GetSizesSize]
filters Sequence[GetSizesFilter]
sorts Sequence[GetSizesSort]
id String

The provider-assigned unique ID for this managed resource.

sizes List<Property Map>
filters List<Property Map>
sorts List<Property Map>

Supporting Types

GetSizesFilter

Key string

Filter the sizes by this key. This may be one of slug, regions, memory, vcpus, disk, transfer, price_monthly, price_hourly, or available.

Values List<string>

Only retrieves sizes 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 the sizes by this key. This may be one of slug, regions, memory, vcpus, disk, transfer, price_monthly, price_hourly, or available.

Values []string

Only retrieves sizes 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 the sizes by this key. This may be one of slug, regions, memory, vcpus, disk, transfer, price_monthly, price_hourly, or available.

values List<String>

Only retrieves sizes 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 the sizes by this key. This may be one of slug, regions, memory, vcpus, disk, transfer, price_monthly, price_hourly, or available.

values string[]

Only retrieves sizes 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 the sizes by this key. This may be one of slug, regions, memory, vcpus, disk, transfer, price_monthly, price_hourly, or available.

values Sequence[str]

Only retrieves sizes 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 the sizes by this key. This may be one of slug, regions, memory, vcpus, disk, transfer, price_monthly, price_hourly, or available.

values List<String>

Only retrieves sizes 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.

GetSizesSize

Available bool

This represents whether new Droplets can be created with this size.

Disk int

The amount of disk space set aside for Droplets of this size. The value is measured in gigabytes.

Memory int

The amount of RAM allocated to Droplets created of this size. The value is measured in megabytes.

PriceHourly double

The hourly cost of Droplets created in this size as measured hourly. The value is measured in US dollars.

PriceMonthly double

The monthly cost of Droplets created in this size if they are kept for an entire month. The value is measured in US dollars.

Regions List<string>

List of region slugs where Droplets can be created in this size.

Slug string

A human-readable string that is used to uniquely identify each size.

Transfer double

The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.

Vcpus int

The number of CPUs allocated to Droplets of this size.

Available bool

This represents whether new Droplets can be created with this size.

Disk int

The amount of disk space set aside for Droplets of this size. The value is measured in gigabytes.

Memory int

The amount of RAM allocated to Droplets created of this size. The value is measured in megabytes.

PriceHourly float64

The hourly cost of Droplets created in this size as measured hourly. The value is measured in US dollars.

PriceMonthly float64

The monthly cost of Droplets created in this size if they are kept for an entire month. The value is measured in US dollars.

Regions []string

List of region slugs where Droplets can be created in this size.

Slug string

A human-readable string that is used to uniquely identify each size.

Transfer float64

The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.

Vcpus int

The number of CPUs allocated to Droplets of this size.

available Boolean

This represents whether new Droplets can be created with this size.

disk Integer

The amount of disk space set aside for Droplets of this size. The value is measured in gigabytes.

memory Integer

The amount of RAM allocated to Droplets created of this size. The value is measured in megabytes.

priceHourly Double

The hourly cost of Droplets created in this size as measured hourly. The value is measured in US dollars.

priceMonthly Double

The monthly cost of Droplets created in this size if they are kept for an entire month. The value is measured in US dollars.

regions List<String>

List of region slugs where Droplets can be created in this size.

slug String

A human-readable string that is used to uniquely identify each size.

transfer Double

The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.

vcpus Integer

The number of CPUs allocated to Droplets of this size.

available boolean

This represents whether new Droplets can be created with this size.

disk number

The amount of disk space set aside for Droplets of this size. The value is measured in gigabytes.

memory number

The amount of RAM allocated to Droplets created of this size. The value is measured in megabytes.

priceHourly number

The hourly cost of Droplets created in this size as measured hourly. The value is measured in US dollars.

priceMonthly number

The monthly cost of Droplets created in this size if they are kept for an entire month. The value is measured in US dollars.

regions string[]

List of region slugs where Droplets can be created in this size.

slug string

A human-readable string that is used to uniquely identify each size.

transfer number

The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.

vcpus number

The number of CPUs allocated to Droplets of this size.

available bool

This represents whether new Droplets can be created with this size.

disk int

The amount of disk space set aside for Droplets of this size. The value is measured in gigabytes.

memory int

The amount of RAM allocated to Droplets created of this size. The value is measured in megabytes.

price_hourly float

The hourly cost of Droplets created in this size as measured hourly. The value is measured in US dollars.

price_monthly float

The monthly cost of Droplets created in this size if they are kept for an entire month. The value is measured in US dollars.

regions Sequence[str]

List of region slugs where Droplets can be created in this size.

slug str

A human-readable string that is used to uniquely identify each size.

transfer float

The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.

vcpus int

The number of CPUs allocated to Droplets of this size.

available Boolean

This represents whether new Droplets can be created with this size.

disk Number

The amount of disk space set aside for Droplets of this size. The value is measured in gigabytes.

memory Number

The amount of RAM allocated to Droplets created of this size. The value is measured in megabytes.

priceHourly Number

The hourly cost of Droplets created in this size as measured hourly. The value is measured in US dollars.

priceMonthly Number

The monthly cost of Droplets created in this size if they are kept for an entire month. The value is measured in US dollars.

regions List<String>

List of region slugs where Droplets can be created in this size.

slug String

A human-readable string that is used to uniquely identify each size.

transfer Number

The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes.

vcpus Number

The number of CPUs allocated to Droplets of this size.

GetSizesSort

Key string

Sort the sizes by this key. This may be one of slug, memory, vcpus, disk, transfer, price_monthly, or price_hourly.

Direction string

The sort direction. This may be either asc or desc.

Key string

Sort the sizes by this key. This may be one of slug, memory, vcpus, disk, transfer, price_monthly, or price_hourly.

Direction string

The sort direction. This may be either asc or desc.

key String

Sort the sizes by this key. This may be one of slug, memory, vcpus, disk, transfer, price_monthly, or price_hourly.

direction String

The sort direction. This may be either asc or desc.

key string

Sort the sizes by this key. This may be one of slug, memory, vcpus, disk, transfer, price_monthly, or price_hourly.

direction string

The sort direction. This may be either asc or desc.

key str

Sort the sizes by this key. This may be one of slug, memory, vcpus, disk, transfer, price_monthly, or price_hourly.

direction str

The sort direction. This may be either asc or desc.

key String

Sort the sizes by this key. This may be one of slug, memory, vcpus, disk, transfer, price_monthly, or price_hourly.

direction String

The sort direction. This may be either asc or desc.

Package Details

Repository
https://github.com/pulumi/pulumi-digitalocean
License
Apache-2.0
Notes

This Pulumi package is based on the digitalocean Terraform Provider.