Civo v2.3.18, Jun 11 24

Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi

civo.getRegion

Explore with Pulumi AI

Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi

Using getRegion

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 getRegion(args: GetRegionArgs, opts?: InvokeOptions): Promise<GetRegionResult>
function getRegionOutput(args: GetRegionOutputArgs, opts?: InvokeOptions): Output<GetRegionResult>

def get_region(filters: Optional[Sequence[GetRegionFilter]] = None,
               sorts: Optional[Sequence[GetRegionSort]] = None,
               opts: Optional[InvokeOptions] = None) -> GetRegionResult
def get_region_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetRegionFilterArgs]]]] = None,
               sorts: Optional[pulumi.Input[Sequence[pulumi.Input[GetRegionSortArgs]]]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetRegionResult]

func GetRegion(ctx *Context, args *GetRegionArgs, opts ...InvokeOption) (*GetRegionResult, error)
func GetRegionOutput(ctx *Context, args *GetRegionOutputArgs, opts ...InvokeOption) GetRegionResultOutput

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

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

public static CompletableFuture<GetRegionResult> getRegion(GetRegionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: civo:index/getRegion:getRegion
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetRegionFilter>: One or more key/value pairs on which to filter results
Sorts List<GetRegionSort>: One or more key/direction pairs on which to sort results

Filters []GetRegionFilter: One or more key/value pairs on which to filter results
Sorts []GetRegionSort: One or more key/direction pairs on which to sort results

filters List<GetRegionFilter>: One or more key/value pairs on which to filter results
sorts List<GetRegionSort>: One or more key/direction pairs on which to sort results

filters GetRegionFilter[]: One or more key/value pairs on which to filter results
sorts GetRegionSort[]: One or more key/direction pairs on which to sort results

filters Sequence[GetRegionFilter]: One or more key/value pairs on which to filter results
sorts Sequence[GetRegionSort]: 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

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>: One or more key/value pairs on which to filter results
Sorts List<GetRegionSort>: One or more key/direction pairs on which to sort results

Id string: The provider-assigned unique ID for this managed resource.
Regions []GetRegionRegion
Filters []GetRegionFilter: One or more key/value pairs on which to filter results
Sorts []GetRegionSort: One or more key/direction pairs on which to sort results

id String: The provider-assigned unique ID for this managed resource.
regions List<GetRegionRegion>
filters List<GetRegionFilter>: One or more key/value pairs on which to filter results
sorts List<GetRegionSort>: One or more key/direction pairs on which to sort results

id string: The provider-assigned unique ID for this managed resource.
regions GetRegionRegion[]
filters GetRegionFilter[]: One or more key/value pairs on which to filter results
sorts GetRegionSort[]: One or more key/direction pairs on which to sort results

id str: The provider-assigned unique ID for this managed resource.
regions Sequence[GetRegionRegion]
filters Sequence[GetRegionFilter]: One or more key/value pairs on which to filter results
sorts Sequence[GetRegionSort]: One or more key/direction pairs on which to sort results

id String: The provider-assigned unique ID for this managed resource.
regions 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

GetRegionFilter

Key string: Filter regions by this key. This may be one of code, country, default, name.
Values List<string>: Only retrieves regions 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 regions by this key. This may be one of code, country, default, name.
Values []string: Only retrieves regions 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 regions by this key. This may be one of code, country, default, name.
values List<String>: Only retrieves regions 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 regions by this key. This may be one of code, country, default, name.
values string[]: Only retrieves regions 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 regions by this key. This may be one of code, country, default, name.
values Sequence[str]: Only retrieves regions 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 regions by this key. This may be one of code, country, default, name.
values List<String>: Only retrieves regions 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.

GetRegionRegion

Code string: The code of the region
Country string: The country of the region
Default bool: If the region is the default region, this will return true
Name string: A human name of the region

Code string: The code of the region
Country string: The country of the region
Default bool: If the region is the default region, this will return true
Name string: A human name of the region

code String: The code of the region
country String: The country of the region
default_ Boolean: If the region is the default region, this will return true
name String: A human name of the region

code string: The code of the region
country string: The country of the region
default boolean: If the region is the default region, this will return true
name string: A human name of the region

code str: The code of the region
country str: The country of the region
default bool: If the region is the default region, this will return true
name str: A human name of the region

code String: The code of the region
country String: The country of the region
default Boolean: If the region is the default region, this will return true
name String: A human name of the region

GetRegionSort

Key string: Sort regions by this key. This may be one of code, country, default, name.
Direction string: The sort direction. This may be either asc or desc.

Key string: Sort regions by this key. This may be one of code, country, default, name.
Direction string: The sort direction. This may be either asc or desc.

key String: Sort regions by this key. This may be one of code, country, default, name.
direction String: The sort direction. This may be either asc or desc.

key string: Sort regions by this key. This may be one of code, country, default, name.
direction string: The sort direction. This may be either asc or desc.

key str: Sort regions by this key. This may be one of code, country, default, name.
direction str: The sort direction. This may be either asc or desc.

key String: Sort regions by this key. This may be one of code, country, default, name.
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.

Civo v2.3.18 published on Tuesday, Jun 11, 2024 by Pulumi

pulumi/pulumi-civo

civo.getRegion

On this page

On this page

Using getRegion

getRegion Result

Supporting Types

GetRegionFilter

GetRegionRegion

GetRegionSort

Package Details

On this page

On this page