getRegion

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

Using getRegion

function getRegion(args: GetRegionArgs, opts?: InvokeOptions): Promise<GetRegionResult>
def get_region(filters: Optional[Sequence[GetRegionFilter]] = None,
               sorts: Optional[Sequence[GetRegionSort]] = None,
               opts: Optional[InvokeOptions] = None) -> GetRegionResult
func GetRegion(ctx *Context, args *GetRegionArgs, opts ...InvokeOption) (*GetRegionResult, error)

Note: This function is named GetRegion in the Go SDK.

public static class GetRegion {
    public static Task<GetRegionResult> InvokeAsync(GetRegionArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Filters List<GetRegionFilter>
Filter the results. The filter block is documented below.
Sorts List<GetRegionSort>
Sort the results. The sort block is documented below.
Filters []GetRegionFilter
Filter the results. The filter block is documented below.
Sorts []GetRegionSort
Sort the results. The sort block is documented below.
filters GetRegionFilter[]
Filter the results. The filter block is documented below.
sorts GetRegionSort[]
Sort the results. The sort block is documented below.
filters Sequence[GetRegionFilter]
Filter the results. The filter block is documented below.
sorts Sequence[GetRegionSort]
Sort the results. The sort block is documented below.

getRegion Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Regions List<GetRegionRegion>
Filters List<GetRegionFilter>
Sorts List<GetRegionSort>
Id string
The provider-assigned unique ID for this managed resource.
Regions []GetRegionRegion
Filters []GetRegionFilter
Sorts []GetRegionSort
id string
The provider-assigned unique ID for this managed resource.
regions GetRegionRegion[]
filters GetRegionFilter[]
sorts GetRegionSort[]
id str
The provider-assigned unique ID for this managed resource.
regions Sequence[GetRegionRegion]
filters Sequence[GetRegionFilter]
sorts Sequence[GetRegionSort]

Supporting Types

GetRegionFilter

Key string
Filter the sizes by this key. This may be one of code, name, country, default.
Values List<string>
Only retrieves region which keys has value that matches one of the values provided here.
All bool
MatchBy string
Key string
Filter the sizes by this key. This may be one of code, name, country, default.
Values []string
Only retrieves region which keys has value that matches one of the values provided here.
All bool
MatchBy string
key string
Filter the sizes by this key. This may be one of code, name, country, default.
values string[]
Only retrieves region which keys has value that matches one of the values provided here.
all boolean
matchBy string
key str
Filter the sizes by this key. This may be one of code, name, country, default.
values Sequence[str]
Only retrieves region which keys has value that matches one of the values provided here.
all bool
match_by str

GetRegionRegion

Code string
Country string
Default bool
Name string
Code string
Country string
Default bool
Name string
code string
country string
default boolean
name string
code str
country str
default bool
name str

GetRegionSort

Key string
Sort the sizes by this key. This may be one of code,name.
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 code,name.
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 code,name.
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 code,name.
direction str
The sort direction. This may be either asc or desc.

Package Details

Repository
https://github.com/pulumi/pulumi-civo
License
Apache-2.0
Notes
This Pulumi package is based on the civo Terraform Provider.