getTemplate

Using getTemplate

function getTemplate(args: GetTemplateArgs, opts?: InvokeOptions): Promise<GetTemplateResult>
def get_template(filters: Optional[Sequence[GetTemplateFilter]] = None,
                 region: Optional[str] = None,
                 sorts: Optional[Sequence[GetTemplateSort]] = None,
                 opts: Optional[InvokeOptions] = None) -> GetTemplateResult
func LookupTemplate(ctx *Context, args *LookupTemplateArgs, opts ...InvokeOption) (*LookupTemplateResult, error)

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

public static class GetTemplate {
    public static Task<GetTemplateResult> InvokeAsync(GetTemplateArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Filters List<GetTemplateFilter>
Filter the results. The filter block is documented below.
Region string
If is used, them all template will be from that region, has to be declared here if is not declared in the provider
Sorts List<GetTemplateSort>
Sort the results. The sort block is documented below.
Filters []GetTemplateFilter
Filter the results. The filter block is documented below.
Region string
If is used, them all template will be from that region, has to be declared here if is not declared in the provider
Sorts []GetTemplateSort
Sort the results. The sort block is documented below.
filters GetTemplateFilter[]
Filter the results. The filter block is documented below.
region string
If is used, them all template will be from that region, has to be declared here if is not declared in the provider
sorts GetTemplateSort[]
Sort the results. The sort block is documented below.
filters Sequence[GetTemplateFilter]
Filter the results. The filter block is documented below.
region str
If is used, them all template will be from that region, has to be declared here if is not declared in the provider
sorts Sequence[GetTemplateSort]
Sort the results. The sort block is documented below.

getTemplate Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Templates List<GetTemplateTemplate>
Filters List<GetTemplateFilter>
Region string
Sorts List<GetTemplateSort>
Id string
The provider-assigned unique ID for this managed resource.
Templates []GetTemplateTemplate
Filters []GetTemplateFilter
Region string
Sorts []GetTemplateSort
id string
The provider-assigned unique ID for this managed resource.
templates GetTemplateTemplate[]
filters GetTemplateFilter[]
region string
sorts GetTemplateSort[]
id str
The provider-assigned unique ID for this managed resource.
templates Sequence[GetTemplateTemplate]
filters Sequence[GetTemplateFilter]
region str
sorts Sequence[GetTemplateSort]

Supporting Types

GetTemplateFilter

Key string
Filter the sizes by this key. This may be one of id,name,version,label.
Values List<string>
Only retrieves the template 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 id,name,version,label.
Values []string
Only retrieves the template 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 id,name,version,label.
values string[]
Only retrieves the template 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 id,name,version,label.
values Sequence[str]
Only retrieves the template which keys has value that matches one of the values provided here.
all bool
match_by str

GetTemplateSort

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

GetTemplateTemplate

Id string
The id of the template
Label string
The label of the template.
Name string
A short human readable name for the template
Version string
The version of the template.
Id string
The id of the template
Label string
The label of the template.
Name string
A short human readable name for the template
Version string
The version of the template.
id string
The id of the template
label string
The label of the template.
name string
A short human readable name for the template
version string
The version of the template.
id str
The id of the template
label str
The label of the template.
name str
A short human readable name for the template
version str
The version of the template.

Package Details

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