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

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.

Pulumi Civo

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-civo repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-civo repo.

class pulumi_civo.AwaitableGetDnsDomainNameResult(id=None, name=None)
class pulumi_civo.AwaitableGetDnsDomainRecordResult(account_id=None, created_at=None, domain_id=None, id=None, name=None, priority=None, ttl=None, type=None, updated_at=None, value=None)
class pulumi_civo.AwaitableGetInstanceResult(cpu_cores=None, created_at=None, disk_gb=None, firewall_id=None, hostname=None, id=None, initial_password=None, initial_user=None, network_id=None, notes=None, private_ip=None, pseudo_ip=None, public_ip=None, ram_mb=None, reverse_dns=None, script=None, size=None, sshkey_id=None, status=None, tags=None, template=None)
class pulumi_civo.AwaitableGetInstancesResult(filters=None, id=None, instances=None, sorts=None)
class pulumi_civo.AwaitableGetInstancesSizeResult(filters=None, id=None, sizes=None, sorts=None)
class pulumi_civo.AwaitableGetKubernetesClusterResult(api_endpoint=None, applications=None, built_at=None, created_at=None, dns_entry=None, id=None, installed_applications=None, instances=None, kubeconfig=None, kubernetes_version=None, master_ip=None, name=None, num_target_nodes=None, ready=None, status=None, tags=None, target_nodes_size=None)
class pulumi_civo.AwaitableGetKubernetesVersionResult(filters=None, id=None, sorts=None, versions=None)
class pulumi_civo.AwaitableGetLoadBalancerResult(backends=None, fail_timeout=None, health_check_path=None, hostname=None, id=None, ignore_invalid_backend_tls=None, max_conns=None, max_request_size=None, policy=None, port=None, protocol=None, tls_certificate=None, tls_key=None)
class pulumi_civo.AwaitableGetNetworkResult(cidr=None, default=None, id=None, label=None, name=None, region=None)
class pulumi_civo.AwaitableGetSnapshotResult(completed_at=None, cron_timing=None, hostname=None, id=None, instance_id=None, name=None, next_execution=None, region=None, requested_at=None, safe=None, size_gb=None, state=None, template_id=None)
class pulumi_civo.AwaitableGetSshKeyResult(fingerprint=None, id=None, name=None)
class pulumi_civo.AwaitableGetTemplateResult(filters=None, id=None, sorts=None, templates=None)
class pulumi_civo.AwaitableGetVolumeResult(bootable=None, created_at=None, id=None, mount_point=None, name=None, size_gb=None)
class pulumi_civo.DnsDomainName(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, name: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Provides a Civo dns domain name resource.

import pulumi
import pulumi_civo as civo

# Create a new domain name
main = civo.DnsDomainName("main")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the domain

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, account_id: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.dns_domain_name.DnsDomainName

Get an existing DnsDomainName resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • account_id (pulumi.Input[str]) – The id account of the domain

  • name (pulumi.Input[str]) – The name of the domain

property account_id

The id account of the domain

property name

The name of the domain

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.DnsDomainRecord(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, domain_id: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, priority: Union[float, Awaitable[float], Output[T], None] = None, ttl: Union[float, Awaitable[float], Output[T], None] = None, type: Union[str, Awaitable[str], Output[T], None] = None, value: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Provides a Civo dns domain record resource.

import pulumi
import pulumi_civo as civo

# Create a new domain record
www = civo.DnsDomainRecord("www",
    domain_id=civo_dns_domain_name["main"]["id"],
    type="A",
    value=civo_instance["foo"]["public_ip"],
    ttl=600,
    opts=ResourceOptions(depends_on=[
            civo_dns_domain_name["main"],
            civo_instance["foo"],
        ]))
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • domain_id (pulumi.Input[str]) – The id of the domain

  • name (pulumi.Input[str]) – The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)

  • priority (pulumi.Input[float]) – Useful for MX records only, the priority mail should be attempted it (defaults to 10)

  • ttl (pulumi.Input[float]) – How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)

  • type (pulumi.Input[str]) – The choice of record type from A, CNAME, MX, SRV or TXT

  • value (pulumi.Input[str]) – The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, account_id: Union[str, Awaitable[str], Output[T], None] = None, created_at: Union[str, Awaitable[str], Output[T], None] = None, domain_id: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, priority: Union[float, Awaitable[float], Output[T], None] = None, ttl: Union[float, Awaitable[float], Output[T], None] = None, type: Union[str, Awaitable[str], Output[T], None] = None, updated_at: Union[str, Awaitable[str], Output[T], None] = None, value: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.dns_domain_record.DnsDomainRecord

Get an existing DnsDomainRecord resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • account_id (pulumi.Input[str]) – The id account of the domain

  • created_at (pulumi.Input[str]) – The date when it was created in UTC format

  • domain_id (pulumi.Input[str]) – The id of the domain

  • name (pulumi.Input[str]) – The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)

  • priority (pulumi.Input[float]) – Useful for MX records only, the priority mail should be attempted it (defaults to 10)

  • ttl (pulumi.Input[float]) – How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)

  • type (pulumi.Input[str]) – The choice of record type from A, CNAME, MX, SRV or TXT

  • updated_at (pulumi.Input[str]) – The date when it was updated in UTC format

  • value (pulumi.Input[str]) – The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record

property account_id

The id account of the domain

property created_at

The date when it was created in UTC format

property domain_id

The id of the domain

property name

The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)

property priority

Useful for MX records only, the priority mail should be attempted it (defaults to 10)

property ttl

How long caching DNS servers should cache this record for, in seconds (the minimum is 600 and the default if unspecified is 600)

property type

The choice of record type from A, CNAME, MX, SRV or TXT

property updated_at

The date when it was updated in UTC format

property value

The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.Firewall(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, name: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Provides a Civo Cloud Firewall resource. This can be used to create, modify, and delete Firewalls.

import pulumi
import pulumi_civo as civo

www = civo.Firewall("www")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The Firewall name

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, name: Union[str, Awaitable[str], Output[T], None] = None, region: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.firewall.Firewall

Get an existing Firewall resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The Firewall name

  • region (pulumi.Input[str]) – The region where the firewall was create.

property name

The Firewall name

property region

The region where the firewall was create.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.FirewallRule(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, cidrs: Union[List[Union[str, Awaitable[str], Output[T]]], Awaitable[List[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, direction: Union[str, Awaitable[str], Output[T], None] = None, end_port: Union[str, Awaitable[str], Output[T], None] = None, firewall_id: Union[str, Awaitable[str], Output[T], None] = None, label: Union[str, Awaitable[str], Output[T], None] = None, protocol: Union[str, Awaitable[str], Output[T], None] = None, start_port: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Provides a Civo Cloud Firewall Rule resource. This can be used to create, modify, and delete Firewalls Rules. This resource don’t have an update option because the backend don’t have the support for that, so in this case we use ForceNew for all object in the resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cidrs (pulumi.Input[List[pulumi.Input[str]]]) – the IP address of the other end (i.e. not your instance) to affect, or a valid network CIDR (defaults to being globally applied, i.e. 0.0.0.0/0).

  • direction (pulumi.Input[str]) – will this rule affect ingress traffic

  • end_port (pulumi.Input[str]) – The end port where traffic to be allowed.

  • firewall_id (pulumi.Input[str]) – The Firewall id

  • label (pulumi.Input[str]) – a string that will be the displayed name/reference for this rule (optional)

  • protocol (pulumi.Input[str]) – This may be one of “tcp”, “udp”, or “icmp”.

  • start_port (pulumi.Input[str]) – The start port where traffic to be allowed.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, cidrs: Union[List[Union[str, Awaitable[str], Output[T]]], Awaitable[List[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, direction: Union[str, Awaitable[str], Output[T], None] = None, end_port: Union[str, Awaitable[str], Output[T], None] = None, firewall_id: Union[str, Awaitable[str], Output[T], None] = None, label: Union[str, Awaitable[str], Output[T], None] = None, protocol: Union[str, Awaitable[str], Output[T], None] = None, start_port: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.firewall_rule.FirewallRule

Get an existing FirewallRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cidrs (pulumi.Input[List[pulumi.Input[str]]]) – the IP address of the other end (i.e. not your instance) to affect, or a valid network CIDR (defaults to being globally applied, i.e. 0.0.0.0/0).

  • direction (pulumi.Input[str]) – will this rule affect ingress traffic

  • end_port (pulumi.Input[str]) – The end port where traffic to be allowed.

  • firewall_id (pulumi.Input[str]) – The Firewall id

  • label (pulumi.Input[str]) – a string that will be the displayed name/reference for this rule (optional)

  • protocol (pulumi.Input[str]) – This may be one of “tcp”, “udp”, or “icmp”.

  • start_port (pulumi.Input[str]) – The start port where traffic to be allowed.

property cidrs

the IP address of the other end (i.e. not your instance) to affect, or a valid network CIDR (defaults to being globally applied, i.e. 0.0.0.0/0).

property direction

will this rule affect ingress traffic

property end_port

The end port where traffic to be allowed.

property firewall_id

The Firewall id

property label

a string that will be the displayed name/reference for this rule (optional)

property protocol

This may be one of “tcp”, “udp”, or “icmp”.

property start_port

The start port where traffic to be allowed.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.GetDnsDomainNameResult(id=None, name=None)

A collection of values returned by getDnsDomainName.

property id

A unique ID that can be used to identify and reference a domain.

property name

The name of the domain.

class pulumi_civo.GetDnsDomainRecordResult(account_id=None, created_at=None, domain_id=None, id=None, name=None, priority=None, ttl=None, type=None, updated_at=None, value=None)

A collection of values returned by getDnsDomainRecord.

property account_id

The id account of the domain.

property created_at

The date when it was created in UTC format

property domain_id

The id of the domain

property id

The provider-assigned unique ID for this managed resource.

property name

The portion before the domain name (e.g. www) or an @ for the apex/root domain (you cannot use an A record with an amex/root domain)

property priority

The priority of the record.

property ttl

How long caching DNS servers should cache this record.

property type

The choice of record type from A, CNAME, MX, SRV or TXT

property updated_at

The date when it was updated in UTC format

property value

The IP address (A or MX), hostname (CNAME or MX) or text value (TXT) to serve for this record

class pulumi_civo.GetInstanceResult(cpu_cores=None, created_at=None, disk_gb=None, firewall_id=None, hostname=None, id=None, initial_password=None, initial_user=None, network_id=None, notes=None, private_ip=None, pseudo_ip=None, public_ip=None, ram_mb=None, reverse_dns=None, script=None, size=None, sshkey_id=None, status=None, tags=None, template=None)

A collection of values returned by getInstance.

property cpu_cores

Total cpu of the inatance.

property created_at

The date of creation of the instance

property disk_gb

The size of the disk.

property firewall_id

The ID of the firewall used.

property hostname

The Instance hostname.

property id

The ID of the Instance.

property initial_password

Instance initial password

property initial_user

The name of the initial user created on the server.

property network_id

This will be the ID of the network.

property notes

The notes of the instance.

property private_ip

The private ip.

property pseudo_ip

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

property public_ip

The public ip.

property ram_mb

Total ram of the instance.

property reverse_dns

A fully qualified domain name.

property script

the contents of a script uploaded

property size

The name of the size.

property sshkey_id

The ID SSH.

property status

The status of the instance

property tags

An optional list of tags

property template

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

class pulumi_civo.GetInstancesResult(filters=None, id=None, instances=None, sorts=None)

A collection of values returned by getInstances.

property id

The provider-assigned unique ID for this managed resource.

property instances

A list of Instances satisfying any filter and sort criteria. Each instance has the following attributes:

class pulumi_civo.GetInstancesSizeResult(filters=None, id=None, sizes=None, sorts=None)

A collection of values returned by getInstancesSize.

property id

The provider-assigned unique ID for this managed resource.

class pulumi_civo.GetKubernetesClusterResult(api_endpoint=None, applications=None, built_at=None, created_at=None, dns_entry=None, id=None, installed_applications=None, instances=None, kubeconfig=None, kubernetes_version=None, master_ip=None, name=None, num_target_nodes=None, ready=None, status=None, tags=None, target_nodes_size=None)

A collection of values returned by getKubernetesCluster.

property api_endpoint

The base URL of the API server on the Kubernetes master node.

property applications

A list of application installed.

property built_at

The date where the Kubernetes cluster was build.

property created_at

The date where the Kubernetes cluster was create.

property dns_entry

The unique dns entry for the cluster in this case point to the master.

property id

A unique ID that can be used to identify and reference a Kubernetes cluster.

property installed_applications

A unique ID that can be used to identify and reference a Kubernetes cluster.

property instances

In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

property kubeconfig

A representation of the Kubernetes cluster’s kubeconfig in yaml format.

property kubernetes_version

The version of Kubernetes.

property master_ip

The Ip of the Kubernetes master node.

property name

The name of your cluster,.

property num_target_nodes

The size of the Kubernetes cluster.

property status

The status of Kubernetes cluster.

  • ready -If the Kubernetes cluster is ready.

property tags

The tag of the instances

property target_nodes_size

The size of each node.

class pulumi_civo.GetKubernetesVersionResult(filters=None, id=None, sorts=None, versions=None)

A collection of values returned by getKubernetesVersion.

property id

The provider-assigned unique ID for this managed resource.

class pulumi_civo.GetLoadBalancerResult(backends=None, fail_timeout=None, health_check_path=None, hostname=None, id=None, ignore_invalid_backend_tls=None, max_conns=None, max_request_size=None, policy=None, port=None, protocol=None, tls_certificate=None, tls_key=None)

A collection of values returned by getLoadBalancer.

property backends

A list of backend instances

property fail_timeout

The wait time until the backend is marked as a failure

property health_check_path

The path to check the health of the backend

property hostname

The hostname of the Load Balancer

property id

The ID of the Load Balancer

property ignore_invalid_backend_tls

Should self-signed/invalid certificates be ignored from the backend servers

property max_conns

How many concurrent connections can each backend handle

property max_request_size

The max request size set in the configuration

property policy

The policy set in the Load Balancer

property port

The port set in the configuration.

property protocol

The protocol used in the configuration.

property tls_certificate

If is set will be returned

property tls_key

If is set will be returned

class pulumi_civo.GetNetworkResult(cidr=None, default=None, id=None, label=None, name=None, region=None)

A collection of values returned by getNetwork.

property cidr

The block ip assigned to the network.

property default

If is the default network.

property id

A unique ID that can be used to identify and reference a Network.

property label

The label used in the configuration.

property name

The name of the network.

property region

The region where the network was create.

class pulumi_civo.GetSnapshotResult(completed_at=None, cron_timing=None, hostname=None, id=None, instance_id=None, name=None, next_execution=None, region=None, requested_at=None, safe=None, size_gb=None, state=None, template_id=None)

A collection of values returned by getSnapshot.

property completed_at

The date where the snapshot was completed.

property cron_timing

A string with the cron format.

property hostname

The hostname of the instance.

property instance_id

The ID of the Instance from which the snapshot was be taken.

property name

The name of the snapshot.

property next_execution

if cron was define this date will be the next execution date.

property region

The region where the snapshot was take.

property requested_at

The date where the snapshot was requested.

property safe

If is true the instance will be shut down during the snapshot if id false them not.

property size_gb

The size of the snapshot in GB.

property state

The status of the snapshot.

property template_id

The template id.

class pulumi_civo.GetSshKeyResult(fingerprint=None, id=None, name=None)

A collection of values returned by getSshKey.

class pulumi_civo.GetTemplateResult(filters=None, id=None, sorts=None, templates=None)

A collection of values returned by getTemplate.

property id

The provider-assigned unique ID for this managed resource.

class pulumi_civo.GetVolumeResult(bootable=None, created_at=None, id=None, mount_point=None, name=None, size_gb=None)

A collection of values returned by getVolume.

property bootable

if is bootable or not.

property created_at

The date of the creation of the volume.

property id

The unique identifier for the volume.

property mount_point

The mount point of the volume.

property name

Name of the volume.

property size_gb

The size of the volume.

class pulumi_civo.Instance(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, firewall_id: Union[str, Awaitable[str], Output[T], None] = None, hostname: Union[str, Awaitable[str], Output[T], None] = None, initial_user: Union[str, Awaitable[str], Output[T], None] = None, network_id: Union[str, Awaitable[str], Output[T], None] = None, notes: Union[str, Awaitable[str], Output[T], None] = None, public_ip_required: Union[str, Awaitable[str], Output[T], None] = None, reverse_dns: Union[str, Awaitable[str], Output[T], None] = None, script: Union[str, Awaitable[str], Output[T], None] = None, size: Union[str, Awaitable[str], Output[T], None] = None, sshkey_id: Union[str, Awaitable[str], Output[T], None] = None, tags: Union[List[Union[str, Awaitable[str], Output[T]]], Awaitable[List[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, template: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Provides a Civo Instance resource. This can be used to create, modify, and delete Instances.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • firewall_id (pulumi.Input[str]) – The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all).

  • hostname (pulumi.Input[str]) – The Instance hostname.

  • initial_user (pulumi.Input[str]) – The name of the initial user created on the server (optional; this will default to the template’s default_username and fallback to civo).

  • network_id (pulumi.Input[str]) – This must be the ID of the network from the network listing (optional; default network used when not specified).

  • notes (pulumi.Input[str]) – Add some notes to the instance.

  • public_ip_required (pulumi.Input[str]) – This should be either false, true or move_ip_from:intances_id.

  • reverse_dns (pulumi.Input[str]) – A fully qualified domain name that should be used as the instance’s IP’s reverse DNS (optional, uses the hostname if unspecified).

  • script (pulumi.Input[str]) – the contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization

  • size (pulumi.Input[str]) – The name of the size, from the current list, e.g. g2.small (required).

  • sshkey_id (pulumi.Input[str]) – The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn’t provided a random password will be set and returned in the initial_password field).

  • tags (pulumi.Input[List[pulumi.Input[str]]]) – An optional list of tags, represented as a key, value pair.

  • template (pulumi.Input[str]) – The ID for the template to use to build the instance.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, cpu_cores: Union[float, Awaitable[float], Output[T], None] = None, created_at: Union[str, Awaitable[str], Output[T], None] = None, disk_gb: Union[float, Awaitable[float], Output[T], None] = None, firewall_id: Union[str, Awaitable[str], Output[T], None] = None, hostname: Union[str, Awaitable[str], Output[T], None] = None, initial_password: Union[str, Awaitable[str], Output[T], None] = None, initial_user: Union[str, Awaitable[str], Output[T], None] = None, network_id: Union[str, Awaitable[str], Output[T], None] = None, notes: Union[str, Awaitable[str], Output[T], None] = None, private_ip: Union[str, Awaitable[str], Output[T], None] = None, pseudo_ip: Union[str, Awaitable[str], Output[T], None] = None, public_ip: Union[str, Awaitable[str], Output[T], None] = None, public_ip_required: Union[str, Awaitable[str], Output[T], None] = None, ram_mb: Union[float, Awaitable[float], Output[T], None] = None, reverse_dns: Union[str, Awaitable[str], Output[T], None] = None, script: Union[str, Awaitable[str], Output[T], None] = None, size: Union[str, Awaitable[str], Output[T], None] = None, sshkey_id: Union[str, Awaitable[str], Output[T], None] = None, status: Union[str, Awaitable[str], Output[T], None] = None, tags: Union[List[Union[str, Awaitable[str], Output[T]]], Awaitable[List[Union[str, Awaitable[str], Output[T]]]], Output[T], None] = None, template: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.instance.Instance

Get an existing Instance resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cpu_cores (pulumi.Input[float]) – Total cpu of the inatance.

  • created_at (pulumi.Input[str]) – The date of creation of the instance

  • disk_gb (pulumi.Input[float]) – The size of the disk.

  • firewall_id (pulumi.Input[str]) – The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all).

  • hostname (pulumi.Input[str]) – The Instance hostname.

  • initial_password (pulumi.Input[str]) – Instance initial password

  • initial_user (pulumi.Input[str]) – The name of the initial user created on the server (optional; this will default to the template’s default_username and fallback to civo).

  • network_id (pulumi.Input[str]) – This must be the ID of the network from the network listing (optional; default network used when not specified).

  • notes (pulumi.Input[str]) – Add some notes to the instance.

  • private_ip (pulumi.Input[str]) – The private ip.

  • pseudo_ip (pulumi.Input[str]) – Is the ip that is used to route the public ip from the internet to the instance using NAT

  • public_ip (pulumi.Input[str]) – The public ip.

  • public_ip_required (pulumi.Input[str]) – This should be either false, true or move_ip_from:intances_id.

  • ram_mb (pulumi.Input[float]) – Total ram of the instance.

  • reverse_dns (pulumi.Input[str]) – A fully qualified domain name that should be used as the instance’s IP’s reverse DNS (optional, uses the hostname if unspecified).

  • script (pulumi.Input[str]) – the contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization

  • size (pulumi.Input[str]) – The name of the size, from the current list, e.g. g2.small (required).

  • sshkey_id (pulumi.Input[str]) – The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn’t provided a random password will be set and returned in the initial_password field).

  • status (pulumi.Input[str]) – The status of the instance

  • tags (pulumi.Input[List[pulumi.Input[str]]]) – An optional list of tags, represented as a key, value pair.

  • template (pulumi.Input[str]) – The ID for the template to use to build the instance.

property cpu_cores

Total cpu of the inatance.

property created_at

The date of creation of the instance

property disk_gb

The size of the disk.

property firewall_id

The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all).

property hostname

The Instance hostname.

property initial_password

Instance initial password

property initial_user

The name of the initial user created on the server (optional; this will default to the template’s default_username and fallback to civo).

property network_id

This must be the ID of the network from the network listing (optional; default network used when not specified).

property notes

Add some notes to the instance.

property private_ip

The private ip.

property pseudo_ip

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

property public_ip

The public ip.

property public_ip_required

This should be either false, true or move_ip_from:intances_id.

property ram_mb

Total ram of the instance.

property reverse_dns

A fully qualified domain name that should be used as the instance’s IP’s reverse DNS (optional, uses the hostname if unspecified).

property script

the contents of a script that will be uploaded to /usr/local/bin/civo-user-init-script on your instance, read/write/executable only by root and then will be executed at the end of the cloud initialization

property size

The name of the size, from the current list, e.g. g2.small (required).

property sshkey_id

The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn’t provided a random password will be set and returned in the initial_password field).

property status

The status of the instance

property tags

An optional list of tags, represented as a key, value pair.

property template

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.KubernetesCluster(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, applications: Union[str, Awaitable[str], Output[T], None] = None, kubernetes_version: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, num_target_nodes: Union[float, Awaitable[float], Output[T], None] = None, tags: Union[str, Awaitable[str], Output[T], None] = None, target_nodes_size: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Create a KubernetesCluster resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] applications: A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-‘, e.g. -traefik :param pulumi.Input[str] kubernetes_version: The version of k3s to install (The default is currently the latest available). :param pulumi.Input[str] name: A name for the Kubernetes cluster. :param pulumi.Input[float] num_target_nodes: The number of instances to create (The default at the time of writing is 3). :param pulumi.Input[str] tags: A space separated list of tags, to be used freely as required. :param pulumi.Input[str] target_nodes_size: The size of each node (The default is currently g2.small)

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, api_endpoint: Union[str, Awaitable[str], Output[T], None] = None, applications: Union[str, Awaitable[str], Output[T], None] = None, built_at: Union[str, Awaitable[str], Output[T], None] = None, created_at: Union[str, Awaitable[str], Output[T], None] = None, dns_entry: Union[str, Awaitable[str], Output[T], None] = None, installed_applications: Union[List[Union[KubernetesClusterInstalledApplicationArgs, Mapping[str, Any], Awaitable[Union[KubernetesClusterInstalledApplicationArgs, Mapping[str, Any]]], Output[T]]], Awaitable[List[Union[KubernetesClusterInstalledApplicationArgs, Mapping[str, Any], Awaitable[Union[KubernetesClusterInstalledApplicationArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, instances: Union[List[Union[KubernetesClusterInstanceArgs, Mapping[str, Any], Awaitable[Union[KubernetesClusterInstanceArgs, Mapping[str, Any]]], Output[T]]], Awaitable[List[Union[KubernetesClusterInstanceArgs, Mapping[str, Any], Awaitable[Union[KubernetesClusterInstanceArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, kubeconfig: Union[str, Awaitable[str], Output[T], None] = None, kubernetes_version: Union[str, Awaitable[str], Output[T], None] = None, master_ip: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, num_target_nodes: Union[float, Awaitable[float], Output[T], None] = None, ready: Union[bool, Awaitable[bool], Output[T], None] = None, status: Union[str, Awaitable[str], Output[T], None] = None, tags: Union[str, Awaitable[str], Output[T], None] = None, target_nodes_size: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.kubernetes_cluster.KubernetesCluster

Get an existing KubernetesCluster resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • api_endpoint (pulumi.Input[str]) – The base URL of the API server on the Kubernetes master node.

  • applications (pulumi.Input[str]) – A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-‘, e.g. -traefik

  • built_at (pulumi.Input[str]) – The date where the Kubernetes cluster was build.

  • created_at (pulumi.Input[str]) – The date where the Kubernetes cluster was create.

  • dns_entry (pulumi.Input[str]) – The unique dns entry for the cluster in this case point to the master.

  • installed_applications (pulumi.Input[List[pulumi.Input[pulumi.InputType['KubernetesClusterInstalledApplicationArgs']]]]) – A unique ID that can be used to identify and reference a Kubernetes cluster.

  • instances (pulumi.Input[List[pulumi.Input[pulumi.InputType['KubernetesClusterInstanceArgs']]]]) – In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

  • kubeconfig (pulumi.Input[str]) – A representation of the Kubernetes cluster’s kubeconfig in yaml format.

  • kubernetes_version (pulumi.Input[str]) – The version of k3s to install (The default is currently the latest available).

  • master_ip (pulumi.Input[str]) – The Ip of the Kubernetes master node.

  • name (pulumi.Input[str]) – A name for the Kubernetes cluster.

  • num_target_nodes (pulumi.Input[float]) – The number of instances to create (The default at the time of writing is 3).

  • status (pulumi.Input[str]) – The status of Kubernetes cluster.

* `ready` -If the Kubernetes cluster is ready.
Parameters
  • tags (pulumi.Input[str]) – A space separated list of tags, to be used freely as required.

  • target_nodes_size (pulumi.Input[str]) – The size of each node (The default is currently g2.small)

property api_endpoint

The base URL of the API server on the Kubernetes master node.

property applications

A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-‘, e.g. -traefik

property built_at

The date where the Kubernetes cluster was build.

property created_at

The date where the Kubernetes cluster was create.

property dns_entry

The unique dns entry for the cluster in this case point to the master.

property installed_applications

A unique ID that can be used to identify and reference a Kubernetes cluster.

property instances

In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

property kubeconfig

A representation of the Kubernetes cluster’s kubeconfig in yaml format.

property kubernetes_version

The version of k3s to install (The default is currently the latest available).

property master_ip

The Ip of the Kubernetes master node.

property name

A name for the Kubernetes cluster.

property num_target_nodes

The number of instances to create (The default at the time of writing is 3).

property status

The status of Kubernetes cluster.

  • ready -If the Kubernetes cluster is ready.

property tags

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

property target_nodes_size

The size of each node (The default is currently g2.small)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.LoadBalancer(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, backends: Union[List[Union[LoadBalancerBackendArgs, Mapping[str, Any], Awaitable[Union[LoadBalancerBackendArgs, Mapping[str, Any]]], Output[T]]], Awaitable[List[Union[LoadBalancerBackendArgs, Mapping[str, Any], Awaitable[Union[LoadBalancerBackendArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, fail_timeout: Union[float, Awaitable[float], Output[T], None] = None, health_check_path: Union[str, Awaitable[str], Output[T], None] = None, hostname: Union[str, Awaitable[str], Output[T], None] = None, ignore_invalid_backend_tls: Union[bool, Awaitable[bool], Output[T], None] = None, max_conns: Union[float, Awaitable[float], Output[T], None] = None, max_request_size: Union[float, Awaitable[float], Output[T], None] = None, policy: Union[str, Awaitable[str], Output[T], None] = None, port: Union[float, Awaitable[float], Output[T], None] = None, protocol: Union[str, Awaitable[str], Output[T], None] = None, tls_certificate: Union[str, Awaitable[str], Output[T], None] = None, tls_key: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Create a LoadBalancer resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[List[pulumi.Input[pulumi.InputType[‘LoadBalancerBackendArgs’]]]] backends: a list of backend instances, each containing an instance_id, protocol (http or https) and port :param pulumi.Input[float] fail_timeout: how long to wait in seconds before determining a backend has failed, defaults to 30 :param pulumi.Input[str] health_check_path: what URL should be used on the backends to determine if it’s OK (2xx/3xx status), defaults to / :param pulumi.Input[str] hostname: the hostname to receive traffic for, e.g. www.example.com (optional: sets hostname to loadbalancer-uuid.civo.com if

blank)

Parameters
  • ignore_invalid_backend_tls (pulumi.Input[bool]) – should self-signed/invalid certificates be ignored from the backend servers, defaults to true

  • max_conns (pulumi.Input[float]) – how many concurrent connections can each backend handle, defaults to 10

  • max_request_size (pulumi.Input[float]) – the size in megabytes of the maximum request content that will be accepted, defaults to 20

  • policy (pulumi.Input[str]) – one of: least_conn (sends new requests to the least busy server), random (sends new requests to a random backend), round_robin (sends new requests to the next backend in order), ip_hash (sends requests from a given IP address to the same backend), default is random

  • port (pulumi.Input[float]) – you can listen on any port, the default is 80 to match the default protocol of http,if not you must specify it here (commonly 80 for HTTP or 443 for HTTPS)

  • protocol (pulumi.Input[str]) – either http or https. If you specify https then you must also provide the next two fields, the default is http

  • tls_certificate (pulumi.Input[str]) – if your protocol is https then you should send the TLS certificate in Base64-encoded PEM format

  • tls_key (pulumi.Input[str]) – if your protocol is https then you should send the TLS private key in Base64-encoded PEM format

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, backends: Union[List[Union[LoadBalancerBackendArgs, Mapping[str, Any], Awaitable[Union[LoadBalancerBackendArgs, Mapping[str, Any]]], Output[T]]], Awaitable[List[Union[LoadBalancerBackendArgs, Mapping[str, Any], Awaitable[Union[LoadBalancerBackendArgs, Mapping[str, Any]]], Output[T]]]], Output[T], None] = None, fail_timeout: Union[float, Awaitable[float], Output[T], None] = None, health_check_path: Union[str, Awaitable[str], Output[T], None] = None, hostname: Union[str, Awaitable[str], Output[T], None] = None, ignore_invalid_backend_tls: Union[bool, Awaitable[bool], Output[T], None] = None, max_conns: Union[float, Awaitable[float], Output[T], None] = None, max_request_size: Union[float, Awaitable[float], Output[T], None] = None, policy: Union[str, Awaitable[str], Output[T], None] = None, port: Union[float, Awaitable[float], Output[T], None] = None, protocol: Union[str, Awaitable[str], Output[T], None] = None, tls_certificate: Union[str, Awaitable[str], Output[T], None] = None, tls_key: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.load_balancer.LoadBalancer

Get an existing LoadBalancer resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • backends (pulumi.Input[List[pulumi.Input[pulumi.InputType['LoadBalancerBackendArgs']]]]) – a list of backend instances, each containing an instance_id, protocol (http or https) and port

  • fail_timeout (pulumi.Input[float]) – how long to wait in seconds before determining a backend has failed, defaults to 30

  • health_check_path (pulumi.Input[str]) – what URL should be used on the backends to determine if it’s OK (2xx/3xx status), defaults to /

  • hostname (pulumi.Input[str]) – the hostname to receive traffic for, e.g. www.example.com (optional: sets hostname to loadbalancer-uuid.civo.com if blank)

  • ignore_invalid_backend_tls (pulumi.Input[bool]) – should self-signed/invalid certificates be ignored from the backend servers, defaults to true

  • max_conns (pulumi.Input[float]) – how many concurrent connections can each backend handle, defaults to 10

  • max_request_size (pulumi.Input[float]) – the size in megabytes of the maximum request content that will be accepted, defaults to 20

  • policy (pulumi.Input[str]) – one of: least_conn (sends new requests to the least busy server), random (sends new requests to a random backend), round_robin (sends new requests to the next backend in order), ip_hash (sends requests from a given IP address to the same backend), default is random

  • port (pulumi.Input[float]) – you can listen on any port, the default is 80 to match the default protocol of http,if not you must specify it here (commonly 80 for HTTP or 443 for HTTPS)

  • protocol (pulumi.Input[str]) – either http or https. If you specify https then you must also provide the next two fields, the default is http

  • tls_certificate (pulumi.Input[str]) – if your protocol is https then you should send the TLS certificate in Base64-encoded PEM format

  • tls_key (pulumi.Input[str]) – if your protocol is https then you should send the TLS private key in Base64-encoded PEM format

property backends

a list of backend instances, each containing an instance_id, protocol (http or https) and port

property fail_timeout

how long to wait in seconds before determining a backend has failed, defaults to 30

property health_check_path

what URL should be used on the backends to determine if it’s OK (2xx/3xx status), defaults to /

property hostname

the hostname to receive traffic for, e.g. www.example.com (optional: sets hostname to loadbalancer-uuid.civo.com if blank)

property ignore_invalid_backend_tls

should self-signed/invalid certificates be ignored from the backend servers, defaults to true

property max_conns

how many concurrent connections can each backend handle, defaults to 10

property max_request_size

the size in megabytes of the maximum request content that will be accepted, defaults to 20

property policy

one of: least_conn (sends new requests to the least busy server), random (sends new requests to a random backend), round_robin (sends new requests to the next backend in order), ip_hash (sends requests from a given IP address to the same backend), default is random

property port

you can listen on any port, the default is 80 to match the default protocol of http,if not you must specify it here (commonly 80 for HTTP or 443 for HTTPS)

property protocol

either http or https. If you specify https then you must also provide the next two fields, the default is http

property tls_certificate

if your protocol is https then you should send the TLS certificate in Base64-encoded PEM format

property tls_key

if your protocol is https then you should send the TLS private key in Base64-encoded PEM format

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.Network(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, label: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Provides a Civo Network resource. This can be used to create, modify, and delete Networks.

import pulumi
import pulumi_civo as civo

custom_net = civo.Network("customNet", label="test_network")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • label (pulumi.Input[str]) – The Network label

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, cidr: Union[str, Awaitable[str], Output[T], None] = None, default: Union[bool, Awaitable[bool], Output[T], None] = None, label: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, region: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.network.Network

Get an existing Network resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cidr (pulumi.Input[str]) – The block ip assigned to the network.

  • default (pulumi.Input[bool]) – If is the default network.

  • label (pulumi.Input[str]) – The Network label

  • name (pulumi.Input[str]) – The name of the network.

  • region (pulumi.Input[str]) – The region where the network was create.

property cidr

The block ip assigned to the network.

property default

If is the default network.

property label

The Network label

property name

The name of the network.

property region

The region where the network was create.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.Provider(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, token: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

The provider type for the civo package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Parameters
translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.Snapshot(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, cron_timing: Union[str, Awaitable[str], Output[T], None] = None, instance_id: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, safe: Union[bool, Awaitable[bool], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Provides a resource which can be used to create a snapshot from an existing Civo Instance.

import pulumi
import pulumi_civo as civo

myinstance_backup = civo.Snapshot("myinstance-backup", instance_id=civo_instance["myinstance"]["id"])
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cron_timing (pulumi.Input[str]) – If a valid cron string is passed, the snapshot will be saved as an automated snapshot continuing to automatically update based on the schedule of the cron sequence provided The default is nil meaning the snapshot will be saved as a one-off snapshot.

  • instance_id (pulumi.Input[str]) – The ID of the Instance from which the snapshot will be taken.

  • name (pulumi.Input[str]) – A name for the instance snapshot.

  • safe (pulumi.Input[bool]) – If true the instance will be shut down during the snapshot to ensure all files are in a consistent state (e.g. database tables aren’t in the middle of being optimised and hence risking corruption). The default is false so you experience no interruption of service, but a small risk of corruption.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, completed_at: Union[str, Awaitable[str], Output[T], None] = None, cron_timing: Union[str, Awaitable[str], Output[T], None] = None, hostname: Union[str, Awaitable[str], Output[T], None] = None, instance_id: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, next_execution: Union[str, Awaitable[str], Output[T], None] = None, region: Union[str, Awaitable[str], Output[T], None] = None, requested_at: Union[str, Awaitable[str], Output[T], None] = None, safe: Union[bool, Awaitable[bool], Output[T], None] = None, size_gb: Union[float, Awaitable[float], Output[T], None] = None, state: Union[str, Awaitable[str], Output[T], None] = None, template_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.snapshot.Snapshot

Get an existing Snapshot resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • completed_at (pulumi.Input[str]) – The date where the snapshot was completed.

  • cron_timing (pulumi.Input[str]) – If a valid cron string is passed, the snapshot will be saved as an automated snapshot continuing to automatically update based on the schedule of the cron sequence provided The default is nil meaning the snapshot will be saved as a one-off snapshot.

  • hostname (pulumi.Input[str]) – The hostname of the instance.

  • instance_id (pulumi.Input[str]) – The ID of the Instance from which the snapshot will be taken.

  • name (pulumi.Input[str]) – A name for the instance snapshot.

  • next_execution (pulumi.Input[str]) – if cron was define this date will be the next execution date.

  • region (pulumi.Input[str]) – The region where the snapshot was take.

  • requested_at (pulumi.Input[str]) – The date where the snapshot was requested.

  • safe (pulumi.Input[bool]) – If true the instance will be shut down during the snapshot to ensure all files are in a consistent state (e.g. database tables aren’t in the middle of being optimised and hence risking corruption). The default is false so you experience no interruption of service, but a small risk of corruption.

  • size_gb (pulumi.Input[float]) – The size of the snapshot in GB.

  • state (pulumi.Input[str]) – The status of the snapshot.

  • template_id (pulumi.Input[str]) – The template id.

property completed_at

The date where the snapshot was completed.

property cron_timing

If a valid cron string is passed, the snapshot will be saved as an automated snapshot continuing to automatically update based on the schedule of the cron sequence provided The default is nil meaning the snapshot will be saved as a one-off snapshot.

property hostname

The hostname of the instance.

property instance_id

The ID of the Instance from which the snapshot will be taken.

property name

A name for the instance snapshot.

property next_execution

if cron was define this date will be the next execution date.

property region

The region where the snapshot was take.

property requested_at

The date where the snapshot was requested.

property safe

If true the instance will be shut down during the snapshot to ensure all files are in a consistent state (e.g. database tables aren’t in the middle of being optimised and hence risking corruption). The default is false so you experience no interruption of service, but a small risk of corruption.

property size_gb

The size of the snapshot in GB.

property state

The status of the snapshot.

property template_id

The template id.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.SshKey(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, name: Union[str, Awaitable[str], Output[T], None] = None, public_key: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Provides a Civo SSH key resource to allow you to manage SSH keys for Instance access. Keys created with this resource can be referenced in your instance configuration via their ID.

import pulumi
import pulumi_civo as civo

my_user = civo.SshKey("my-user", public_key=(lambda path: open(path).read())("~/.ssh/id_rsa.pub"))
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – The name of the SSH key for identification

  • public_key (pulumi.Input[str]) – The public key. If this is a file, it can be read using the file interpolation function.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, fingerprint: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, public_key: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.ssh_key.SshKey

Get an existing SshKey resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • fingerprint (pulumi.Input[str]) – The fingerprint of the SSH key

  • name (pulumi.Input[str]) – The name of the SSH key for identification

  • public_key (pulumi.Input[str]) – The public key. If this is a file, it can be read using the file interpolation function.

property fingerprint

The fingerprint of the SSH key

property name

The name of the SSH key for identification

property public_key

The public key. If this is a file, it can be read using the file interpolation function.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.Template(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, cloud_config: Union[str, Awaitable[str], Output[T], None] = None, code: Union[str, Awaitable[str], Output[T], None] = None, default_username: Union[str, Awaitable[str], Output[T], None] = None, description: Union[str, Awaitable[str], Output[T], None] = None, image_id: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, short_description: Union[str, Awaitable[str], Output[T], None] = None, volume_id: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Provides a Civo Template resource. This can be used to create, modify, and delete Templates.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cloud_config (pulumi.Input[str]) – Commonly referred to as ‘user-data’, this is a customisation script that is run after the instance is first booted. We recommend using cloud-config as it’s a great distribution-agnostic way of configuring cloud servers. If you put $INITIAL_USER in your script, this will automatically be replaced by the initial user chosen when creating the instance, $INITIAL_PASSWORD will be replaced with the random password generated by the system, $HOSTNAME is the fully qualified domain name of the instance and $SSH_KEY will be the content of the SSH public key. (this is technically optional, but you won’t really be able to use instances without it - see our learn guide on templates for more information).

  • code (pulumi.Input[str]) – This is a unqiue, alphanumerical, short, human readable code for the template.

  • default_username (pulumi.Input[str]) – The default username to suggest that the user creates

  • description (pulumi.Input[str]) – A multi-line description of the template, in Markdown format

  • image_id (pulumi.Input[str]) – This is the Image ID of any default template or the ID of another template either owned by you or global (optional; but must be specified if no volume_id is specified).

  • name (pulumi.Input[str]) – This is a short human readable name for the template

  • short_description (pulumi.Input[str]) – A one line description of the template

  • volume_id (pulumi.Input[str]) – This is the ID of a bootable volume, either owned by you or global (optional; but must be specified if no image_id is specified)

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, cloud_config: Union[str, Awaitable[str], Output[T], None] = None, code: Union[str, Awaitable[str], Output[T], None] = None, default_username: Union[str, Awaitable[str], Output[T], None] = None, description: Union[str, Awaitable[str], Output[T], None] = None, image_id: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, short_description: Union[str, Awaitable[str], Output[T], None] = None, volume_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.template.Template

Get an existing Template resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • cloud_config (pulumi.Input[str]) – Commonly referred to as ‘user-data’, this is a customisation script that is run after the instance is first booted. We recommend using cloud-config as it’s a great distribution-agnostic way of configuring cloud servers. If you put $INITIAL_USER in your script, this will automatically be replaced by the initial user chosen when creating the instance, $INITIAL_PASSWORD will be replaced with the random password generated by the system, $HOSTNAME is the fully qualified domain name of the instance and $SSH_KEY will be the content of the SSH public key. (this is technically optional, but you won’t really be able to use instances without it - see our learn guide on templates for more information).

  • code (pulumi.Input[str]) – This is a unqiue, alphanumerical, short, human readable code for the template.

  • default_username (pulumi.Input[str]) – The default username to suggest that the user creates

  • description (pulumi.Input[str]) – A multi-line description of the template, in Markdown format

  • image_id (pulumi.Input[str]) – This is the Image ID of any default template or the ID of another template either owned by you or global (optional; but must be specified if no volume_id is specified).

  • name (pulumi.Input[str]) – This is a short human readable name for the template

  • short_description (pulumi.Input[str]) – A one line description of the template

  • volume_id (pulumi.Input[str]) – This is the ID of a bootable volume, either owned by you or global (optional; but must be specified if no image_id is specified)

property cloud_config

Commonly referred to as ‘user-data’, this is a customisation script that is run after the instance is first booted. We recommend using cloud-config as it’s a great distribution-agnostic way of configuring cloud servers. If you put $INITIAL_USER in your script, this will automatically be replaced by the initial user chosen when creating the instance, $INITIAL_PASSWORD will be replaced with the random password generated by the system, $HOSTNAME is the fully qualified domain name of the instance and $SSH_KEY will be the content of the SSH public key. (this is technically optional, but you won’t really be able to use instances without it - see our learn guide on templates for more information).

property code

This is a unqiue, alphanumerical, short, human readable code for the template.

property default_username

The default username to suggest that the user creates

property description

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

property image_id

This is the Image ID of any default template or the ID of another template either owned by you or global (optional; but must be specified if no volume_id is specified).

property name

This is a short human readable name for the template

property short_description

A one line description of the template

property volume_id

This is the ID of a bootable volume, either owned by you or global (optional; but must be specified if no image_id is specified)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.Volume(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, bootable: Union[bool, Awaitable[bool], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, size_gb: Union[float, Awaitable[float], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Provides a Civo volume which can be attached to a Instance in order to provide expanded storage.

import pulumi
import pulumi_civo as civo

db = civo.Volume("db",
    bootable=False,
    size_gb=60)
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • bootable (pulumi.Input[bool]) – Mark the volume as bootable.

  • name (pulumi.Input[str]) – A name that you wish to use to refer to this volume .

  • size_gb (pulumi.Input[float]) – A minimum of 1 and a maximum of your available disk space from your quota specifies the size of the volume in gigabytes .

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, bootable: Union[bool, Awaitable[bool], Output[T], None] = None, created_at: Union[str, Awaitable[str], Output[T], None] = None, mount_point: Union[str, Awaitable[str], Output[T], None] = None, name: Union[str, Awaitable[str], Output[T], None] = None, size_gb: Union[float, Awaitable[float], Output[T], None] = None) → pulumi_civo.volume.Volume

Get an existing Volume resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • bootable (pulumi.Input[bool]) – Mark the volume as bootable.

  • created_at (pulumi.Input[str]) – The date of the creation of the volume.

  • mount_point (pulumi.Input[str]) – The mount point of the volume.

  • name (pulumi.Input[str]) – A name that you wish to use to refer to this volume .

  • size_gb (pulumi.Input[float]) – A minimum of 1 and a maximum of your available disk space from your quota specifies the size of the volume in gigabytes .

property bootable

Mark the volume as bootable.

property created_at

The date of the creation of the volume.

property mount_point

The mount point of the volume.

property name

A name that you wish to use to refer to this volume .

property size_gb

A minimum of 1 and a maximum of your available disk space from your quota specifies the size of the volume in gigabytes .

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_civo.VolumeAttachment(resource_name: str, opts: Optional[pulumi.resource.ResourceOptions] = None, instance_id: Union[str, Awaitable[str], Output[T], None] = None, volume_id: Union[str, Awaitable[str], Output[T], None] = None, __props__=None, __name__=None, __opts__=None)

Manages attaching a Volume to a Instance.

import pulumi
import pulumi_civo as civo

db = civo.Volume("db",
    size_gb=60,
    bootable=False)
foobar = civo.VolumeAttachment("foobar",
    instance_id=civo_instance["my-test-instance"]["id"],
    volume_id=db.id)
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • instance_id (pulumi.Input[str]) – ID of the instance to attach the volume to.

  • volume_id (pulumi.Input[str]) – ID of the Volume to be attached to the instance.

static get(resource_name: str, id: Union[str, Awaitable[str], Output[T]], opts: Optional[pulumi.resource.ResourceOptions] = None, instance_id: Union[str, Awaitable[str], Output[T], None] = None, volume_id: Union[str, Awaitable[str], Output[T], None] = None) → pulumi_civo.volume_attachment.VolumeAttachment

Get an existing VolumeAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (pulumi.Input[str]) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • instance_id (pulumi.Input[str]) – ID of the instance to attach the volume to.

  • volume_id (pulumi.Input[str]) – ID of the Volume to be attached to the instance.

property instance_id

ID of the instance to attach the volume to.

property volume_id

ID of the Volume to be attached to the instance.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_civo.get_dns_domain_name(id: Optional[str] = None, name: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_dns_domain_name.AwaitableGetDnsDomainNameResult

Use this data source to access information about an existing resource.

Parameters
  • id (str) – The id of the domain.

  • name (str) – The name of the domain.

pulumi_civo.get_dns_domain_record(domain_id: Optional[str] = None, name: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_dns_domain_record.AwaitableGetDnsDomainRecordResult

Use this data source to access information about an existing resource.

Parameters
  • domain_id (str) – The domain id of the record.

  • name (str) – The name of the record.

pulumi_civo.get_instance(hostname: Optional[str] = None, id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_instance.AwaitableGetInstanceResult

Use this data source to access information about an existing resource.

Parameters
  • hostname (str) – The hostname of the Instance.

  • id (str) – The ID of the Instance

pulumi_civo.get_instances(filters: Optional[List[Union[GetInstancesFilterArgs, Mapping[str, Any]]]] = None, sorts: Optional[List[Union[GetInstancesSortArgs, Mapping[str, Any]]]] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_instances.AwaitableGetInstancesResult

Use this data source to access information about an existing resource.

Parameters
  • filters (List[pulumi.InputType['GetInstancesFilterArgs']]) – Filter the results. The filter block is documented below.

  • sorts (List[pulumi.InputType['GetInstancesSortArgs']]) – Sort the results. The sort block is documented below.

pulumi_civo.get_instances_size(filters: Optional[List[Union[GetInstancesSizeFilterArgs, Mapping[str, Any]]]] = None, sorts: Optional[List[Union[GetInstancesSizeSortArgs, Mapping[str, Any]]]] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_instances_size.AwaitableGetInstancesSizeResult

Use this data source to access information about an existing resource.

pulumi_civo.get_kubernetes_cluster(id: Optional[str] = None, name: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_kubernetes_cluster.AwaitableGetKubernetesClusterResult

Provides a Civo Kubernetes cluster data source.

Note: This data source returns a single kubernetes cluster. When specifying a name, an error is triggered if more than one kubernetes Cluster is found.

Get the Kubernetes Cluster by name:

import pulumi
import pulumi_civo as civo

my_cluster = civo.get_kubernetes_cluster(name="my-super-cluster")
pulumi.export("kubernetesClusterOutput", my_cluster.master_ip)

Get the Kubernetes Cluster by id:

import pulumi
import pulumi_civo as civo

my_cluster = civo.get_kubernetes_cluster(name="40ac97ee-b82b-4231-9b60-079c7e2e5d79")
Parameters
  • id (str) – The ID of the kubernetes Cluster

  • name (str) – The name of the kubernetes Cluster.

pulumi_civo.get_kubernetes_version(filters: Optional[List[Union[GetKubernetesVersionFilterArgs, Mapping[str, Any]]]] = None, sorts: Optional[List[Union[GetKubernetesVersionSortArgs, Mapping[str, Any]]]] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_kubernetes_version.AwaitableGetKubernetesVersionResult

Provides access to the available Civo Kubernetes Service versions, with the ability to filter the results.

import pulumi
import pulumi_civo as civo

stable = civo.get_kubernetes_version(filters=[civo.GetKubernetesVersionFilterArgs(
    key="type",
    values=["stable"],
)])
import pulumi
import pulumi_civo as civo

minor_version = civo.get_kubernetes_version(filters=[civo.GetKubernetesVersionFilterArgs(
    key="version",
    values=["0.9.1"],
)])
Parameters
  • filters (List[pulumi.InputType['GetKubernetesVersionFilterArgs']]) – Filter the results. The filter block is documented below.

  • sorts (List[pulumi.InputType['GetKubernetesVersionSortArgs']]) – Sort the results. The sort block is documented below.

pulumi_civo.get_load_balancer(hostname: Optional[str] = None, id: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_load_balancer.AwaitableGetLoadBalancerResult

Use this data source to access information about an existing resource.

Parameters
  • hostname (str) – The hostname of the Load Balancer.

  • id (str) – The ID of the Load Balancer.

pulumi_civo.get_network(id: Optional[str] = None, label: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_network.AwaitableGetNetworkResult

Use this data source to access information about an existing resource.

Parameters
  • id (str) – The unique identifier of an existing Network.

  • label (str) – The name of an existing Network.

pulumi_civo.get_snapshot(id: Optional[str] = None, name: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_snapshot.AwaitableGetSnapshotResult

Snapshots are saved instances of a block storage volume. Use this data source to retrieve the ID of a Civo snapshot for use in other resources.

Get the snapshot:

import pulumi
import pulumi_civo as civo

mysql_vm = civo.get_snapshot(name="mysql-vm")
Parameters
  • id (str) – The ID of the snapshot.

  • name (str) – The name of the snapshot.

pulumi_civo.get_ssh_key(id: Optional[str] = None, name: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_ssh_key.AwaitableGetSshKeyResult

Use this data source to access information about an existing resource.

Parameters
  • id (str) – The ID of the ssh key.

  • name (str) – The name of the ssh key.

pulumi_civo.get_template(filters: Optional[List[Union[GetTemplateFilterArgs, Mapping[str, Any]]]] = None, sorts: Optional[List[Union[GetTemplateSortArgs, Mapping[str, Any]]]] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_template.AwaitableGetTemplateResult

Use this data source to access information about an existing resource.

Parameters
  • filters (List[pulumi.InputType['GetTemplateFilterArgs']]) – Filter the results. The filter block is documented below.

  • sorts (List[pulumi.InputType['GetTemplateSortArgs']]) – Sort the results. The sort block is documented below.

pulumi_civo.get_volume(id: Optional[str] = None, name: Optional[str] = None, opts: Optional[pulumi.invoke.InvokeOptions] = None) → pulumi_civo.get_volume.AwaitableGetVolumeResult

Use this data source to access information about an existing resource.

Parameters
  • id (str) – The unique identifier for the volume.

  • name (str) – The name of the volume.