Module types/output

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

APIs

interface FirewallDevice

interface FirewallDevice

property entityId

entityId: number;

The ID of the underlying entity this device references (i.e. the Linode’s ID).

property id

id: number;

The ID of the Firewall Device.

property label

label: string;

This Firewall’s unique label.

property type

type: string;

The type of Firewall Device.

property url

url: string;

interface FirewallInbound

interface FirewallInbound

property addresses

addresses: string[];

A list of IP addresses, CIDR blocks, or 0.0.0.0/0 (to whitelist all) this rule applies to.

property ports

ports: string[];

A list of ports and/or port ranges (i.e. “443” or “80-90”).

property protocol

protocol: string;

The network protocol this rule controls.

interface FirewallOutbound

interface FirewallOutbound

property addresses

addresses: string[];

A list of IP addresses, CIDR blocks, or 0.0.0.0/0 (to whitelist all) this rule applies to.

property ports

ports: string[];

A list of ports and/or port ranges (i.e. “443” or “80-90”).

property protocol

protocol: string;

The network protocol this rule controls.

interface GetInstanceTypeAddons

interface GetInstanceTypeAddons

property backups

backups: GetInstanceTypeAddonsBackups;

interface GetInstanceTypeAddonsBackups

interface GetInstanceTypeAddonsBackups

property price

price: GetInstanceTypeAddonsBackupsPrice;

interface GetInstanceTypeAddonsBackupsPrice

interface GetInstanceTypeAddonsBackupsPrice

property hourly

hourly: number;

property monthly

monthly: number;

interface GetInstanceTypePrice

interface GetInstanceTypePrice

property hourly

hourly: number;

property monthly

monthly: number;

interface GetProfileReferrals

interface GetProfileReferrals

property code

code: string;

property completed

completed: number;

property credit

credit: number;

property pending

pending: number;

property total

total: number;

property url

url: string;

interface GetStackScriptUserDefinedField

interface GetStackScriptUserDefinedField

property default

default: string;

property example

example: string;

property label

label: string;

property manyOf

manyOf: string;

property name

name: string;

property oneOf

oneOf: string;

interface InstanceAlerts

interface InstanceAlerts

property cpu

cpu: number;

property io

io: number;

property networkIn

networkIn: number;

property networkOut

networkOut: number;

property transferQuota

transferQuota: number;

interface InstanceBackups

interface InstanceBackups

property enabled

enabled: boolean;

property schedule

schedule: InstanceBackupsSchedule;

interface InstanceBackupsSchedule

interface InstanceBackupsSchedule

property day

day: string;

property window

window: string;

interface InstanceConfig

interface InstanceConfig

property comments

comments?: undefined | string;

Arbitrary user comments about this config.

property devices

devices: InstanceConfigDevices;

A list of disk or volume attachments for this config. If the bootConfigLabel omits a devices block, the Linode will not be booted.

property helpers

helpers: InstanceConfigHelpers;

Helpers enabled when booting to this Linode Config.

property kernel

kernel?: undefined | string;

A Kernel ID to boot a Linode with. Default is based on image choice. Examples are linode/latest-64bit, linode/grub2, linode/direct-disk, etc. See all kernels here.

property label

label: string;

The Config’s label for display purposes. Also used by bootConfigLabel.

property memoryLimit

memoryLimit?: undefined | number;

Defaults to the total RAM of the Linode

property rootDevice

rootDevice: string;

The root device to boot. The corresponding disk must be attached to a device slot. Example: "/dev/sda"

property runLevel

runLevel?: undefined | string;

Defines the state of your Linode after booting. Defaults to "default".

property virtMode

virtMode?: undefined | string;

Controls the virtualization mode. Defaults to "paravirt".

interface InstanceConfigDevices

interface InstanceConfigDevices

property sda

sda: InstanceConfigDevicesSda;

… sdh - (Optional) The SDA-SDH slots, represent the Linux block device nodes for the first 8 disks attached to the Linode. Each device must be suplied sequentially. The device can be either a Disk or a Volume identified by diskLabel or volumeId. Only one disk identifier is permitted per slot. Devices mapped from sde through sdh are unavailable in "fullvirt" virtMode.

property sdb

sdb: InstanceConfigDevicesSdb;

property sdc

sdc: InstanceConfigDevicesSdc;

property sdd

sdd: InstanceConfigDevicesSdd;

property sde

sde: InstanceConfigDevicesSde;

property sdf

sdf: InstanceConfigDevicesSdf;

property sdg

sdg: InstanceConfigDevicesSdg;

property sdh

sdh: InstanceConfigDevicesSdh;

interface InstanceConfigDevicesSda

interface InstanceConfigDevicesSda

property diskId

diskId: number;

The Disk ID of the associated diskLabel, if used.

property diskLabel

diskLabel?: undefined | string;

The label of the disk to map to this device slot.

property volumeId

volumeId?: undefined | number;

The Volume ID to map to this device slot.

interface InstanceConfigDevicesSdb

interface InstanceConfigDevicesSdb

property diskId

diskId: number;

The Disk ID of the associated diskLabel, if used.

property diskLabel

diskLabel?: undefined | string;

The label of the disk to map to this device slot.

property volumeId

volumeId?: undefined | number;

The Volume ID to map to this device slot.

interface InstanceConfigDevicesSdc

interface InstanceConfigDevicesSdc

property diskId

diskId: number;

The Disk ID of the associated diskLabel, if used.

property diskLabel

diskLabel?: undefined | string;

The label of the disk to map to this device slot.

property volumeId

volumeId?: undefined | number;

The Volume ID to map to this device slot.

interface InstanceConfigDevicesSdd

interface InstanceConfigDevicesSdd

property diskId

diskId: number;

The Disk ID of the associated diskLabel, if used.

property diskLabel

diskLabel?: undefined | string;

The label of the disk to map to this device slot.

property volumeId

volumeId?: undefined | number;

The Volume ID to map to this device slot.

interface InstanceConfigDevicesSde

interface InstanceConfigDevicesSde

property diskId

diskId: number;

The Disk ID of the associated diskLabel, if used.

property diskLabel

diskLabel?: undefined | string;

The label of the disk to map to this device slot.

property volumeId

volumeId?: undefined | number;

The Volume ID to map to this device slot.

interface InstanceConfigDevicesSdf

interface InstanceConfigDevicesSdf

property diskId

diskId: number;

The Disk ID of the associated diskLabel, if used.

property diskLabel

diskLabel?: undefined | string;

The label of the disk to map to this device slot.

property volumeId

volumeId?: undefined | number;

The Volume ID to map to this device slot.

interface InstanceConfigDevicesSdg

interface InstanceConfigDevicesSdg

property diskId

diskId: number;

The Disk ID of the associated diskLabel, if used.

property diskLabel

diskLabel?: undefined | string;

The label of the disk to map to this device slot.

property volumeId

volumeId?: undefined | number;

The Volume ID to map to this device slot.

interface InstanceConfigDevicesSdh

interface InstanceConfigDevicesSdh

property diskId

diskId: number;

The Disk ID of the associated diskLabel, if used.

property diskLabel

diskLabel?: undefined | string;

The label of the disk to map to this device slot.

property volumeId

volumeId?: undefined | number;

The Volume ID to map to this device slot.

interface InstanceConfigHelpers

interface InstanceConfigHelpers

property devtmpfsAutomount

devtmpfsAutomount?: undefined | false | true;

property distro

distro?: undefined | false | true;

Controls the behavior of the Linode Config’s Distribution Helper setting.

property modulesDep

modulesDep?: undefined | false | true;

Creates a modules dependency file for the Kernel you run.

property network

network?: undefined | false | true;

Controls the behavior of the Linode Config’s Network Helper setting, used to automatically configure additional IP addresses assigned to this instance.

property updatedbDisabled

updatedbDisabled?: undefined | false | true;

Disables updatedb cron job to avoid disk thrashing.

interface InstanceDisk

interface InstanceDisk

property authorizedKeys

authorizedKeys?: string[];

A list of SSH public keys to deploy for the root user on the newly created Linode. Only accepted if image is provided. This value can not be imported. Changing authorizedKeys forces the creation of a new Linode Instance.

property authorizedUsers

authorizedUsers?: string[];

A list of Linode usernames. If the usernames have associated SSH keys, the keys will be appended to the root user’s ~/.ssh/authorized_keys file automatically. This value can not be imported. Changing authorizedUsers forces the creation of a new Linode Instance.

property filesystem

filesystem: string;

The Disk filesystem can be one of: "raw", "swap", "ext3", "ext4", or "initrd" which has a max size of 32mb and can be used in the config initrd (not currently supported in this provider).

property id

id: number;

The ID of the disk in the Linode API.

property image

image: string;

An Image ID to deploy the Disk from. Official Linode Images start with linode/, while your Images start with private/. See /images for more information on the Images available for you to use. Examples are linode/debian9, linode/fedora28, linode/ubuntu16.04lts, linode/arch, and private/12345. See all images here. Changing image forces the creation of a new Linode Instance.

property label

label: string;

The Config’s label for display purposes. Also used by bootConfigLabel.

property readOnly

readOnly: boolean;

property rootPass

rootPass?: undefined | string;

The initial password for the root user account. This value can not be imported. Changing rootPass forces the creation of a new Linode Instance. If omitted, a random password will be generated but will not be stored in state.

property size

size: number;

The size of the Disk in MB.

property stackscriptData

stackscriptData: {[key: string]: any};

An object containing responses to any User Defined Fields present in the StackScript being deployed to this Linode. Only accepted if ‘stackscript_id’ is given. The required values depend on the StackScript being deployed. This value can not be imported. Changing stackscriptData forces the creation of a new Linode Instance.

property stackscriptId

stackscriptId: number;

The StackScript to deploy to the newly created Linode. If provided, ‘image’ must also be provided, and must be an Image that is compatible with this StackScript. This value can not be imported. Changing stackscriptId forces the creation of a new Linode Instance.