civo logo
Civo v2.3.3, Feb 17 23

civo.getSize

Retrieves information about the sizes that Civo supports, with the ability to filter the results.

Using getSize

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 getSize(args: GetSizeArgs, opts?: InvokeOptions): Promise<GetSizeResult>
function getSizeOutput(args: GetSizeOutputArgs, opts?: InvokeOptions): Output<GetSizeResult>
def get_size(filters: Optional[Sequence[GetSizeFilter]] = None,
             sorts: Optional[Sequence[GetSizeSort]] = None,
             opts: Optional[InvokeOptions] = None) -> GetSizeResult
def get_size_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetSizeFilterArgs]]]] = None,
             sorts: Optional[pulumi.Input[Sequence[pulumi.Input[GetSizeSortArgs]]]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetSizeResult]
func GetSize(ctx *Context, args *GetSizeArgs, opts ...InvokeOption) (*GetSizeResult, error)
func GetSizeOutput(ctx *Context, args *GetSizeOutputArgs, opts ...InvokeOption) GetSizeResultOutput

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

public static class GetSize 
{
    public static Task<GetSizeResult> InvokeAsync(GetSizeArgs args, InvokeOptions? opts = null)
    public static Output<GetSizeResult> Invoke(GetSizeInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSizeResult> getSize(GetSizeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: civo:index/getSize:getSize
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetSizeFilter>

One or more key/value pairs on which to filter results

Sorts List<GetSizeSort>

One or more key/direction pairs on which to sort results

Filters []GetSizeFilter

One or more key/value pairs on which to filter results

Sorts []GetSizeSort

One or more key/direction pairs on which to sort results

filters List<GetSizeFilter>

One or more key/value pairs on which to filter results

sorts List<GetSizeSort>

One or more key/direction pairs on which to sort results

filters GetSizeFilter[]

One or more key/value pairs on which to filter results

sorts GetSizeSort[]

One or more key/direction pairs on which to sort results

filters Sequence[GetSizeFilter]

One or more key/value pairs on which to filter results

sorts Sequence[GetSizeSort]

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

sorts List<Property Map>

One or more key/direction pairs on which to sort results

getSize Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Sizes List<GetSizeSize>
Filters List<GetSizeFilter>

One or more key/value pairs on which to filter results

Sorts List<GetSizeSort>

One or more key/direction pairs on which to sort results

Id string

The provider-assigned unique ID for this managed resource.

Sizes []GetSizeSize
Filters []GetSizeFilter

One or more key/value pairs on which to filter results

Sorts []GetSizeSort

One or more key/direction pairs on which to sort results

id String

The provider-assigned unique ID for this managed resource.

sizes List<GetSizeSize>
filters List<GetSizeFilter>

One or more key/value pairs on which to filter results

sorts List<GetSizeSort>

One or more key/direction pairs on which to sort results

id string

The provider-assigned unique ID for this managed resource.

sizes GetSizeSize[]
filters GetSizeFilter[]

One or more key/value pairs on which to filter results

sorts GetSizeSort[]

One or more key/direction pairs on which to sort results

id str

The provider-assigned unique ID for this managed resource.

sizes Sequence[GetSizeSize]
filters Sequence[GetSizeFilter]

One or more key/value pairs on which to filter results

sorts Sequence[GetSizeSort]

One or more key/direction pairs on which to sort results

id String

The provider-assigned unique ID for this managed resource.

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

One or more key/value pairs on which to filter results

sorts List<Property Map>

One or more key/direction pairs on which to sort results

Supporting Types

GetSizeFilter

Key string

Filter sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

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 sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

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 sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

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 sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

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 sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

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 sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

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.

GetSizeSize

Cpu int
Description string
Disk int
Name string
Ram int
Selectable bool
Type string
Cpu int
Description string
Disk int
Name string
Ram int
Selectable bool
Type string
cpu Integer
description String
disk Integer
name String
ram Integer
selectable Boolean
type String
cpu number
description string
disk number
name string
ram number
selectable boolean
type string
cpu int
description str
disk int
name str
ram int
selectable bool
type str
cpu Number
description String
disk Number
name String
ram Number
selectable Boolean
type String

GetSizeSort

Key string

Sort sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

Direction string

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

Key string

Sort sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

Direction string

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

key String

Sort sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

direction String

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

key string

Sort sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

direction string

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

key str

Sort sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

direction str

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

key String

Sort sizes by this key. This may be one of cpu, description, disk, name, ram, selectable, type.

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.