The Automation API is now available. No CLI. No human-in-the-loop. Just your code. Learn More

GetTemplate

Using GetTemplate

function getTemplate(args: GetTemplateArgs, opts?: InvokeOptions): Promise<GetTemplateResult>
def get_template(filters: Optional[Sequence[GetTemplateFilterArgs]] = None, sorts: Optional[Sequence[GetTemplateSortArgs]] = 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<GetTemplateFilterArgs>

Filter the results. The filter block is documented below.

Sorts List<GetTemplateSortArgs>

Sort the results. The sort block is documented below.

Filters []GetTemplateFilter

Filter the results. The filter block is documented below.

Sorts []GetTemplateSort

Sort the results. The sort block is documented below.

filters GetTemplateFilter[]

Filter the results. The filter block is documented below.

sorts GetTemplateSort[]

Sort the results. The sort block is documented below.

filters Sequence[GetTemplateFilterArgs]

Filter the results. The filter block is documented below.

sorts Sequence[GetTemplateSortArgs]

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>
Sorts List<GetTemplateSort>
Id string

The provider-assigned unique ID for this managed resource.

Templates []GetTemplateTemplate
Filters []GetTemplateFilter
Sorts []GetTemplateSort
id string

The provider-assigned unique ID for this managed resource.

templates GetTemplateTemplate[]
filters GetTemplateFilter[]
sorts GetTemplateSort[]
id str

The provider-assigned unique ID for this managed resource.

templates Sequence[GetTemplateTemplate]
filters Sequence[GetTemplateFilter]
sorts Sequence[GetTemplateSort]

Supporting Types

GetTemplateFilter

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Key string

Filter the sizes by this key. This may be one of code, name.

Values List<string>

Only retrieves the template which keys has value that matches one of the values provided here.

Key string

Filter the sizes by this key. This may be one of code, name.

Values []string

Only retrieves the template which keys has value that matches one of the values provided here.

key string

Filter the sizes by this key. This may be one of code, name.

values string[]

Only retrieves the template which keys has value that matches one of the values provided here.

key str

Filter the sizes by this key. This may be one of code, name.

values Sequence[str]

Only retrieves the template which keys has value that matches one of the values provided here.

GetTemplateSort

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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.

GetTemplateTemplate

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

CloudConfig string

Commonly referred to as ‘user-data’, this is a customisation script that is run after the instance is first booted.

Code string

A unqiue, alphanumerical, short, human readable code for the template.

DefaultUsername string

The default username to suggest that the user creates

Description string

A multi-line description of the template, in Markdown format

Id string

The id of the template

ImageId string

The Image ID of any default template or the ID of another template.

Name string

A short human readable name for the template

ShortDescription string

A one line description of the template

VolumeId string

The ID of a bootable volume, either owned by you or global.

CloudConfig string

Commonly referred to as ‘user-data’, this is a customisation script that is run after the instance is first booted.

Code string

A unqiue, alphanumerical, short, human readable code for the template.

DefaultUsername string

The default username to suggest that the user creates

Description string

A multi-line description of the template, in Markdown format

Id string

The id of the template

ImageId string

The Image ID of any default template or the ID of another template.

Name string

A short human readable name for the template

ShortDescription string

A one line description of the template

VolumeId string

The ID of a bootable volume, either owned by you or global.

cloudConfig string

Commonly referred to as ‘user-data’, this is a customisation script that is run after the instance is first booted.

code string

A unqiue, alphanumerical, short, human readable code for the template.

defaultUsername string

The default username to suggest that the user creates

description string

A multi-line description of the template, in Markdown format

id string

The id of the template

imageId string

The Image ID of any default template or the ID of another template.

name string

A short human readable name for the template

shortDescription string

A one line description of the template

volumeId string

The ID of a bootable volume, either owned by you or global.

cloud_config str

Commonly referred to as ‘user-data’, this is a customisation script that is run after the instance is first booted.

code str

A unqiue, alphanumerical, short, human readable code for the template.

default_username str

The default username to suggest that the user creates

description str

A multi-line description of the template, in Markdown format

id str

The id of the template

image_id str

The Image ID of any default template or the ID of another template.

name str

A short human readable name for the template

short_description str

A one line description of the template

volume_id str

The ID of a bootable volume, either owned by you or global.

Package Details

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