Want to learn about running containers in Lambda? Join our free hands-on workshop. Register Now

Module types/output

This page documents the language specification for the civo package. If you're looking for help working with the inputs, outputs, or functions of civo resources in a Pulumi program, please see the resource documentation for examples and API reference.

APIs

APIs

interface GetInstancesFilter

interface GetInstancesFilter

property key

key: string;

Filter the Instances by this key. This may be one of ‘id, hostname, publicIp, privateIp, pseudoIp, size, cpuCores, ramMb, diskGb, template or createdAt.

property values

values: string[];

A list of values to match against the key field. Only retrieves Instances where the key field takes on one or more of the values provided here.

interface GetInstancesInstance

interface GetInstancesInstance

property cpuCores

cpuCores: number;

Total cpu of the inatance.

property createdAt

createdAt: string;

The date of creation of the instance

property diskGb

diskGb: number;

The size of the disk.

property firewallId

firewallId: string;

The ID of the firewall used.

property hostname

hostname: string;

The Instance hostname.

property id

id: string;

The ID of the Instance.

property initialPassword

initialPassword: string;

Instance initial password

property initialUser

initialUser: string;

The name of the initial user created on the server.

property networkId

networkId: string;

This will be the ID of the network.

property notes

notes: string;

The notes of the instance.

property privateIp

privateIp: string;

The private ip.

property pseudoIp

pseudoIp: string;

Is the ip that is used to route the public ip from the internet to the instance using NAT

property publicIp

publicIp: string;

The public ip.

property ramMb

ramMb: number;

Total ram of the instance.

property reverseDns

reverseDns: string;

A fully qualified domain name.

property script

script: string;

the contents of a script uploaded

property size

size: string;

The name of the size.

property sshkeyId

sshkeyId: string;

The ID SSH.

property status

status: string;

The status of the instance

property tags

tags: string[];

An optional list of tags

property template

template: string;

The ID for the template to used to build the instance.

interface GetInstancesSizeFilter

interface GetInstancesSizeFilter

property key

key: string;

property values

values: string[];

interface GetInstancesSizeSize

interface GetInstancesSizeSize

property cpuCores

cpuCores: number;

property description

description: string;

property diskGb

diskGb: number;

property name

name: string;

property niceName

niceName: string;

property ramMb

ramMb: number;

property selectable

selectable: boolean;

interface GetInstancesSizeSort

interface GetInstancesSizeSort

property direction

direction?: undefined | string;

property key

key: string;

interface GetInstancesSort

interface GetInstancesSort

property direction

direction?: undefined | string;

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

property key

key: string;

Sort the Instance by this key. This may be one of id, hostname, publicIp, privateIp, pseudoIp, size, cpuCores, ramMb, diskGb, template or createdAt.

interface GetKubernetesClusterInstalledApplication

interface GetKubernetesClusterInstalledApplication

property application

application: string;

The name of the application

property category

category: string;

The category of the application

property installed

installed: boolean;

if installed or not

property version

version: string;

The version of the application

interface GetKubernetesClusterInstance

interface GetKubernetesClusterInstance

property cpuCores

cpuCores: number;

Total cpu of the inatance.

property createdAt

createdAt: string;

The date where the Kubernetes cluster was create.

property diskGb

diskGb: number;

The size of the disk.

property firewallId

firewallId: string;

The firewall id assigned to the instance

property hostname

hostname: string;

The hostname of the instance.

property publicIp

publicIp: string;

The public ip of the instances, only available if the instances is the master

property ramMb

ramMb: number;

Total ram of the instance

property region

region: string;

The region where instance are.

property size

size: string;

The size of the instance.

property status

status: string;

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

property tags

tags: string[];

The tag of the instances

interface GetKubernetesVersionFilter

interface GetKubernetesVersionFilter

property key

key: string;

Filter the sizes by this key. This may be one of version, label, type, default.

property values

values: string[];

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

interface GetKubernetesVersionSort

interface GetKubernetesVersionSort

property direction

direction?: undefined | string;

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

property key

key: string;

Sort the sizes by this key. This may be one of version.

interface GetKubernetesVersionVersion

interface GetKubernetesVersionVersion

property default

default: boolean;

If is the default version used in all cluster.

property label

label: string;

The label of this version.

property type

type: string;

The type of the version can be stable, legacy etc…

property version

version: string;

A version of the kubernetes.

interface GetLoadBalancerBackend

interface GetLoadBalancerBackend

property instanceId

instanceId: string;

The instance id

property port

port: number;

The port set in the configuration.

property protocol

protocol: string;

The protocol used in the configuration.

interface GetTemplateFilter

interface GetTemplateFilter

property key

key: string;

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

property values

values: string[];

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

interface GetTemplateSort

interface GetTemplateSort

property direction

direction?: undefined | string;

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

property key

key: string;

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

interface GetTemplateTemplate

interface GetTemplateTemplate

property cloudConfig

cloudConfig: string;

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

property code

code: string;

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

property defaultUsername

defaultUsername: string;

The default username to suggest that the user creates

property description

description: string;

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

property id

id: string;

The id of the template

property imageId

imageId: string;

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

property name

name: string;

A short human readable name for the template

property shortDescription

shortDescription: string;

A one line description of the template

property volumeId

volumeId: string;

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

interface KubernetesClusterInstalledApplication

interface KubernetesClusterInstalledApplication

property application

application: string;

The name of the application

property category

category: string;

The category of the application

property installed

installed: boolean;

if installed or not

property version

version: string;

The version of the application

interface KubernetesClusterInstance

interface KubernetesClusterInstance

property cpuCores

cpuCores: number;

Total cpu of the inatance.

property createdAt

createdAt: string;

The date where the Kubernetes cluster was create.

property diskGb

diskGb: number;

The size of the disk.

property firewallId

firewallId: string;

The firewall id assigned to the instance

property hostname

hostname: string;

The hostname of the instance.

property publicIp

publicIp: string;

The public ip of the instances, only available if the instances is the master

property ramMb

ramMb: number;

Total ram of the instance.

property region

region: string;

The region where instance are.

property size

size: string;

The size of the instance.

property status

status: string;

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

property tags

tags: string[];

A space separated list of tags, to be used freely as required.

interface LoadBalancerBackend

interface LoadBalancerBackend

property instanceId

instanceId: string;

property port

port: number;

property protocol

protocol: string;