Pulumi Linode

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-linode repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-linode repo.

class pulumi_linode.AwaitableGetAccountResult(address1=None, address2=None, balance=None, city=None, company=None, country=None, email=None, first_name=None, last_name=None, phone=None, state=None, zip=None, id=None)
class pulumi_linode.AwaitableGetDomainResult(axfr_ips=None, description=None, domain=None, expire_sec=None, group=None, id=None, master_ips=None, refresh_sec=None, retry_sec=None, soa_email=None, status=None, tags=None, ttl_sec=None, type=None)
class pulumi_linode.AwaitableGetImageResult(created=None, created_by=None, deprecated=None, description=None, expiry=None, id=None, is_public=None, label=None, size=None, type=None, vendor=None)
class pulumi_linode.AwaitableGetInstanceTypeResult(addons=None, class_=None, disk=None, id=None, label=None, memory=None, network_out=None, price=None, transfer=None, vcpus=None)
class pulumi_linode.AwaitableGetNetworkingIpResult(address=None, gateway=None, linode_id=None, prefix=None, public=None, rdns=None, region=None, subnet_mask=None, type=None, id=None)
class pulumi_linode.AwaitableGetProfileResult(authorized_keys=None, email=None, email_notifications=None, ip_whitelist_enabled=None, lish_auth_method=None, referrals=None, restricted=None, timezone=None, two_factor_auth=None, username=None, id=None)
class pulumi_linode.AwaitableGetRegionResult(country=None, id=None)
class pulumi_linode.AwaitableGetSshKeyResult(created=None, label=None, ssh_key=None, id=None)
class pulumi_linode.AwaitableGetUserResult(email=None, restricted=None, ssh_keys=None, username=None, id=None)
class pulumi_linode.Domain(resource_name, opts=None, axfr_ips=None, description=None, domain=None, expire_sec=None, group=None, master_ips=None, refresh_sec=None, retry_sec=None, soa_email=None, status=None, tags=None, ttl_sec=None, type=None, __props__=None, __name__=None, __opts__=None)

Create a Domain resource with the given unique name, props, and options.

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

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

  • axfr_ips (pulumi.Input[list]) – The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.

  • description (pulumi.Input[str]) – A description for this Domain. This is for display purposes only.

  • domain (pulumi.Input[str]) – The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain.

  • expire_sec (pulumi.Input[float]) – The amount of time in seconds that may pass before this Domain is no longer authoritative. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

  • group (pulumi.Input[str]) – The group this Domain belongs to. This is for display purposes only.

  • master_ips (pulumi.Input[list]) – The IP addresses representing the master DNS for this Domain.

  • refresh_sec (pulumi.Input[float]) – The amount of time in seconds before this Domain should be refreshed. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

  • retry_sec (pulumi.Input[float]) – The interval, in seconds, at which a failed refresh should be retried. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

  • soa_email (pulumi.Input[str]) – Start of Authority email address. This is required for master Domains.

  • status (pulumi.Input[str]) – Used to control whether this Domain is currently being rendered (defaults to “active”).

  • tags (pulumi.Input[list]) – A list of tags applied to this object. Tags are for organizational purposes only.

  • ttl_sec (pulumi.Input[float]) – ‘Time to Live’ - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

  • type (pulumi.Input[str]) – If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave).

axfr_ips = None

The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.

description = None

A description for this Domain. This is for display purposes only.

domain = None

The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain.

expire_sec = None

The amount of time in seconds that may pass before this Domain is no longer authoritative. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

group = None

The group this Domain belongs to. This is for display purposes only.

master_ips = None

The IP addresses representing the master DNS for this Domain.

refresh_sec = None

The amount of time in seconds before this Domain should be refreshed. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

retry_sec = None

The interval, in seconds, at which a failed refresh should be retried. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

soa_email = None

Start of Authority email address. This is required for master Domains.

status = None

Used to control whether this Domain is currently being rendered (defaults to “active”).

tags = None

A list of tags applied to this object. Tags are for organizational purposes only.

ttl_sec = None

‘Time to Live’ - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

type = None

If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave).

static get(resource_name, id, opts=None, axfr_ips=None, description=None, domain=None, expire_sec=None, group=None, master_ips=None, refresh_sec=None, retry_sec=None, soa_email=None, status=None, tags=None, ttl_sec=None, type=None)

Get an existing Domain 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 (str) – The unique provider ID of the resource to lookup.

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

  • axfr_ips (pulumi.Input[list]) – The list of IPs that may perform a zone transfer for this Domain. This is potentially dangerous, and should be set to an empty list unless you intend to use it.

  • description (pulumi.Input[str]) – A description for this Domain. This is for display purposes only.

  • domain (pulumi.Input[str]) – The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain.

  • expire_sec (pulumi.Input[float]) – The amount of time in seconds that may pass before this Domain is no longer authoritative. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

  • group (pulumi.Input[str]) – The group this Domain belongs to. This is for display purposes only.

  • master_ips (pulumi.Input[list]) – The IP addresses representing the master DNS for this Domain.

  • refresh_sec (pulumi.Input[float]) – The amount of time in seconds before this Domain should be refreshed. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

  • retry_sec (pulumi.Input[float]) – The interval, in seconds, at which a failed refresh should be retried. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

  • soa_email (pulumi.Input[str]) – Start of Authority email address. This is required for master Domains.

  • status (pulumi.Input[str]) – Used to control whether this Domain is currently being rendered (defaults to “active”).

  • tags (pulumi.Input[list]) – A list of tags applied to this object. Tags are for organizational purposes only.

  • ttl_sec (pulumi.Input[float]) – ‘Time to Live’ - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

  • type (pulumi.Input[str]) – If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave).

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_linode.DomainRecord(resource_name, opts=None, domain_id=None, name=None, port=None, priority=None, protocol=None, record_type=None, service=None, tag=None, target=None, ttl_sec=None, weight=None, __props__=None, __name__=None, __opts__=None)

Provides a Linode Domain Record resource. This can be used to create, modify, and delete Linodes Domain Records. For more information, see DNS Manager and the Linode APIv4 docs.

This resource exports no additional attributes.

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

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

  • domain_id (pulumi.Input[float]) – The ID of the Domain to access. Changing ``domain_id`` forces the creation of a new Linode Domain Record..

  • name (pulumi.Input[str]) – The name of this Record. This field’s actual usage depends on the type of record this represents. For A and AAAA records, this is the subdomain being associated with an IP address.

  • port (pulumi.Input[float]) – The port this Record points to.

  • priority (pulumi.Input[float]) – The priority of the target host. Lower values are preferred.

  • protocol (pulumi.Input[str]) – The protocol this Record’s service communicates with. Only valid for SRV records.

  • record_type (pulumi.Input[str]) – The type of Record this is in the DNS system. For example, A records associate a domain name with an IPv4 address, and AAAA records associate a domain name with an IPv6 address. Changing ``record_type`` forces the creation of a new Linode Domain Record..

  • service (pulumi.Input[str]) – The service this Record identified. Only valid for SRV records.

  • tag (pulumi.Input[str]) – The tag portion of a CAA record. It is invalid to set this on other record types.

  • target (pulumi.Input[str]) – The target for this Record. This field’s actual usage depends on the type of record this represents. For A and AAAA records, this is the address the named Domain should resolve to.

- - -
Parameters
  • ttl_sec (pulumi.Input[float]) – ‘Time to Live’ - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

  • weight (pulumi.Input[float]) – The relative weight of this Record. Higher values are preferred.

domain_id = None

The ID of the Domain to access. Changing ``domain_id`` forces the creation of a new Linode Domain Record..

name = None

The name of this Record. This field’s actual usage depends on the type of record this represents. For A and AAAA records, this is the subdomain being associated with an IP address.

port = None

The port this Record points to.

priority = None

The priority of the target host. Lower values are preferred.

protocol = None

The protocol this Record’s service communicates with. Only valid for SRV records.

record_type = None

The type of Record this is in the DNS system. For example, A records associate a domain name with an IPv4 address, and AAAA records associate a domain name with an IPv6 address. Changing ``record_type`` forces the creation of a new Linode Domain Record..

service = None

The service this Record identified. Only valid for SRV records.

tag = None

The tag portion of a CAA record. It is invalid to set this on other record types.

target = None

The target for this Record. This field’s actual usage depends on the type of record this represents. For A and AAAA records, this is the address the named Domain should resolve to.

ttl_sec = None

‘Time to Live’ - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

weight = None

The relative weight of this Record. Higher values are preferred.

static get(resource_name, id, opts=None, domain_id=None, name=None, port=None, priority=None, protocol=None, record_type=None, service=None, tag=None, target=None, ttl_sec=None, weight=None)

Get an existing DomainRecord 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 (str) – The unique provider ID of the resource to lookup.

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

  • domain_id (pulumi.Input[float]) – The ID of the Domain to access. Changing ``domain_id`` forces the creation of a new Linode Domain Record..

  • name (pulumi.Input[str]) – The name of this Record. This field’s actual usage depends on the type of record this represents. For A and AAAA records, this is the subdomain being associated with an IP address.

  • port (pulumi.Input[float]) – The port this Record points to.

  • priority (pulumi.Input[float]) – The priority of the target host. Lower values are preferred.

  • protocol (pulumi.Input[str]) – The protocol this Record’s service communicates with. Only valid for SRV records.

  • record_type (pulumi.Input[str]) – The type of Record this is in the DNS system. For example, A records associate a domain name with an IPv4 address, and AAAA records associate a domain name with an IPv6 address. Changing ``record_type`` forces the creation of a new Linode Domain Record..

  • service (pulumi.Input[str]) – The service this Record identified. Only valid for SRV records.

  • tag (pulumi.Input[str]) – The tag portion of a CAA record. It is invalid to set this on other record types.

  • target (pulumi.Input[str]) – The target for this Record. This field’s actual usage depends on the type of record this represents. For A and AAAA records, this is the address the named Domain should resolve to.

- - -
Parameters
  • ttl_sec (pulumi.Input[float]) – ‘Time to Live’ - the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers. Valid values are 300, 3600, 7200, 14400, 28800, 57600, 86400, 172800, 345600, 604800, 1209600, and 2419200 - any other value will be rounded to the nearest valid value.

  • weight (pulumi.Input[float]) – The relative weight of this Record. Higher values are preferred.

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_linode.GetAccountResult(address1=None, address2=None, balance=None, city=None, company=None, country=None, email=None, first_name=None, last_name=None, phone=None, state=None, zip=None, id=None)

A collection of values returned by getAccount.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_linode.GetDomainResult(axfr_ips=None, description=None, domain=None, expire_sec=None, group=None, id=None, master_ips=None, refresh_sec=None, retry_sec=None, soa_email=None, status=None, tags=None, ttl_sec=None, type=None)

A collection of values returned by getDomain.

class pulumi_linode.GetImageResult(created=None, created_by=None, deprecated=None, description=None, expiry=None, id=None, is_public=None, label=None, size=None, type=None, vendor=None)

A collection of values returned by getImage.

class pulumi_linode.GetInstanceTypeResult(addons=None, class_=None, disk=None, id=None, label=None, memory=None, network_out=None, price=None, transfer=None, vcpus=None)

A collection of values returned by getInstanceType.

class pulumi_linode.GetNetworkingIpResult(address=None, gateway=None, linode_id=None, prefix=None, public=None, rdns=None, region=None, subnet_mask=None, type=None, id=None)

A collection of values returned by getNetworkingIp.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_linode.GetProfileResult(authorized_keys=None, email=None, email_notifications=None, ip_whitelist_enabled=None, lish_auth_method=None, referrals=None, restricted=None, timezone=None, two_factor_auth=None, username=None, id=None)

A collection of values returned by getProfile.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_linode.GetRegionResult(country=None, id=None)

A collection of values returned by getRegion.

class pulumi_linode.GetSshKeyResult(created=None, label=None, ssh_key=None, id=None)

A collection of values returned by getSshKey.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_linode.GetUserResult(email=None, restricted=None, ssh_keys=None, username=None, id=None)

A collection of values returned by getUser.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_linode.Image(resource_name, opts=None, description=None, disk_id=None, label=None, linode_id=None, __props__=None, __name__=None, __opts__=None)

Provides a Linode Image resource. This can be used to create, modify, and delete Linodes Images. Linode Images are snapshots of a Linode Instance Disk which can then be used to provision more Linode Instances. Images can be used across regions.

For more information, see Linode’s documentation on Images and the Linode APIv4 docs.

This resource exports the following attributes:

  • id - The unique ID of this Image. The ID of private images begin with private/ followed by the numeric identifier of the private image, for example private/12345.

  • created - When this Image was created.

  • created_by - The name of the User who created this Image.

  • deprecated - Whether or not this Image is deprecated. Will only be True for deprecated public Images.

  • is_public - True if the Image is public.

  • size - The minimum size this Image needs to deploy. Size is in MB.

  • type - How the Image was created. ‘Manual’ Images can be created at any time. ‘Automatic’ images are created automatically from a deleted Linode.

  • expiry - Only Images created automatically (from a deleted Linode; type=automatic) will expire.

  • vendor - The upstream distribution vendor. Nil for private Images.

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

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

  • description (pulumi.Input[str]) – A detailed description of this Image.

  • disk_id (pulumi.Input[float]) – The ID of the Linode Disk that this Image will be created from.

  • label (pulumi.Input[str]) – A short description of the Image. Labels cannot contain special characters.

  • linode_id (pulumi.Input[float]) – The ID of the Linode that this Image will be created from.

description = None

A detailed description of this Image.

disk_id = None

The ID of the Linode Disk that this Image will be created from.

label = None

A short description of the Image. Labels cannot contain special characters.

linode_id = None

The ID of the Linode that this Image will be created from.

static get(resource_name, id, opts=None, created=None, created_by=None, deprecated=None, description=None, disk_id=None, expiry=None, is_public=None, label=None, linode_id=None, size=None, type=None, vendor=None)

Get an existing Image 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 (str) – The unique provider ID of the resource to lookup.

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

  • description (pulumi.Input[str]) – A detailed description of this Image.

  • disk_id (pulumi.Input[float]) – The ID of the Linode Disk that this Image will be created from.

  • label (pulumi.Input[str]) – A short description of the Image. Labels cannot contain special characters.

  • linode_id (pulumi.Input[float]) – The ID of the Linode that this Image will be created from.

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_linode.Instance(resource_name, opts=None, alerts=None, authorized_keys=None, authorized_users=None, backup_id=None, backups_enabled=None, boot_config_label=None, configs=None, disks=None, group=None, image=None, label=None, private_ip=None, region=None, root_pass=None, stackscript_data=None, stackscript_id=None, swap_size=None, tags=None, type=None, watchdog_enabled=None, __props__=None, __name__=None, __opts__=None)

Create a Instance resource with the given unique name, props, and options.

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

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

  • authorized_keys (pulumi.Input[list]) – 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 ``authorized_keys`` forces the creation of a new Linode Instance.

  • authorized_users (pulumi.Input[list]) – 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 ``authorized_users`` forces the creation of a new Linode Instance.

  • backup_id (pulumi.Input[float]) – A Backup ID from another Linode’s available backups. Your User must have read_write access to that Linode, the Backup must have a status of successful, and the Linode must be deployed to the same region as the Backup. See /linode/instances/{linodeId}/backups for a Linode’s available backups. This field and the image field are mutually exclusive. This value can not be imported. Changing ``backup_id`` forces the creation of a new Linode Instance.

  • backups_enabled (pulumi.Input[bool]) – If this field is set to true, the created Linode will automatically be enrolled in the Linode Backup service. This will incur an additional charge. The cost for the Backup service is dependent on the Type of Linode deployed.

  • boot_config_label (pulumi.Input[str]) – The Label of the Instance Config that should be used to boot the Linode instance. If there is only one config, the label of that config will be used as the boot_config_label. This value can not be imported.

  • group (pulumi.Input[str]) – The display group of the Linode instance.

  • image (pulumi.Input[str]) – 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. Changing ``image`` forces the creation of a new Linode Instance.

  • label (pulumi.Input[str]) – The Config’s label for display purposes. Also used by boot_config_label.

  • private_ip (pulumi.Input[bool]) – If true, the created Linode will have private networking enabled, allowing use of the 192.168.128.0/17 network within the Linode’s region. It can be enabled on an existing Linode but it can’t be disabled.

  • region (pulumi.Input[str]) – This is the location where the Linode is deployed. Examples are "us-east", "us-west", "ap-south", etc. Changing ``region`` forces the creation of a new Linode Instance..

  • stackscript_data (pulumi.Input[dict]) – 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 ``stackscript_data`` forces the creation of a new Linode Instance.

  • stackscript_id (pulumi.Input[float]) – 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 ``stackscript_id`` forces the creation of a new Linode Instance.

  • swap_size (pulumi.Input[float]) – When deploying from an Image, this field is optional with a Linode API default of 512mb, otherwise it is ignored. This is used to set the swap disk size for the newly-created Linode.

  • tags (pulumi.Input[list]) – A list of tags applied to this object. Tags are for organizational purposes only.

  • type (pulumi.Input[str]) – The Linode type defines the pricing, CPU, disk, and RAM specs of the instance. Examples are "g6-nanode-1", "g6-standard-2", "g6-highmem-16", "g6-dedicated-16", etc.

  • watchdog_enabled (pulumi.Input[bool]) – The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. It works by issuing a boot job when your Linode powers off without a shutdown job being responsible. To prevent a loop, Lassie will give up if there have been more than 5 boot jobs issued within 15 minutes.

The alerts object supports the following:

  • cpu (pulumi.Input[float])

  • io (pulumi.Input[float])

  • networkIn (pulumi.Input[float])

  • networkOut (pulumi.Input[float])

  • transferQuota (pulumi.Input[float])

The configs object supports the following:

  • comments (pulumi.Input[str]) - - Arbitrary user comments about this config.

  • devices (pulumi.Input[dict]) - A list of disk or volume attachments for this config. If the boot_config_label omits a devices block, the Linode will not be booted.

    • sda (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdb (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdc (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdd (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sde (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdf (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdg (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdh (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

  • helpers (pulumi.Input[dict]) - Helpers enabled when booting to this Linode Config.

    • devtmpfsAutomount (pulumi.Input[bool])

    • distro (pulumi.Input[bool]) - Controls the behavior of the Linode Config’s Distribution Helper setting.

    • modulesDep (pulumi.Input[bool]) - Creates a modules dependency file for the Kernel you run.

    • network (pulumi.Input[bool]) - Controls the behavior of the Linode Config’s Network Helper setting, used to automatically configure additional IP addresses assigned to this instance.

    • updatedbDisabled (pulumi.Input[bool]) - Disables updatedb cron job to avoid disk thrashing.

  • kernel (pulumi.Input[str]) - - A Kernel ID to boot a Linode with. Default is based on image choice. (examples: linode/latest-64bit, linode/grub2, linode/direct-disk)

  • label (pulumi.Input[str]) - The Config’s label for display purposes. Also used by boot_config_label.

  • memoryLimit (pulumi.Input[float]) - - Defaults to the total RAM of the Linode

  • rootDevice (pulumi.Input[str]) - - The root device to boot. The corresponding disk must be attached to a device slot. Example: "/dev/sda"

  • runLevel (pulumi.Input[str]) - - Defines the state of your Linode after booting. Defaults to "default".

  • virtMode (pulumi.Input[str]) - - Controls the virtualization mode. Defaults to "paravirt".

The disks object supports the following:

  • authorized_keys (pulumi.Input[list]) - 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 ``authorized_keys`` forces the creation of a new Linode Instance.

  • authorized_users (pulumi.Input[list]) - 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 ``authorized_users`` forces the creation of a new Linode Instance.

  • filesystem (pulumi.Input[str]) -

  • id (pulumi.Input[float]) - The ID of the disk in the Linode API.

  • image (pulumi.Input[str]) - 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. Changing ``image`` forces the creation of a new Linode Instance.

  • label (pulumi.Input[str]) - The Config’s label for display purposes. Also used by boot_config_label.

  • readOnly (pulumi.Input[bool])

  • root_pass (pulumi.Input[str]) -

  • size (pulumi.Input[float]) - The size of the Disk in MB.

  • stackscript_data (pulumi.Input[dict]) - 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 ``stackscript_data`` forces the creation of a new Linode Instance.

  • stackscript_id (pulumi.Input[float]) - 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 ``stackscript_id`` forces the creation of a new Linode Instance.

authorized_keys = None

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 ``authorized_keys`` forces the creation of a new Linode Instance.

authorized_users = None

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 ``authorized_users`` forces the creation of a new Linode Instance.

backup_id = None

A Backup ID from another Linode’s available backups. Your User must have read_write access to that Linode, the Backup must have a status of successful, and the Linode must be deployed to the same region as the Backup. See /linode/instances/{linodeId}/backups for a Linode’s available backups. This field and the image field are mutually exclusive. This value can not be imported. Changing ``backup_id`` forces the creation of a new Linode Instance.

backups_enabled = None

If this field is set to true, the created Linode will automatically be enrolled in the Linode Backup service. This will incur an additional charge. The cost for the Backup service is dependent on the Type of Linode deployed.

boot_config_label = None

The Label of the Instance Config that should be used to boot the Linode instance. If there is only one config, the label of that config will be used as the boot_config_label. This value can not be imported.

group = None

The display group of the Linode instance.

image = None

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. Changing ``image`` forces the creation of a new Linode Instance.

label = None

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

private_ip = None

If true, the created Linode will have private networking enabled, allowing use of the 192.168.128.0/17 network within the Linode’s region. It can be enabled on an existing Linode but it can’t be disabled.

region = None

This is the location where the Linode is deployed. Examples are "us-east", "us-west", "ap-south", etc. Changing ``region`` forces the creation of a new Linode Instance..

stackscript_data = None

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 ``stackscript_data`` forces the creation of a new Linode Instance.

stackscript_id = None

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 ``stackscript_id`` forces the creation of a new Linode Instance.

swap_size = None

When deploying from an Image, this field is optional with a Linode API default of 512mb, otherwise it is ignored. This is used to set the swap disk size for the newly-created Linode.

tags = None

A list of tags applied to this object. Tags are for organizational purposes only.

type = None

The Linode type defines the pricing, CPU, disk, and RAM specs of the instance. Examples are "g6-nanode-1", "g6-standard-2", "g6-highmem-16", "g6-dedicated-16", etc.

watchdog_enabled = None

The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. It works by issuing a boot job when your Linode powers off without a shutdown job being responsible. To prevent a loop, Lassie will give up if there have been more than 5 boot jobs issued within 15 minutes.

static get(resource_name, id, opts=None, alerts=None, authorized_keys=None, authorized_users=None, backup_id=None, backups=None, backups_enabled=None, boot_config_label=None, configs=None, disks=None, group=None, image=None, ip_address=None, ipv4s=None, ipv6=None, label=None, private_ip=None, private_ip_address=None, region=None, root_pass=None, specs=None, stackscript_data=None, stackscript_id=None, status=None, swap_size=None, tags=None, type=None, watchdog_enabled=None)

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 (str) – The unique provider ID of the resource to lookup.

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

  • authorized_keys (pulumi.Input[list]) – 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 ``authorized_keys`` forces the creation of a new Linode Instance.

  • authorized_users (pulumi.Input[list]) – 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 ``authorized_users`` forces the creation of a new Linode Instance.

  • backup_id (pulumi.Input[float]) – A Backup ID from another Linode’s available backups. Your User must have read_write access to that Linode, the Backup must have a status of successful, and the Linode must be deployed to the same region as the Backup. See /linode/instances/{linodeId}/backups for a Linode’s available backups. This field and the image field are mutually exclusive. This value can not be imported. Changing ``backup_id`` forces the creation of a new Linode Instance.

  • backups_enabled (pulumi.Input[bool]) – If this field is set to true, the created Linode will automatically be enrolled in the Linode Backup service. This will incur an additional charge. The cost for the Backup service is dependent on the Type of Linode deployed.

  • boot_config_label (pulumi.Input[str]) – The Label of the Instance Config that should be used to boot the Linode instance. If there is only one config, the label of that config will be used as the boot_config_label. This value can not be imported.

  • group (pulumi.Input[str]) – The display group of the Linode instance.

  • image (pulumi.Input[str]) – 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. Changing ``image`` forces the creation of a new Linode Instance.

  • label (pulumi.Input[str]) – The Config’s label for display purposes. Also used by boot_config_label.

  • private_ip (pulumi.Input[bool]) – If true, the created Linode will have private networking enabled, allowing use of the 192.168.128.0/17 network within the Linode’s region. It can be enabled on an existing Linode but it can’t be disabled.

  • region (pulumi.Input[str]) – This is the location where the Linode is deployed. Examples are "us-east", "us-west", "ap-south", etc. Changing ``region`` forces the creation of a new Linode Instance..

  • stackscript_data (pulumi.Input[dict]) – 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 ``stackscript_data`` forces the creation of a new Linode Instance.

  • stackscript_id (pulumi.Input[float]) – 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 ``stackscript_id`` forces the creation of a new Linode Instance.

  • swap_size (pulumi.Input[float]) – When deploying from an Image, this field is optional with a Linode API default of 512mb, otherwise it is ignored. This is used to set the swap disk size for the newly-created Linode.

  • tags (pulumi.Input[list]) – A list of tags applied to this object. Tags are for organizational purposes only.

  • type (pulumi.Input[str]) – The Linode type defines the pricing, CPU, disk, and RAM specs of the instance. Examples are "g6-nanode-1", "g6-standard-2", "g6-highmem-16", "g6-dedicated-16", etc.

  • watchdog_enabled (pulumi.Input[bool]) – The watchdog, named Lassie, is a Shutdown Watchdog that monitors your Linode and will reboot it if it powers off unexpectedly. It works by issuing a boot job when your Linode powers off without a shutdown job being responsible. To prevent a loop, Lassie will give up if there have been more than 5 boot jobs issued within 15 minutes.

The alerts object supports the following:

  • cpu (pulumi.Input[float])

  • io (pulumi.Input[float])

  • networkIn (pulumi.Input[float])

  • networkOut (pulumi.Input[float])

  • transferQuota (pulumi.Input[float])

The backups object supports the following:

  • enabled (pulumi.Input[bool])

  • schedule (pulumi.Input[dict])

    • day (pulumi.Input[str])

    • window (pulumi.Input[str])

The configs object supports the following:

  • comments (pulumi.Input[str]) - - Arbitrary user comments about this config.

  • devices (pulumi.Input[dict]) - A list of disk or volume attachments for this config. If the boot_config_label omits a devices block, the Linode will not be booted.

    • sda (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdb (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdc (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdd (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sde (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdf (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdg (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

    • sdh (pulumi.Input[dict])

      • disk_id (pulumi.Input[float]) - The Disk ID of the associated disk_label, if used.

      • diskLabel (pulumi.Input[str]) - The label of the disk to map to this device slot.

      • volumeId (pulumi.Input[float]) - The Volume ID to map to this device slot.

  • helpers (pulumi.Input[dict]) - Helpers enabled when booting to this Linode Config.

    • devtmpfsAutomount (pulumi.Input[bool])

    • distro (pulumi.Input[bool]) - Controls the behavior of the Linode Config’s Distribution Helper setting.

    • modulesDep (pulumi.Input[bool]) - Creates a modules dependency file for the Kernel you run.

    • network (pulumi.Input[bool]) - Controls the behavior of the Linode Config’s Network Helper setting, used to automatically configure additional IP addresses assigned to this instance.

    • updatedbDisabled (pulumi.Input[bool]) - Disables updatedb cron job to avoid disk thrashing.

  • kernel (pulumi.Input[str]) - - A Kernel ID to boot a Linode with. Default is based on image choice. (examples: linode/latest-64bit, linode/grub2, linode/direct-disk)

  • label (pulumi.Input[str]) - The Config’s label for display purposes. Also used by boot_config_label.

  • memoryLimit (pulumi.Input[float]) - - Defaults to the total RAM of the Linode

  • rootDevice (pulumi.Input[str]) - - The root device to boot. The corresponding disk must be attached to a device slot. Example: "/dev/sda"

  • runLevel (pulumi.Input[str]) - - Defines the state of your Linode after booting. Defaults to "default".

  • virtMode (pulumi.Input[str]) - - Controls the virtualization mode. Defaults to "paravirt".

The disks object supports the following:

  • authorized_keys (pulumi.Input[list]) - 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 ``authorized_keys`` forces the creation of a new Linode Instance.

  • authorized_users (pulumi.Input[list]) - 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 ``authorized_users`` forces the creation of a new Linode Instance.

  • filesystem (pulumi.Input[str]) -

  • id (pulumi.Input[float]) - The ID of the disk in the Linode API.

  • image (pulumi.Input[str]) - 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. Changing ``image`` forces the creation of a new Linode Instance.

  • label (pulumi.Input[str]) - The Config’s label for display purposes. Also used by boot_config_label.

  • readOnly (pulumi.Input[bool])

  • root_pass (pulumi.Input[str]) -

  • size (pulumi.Input[float]) - The size of the Disk in MB.

  • stackscript_data (pulumi.Input[dict]) - 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 ``stackscript_data`` forces the creation of a new Linode Instance.

  • stackscript_id (pulumi.Input[float]) - 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 ``stackscript_id`` forces the creation of a new Linode Instance.

The specs object supports the following:

  • disk (pulumi.Input[float])

  • memory (pulumi.Input[float])

  • transfer (pulumi.Input[float])

  • vcpus (pulumi.Input[float])

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_linode.NodeBalancer(resource_name, opts=None, client_conn_throttle=None, label=None, region=None, tags=None, __props__=None, __name__=None, __opts__=None)

Create a NodeBalancer resource with the given unique name, props, and options.

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

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

  • client_conn_throttle (pulumi.Input[float]) – Throttle connections per second (0-20). Set to 0 (default) to disable throttling.

  • label (pulumi.Input[str]) – The label of the Linode NodeBalancer

  • region (pulumi.Input[str]) – The region where this NodeBalancer will be deployed. Examples are "us-east", "us-west", "ap-south", etc. Changing ``region`` forces the creation of a new Linode NodeBalancer..

  • tags (pulumi.Input[list]) – A list of tags applied to this object. Tags are for organizational purposes only.

client_conn_throttle = None

Throttle connections per second (0-20). Set to 0 (default) to disable throttling.

label = None

The label of the Linode NodeBalancer

region = None

The region where this NodeBalancer will be deployed. Examples are "us-east", "us-west", "ap-south", etc. Changing ``region`` forces the creation of a new Linode NodeBalancer..

tags = None

A list of tags applied to this object. Tags are for organizational purposes only.

static get(resource_name, id, opts=None, client_conn_throttle=None, created=None, hostname=None, ipv4=None, ipv6=None, label=None, region=None, tags=None, transfer=None, updated=None)

Get an existing NodeBalancer 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 (str) – The unique provider ID of the resource to lookup.

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

  • client_conn_throttle (pulumi.Input[float]) – Throttle connections per second (0-20). Set to 0 (default) to disable throttling.

  • label (pulumi.Input[str]) – The label of the Linode NodeBalancer

  • region (pulumi.Input[str]) – The region where this NodeBalancer will be deployed. Examples are "us-east", "us-west", "ap-south", etc. Changing ``region`` forces the creation of a new Linode NodeBalancer..

  • tags (pulumi.Input[list]) – A list of tags applied to this object. Tags are for organizational purposes only.

The transfer object supports the following:

  • in_ (pulumi.Input[float])

  • out (pulumi.Input[float])

  • total (pulumi.Input[float])

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_linode.NodeBalancerConfig(resource_name, opts=None, algorithm=None, check=None, check_attempts=None, check_body=None, check_interval=None, check_passive=None, check_path=None, check_timeout=None, cipher_suite=None, nodebalancer_id=None, port=None, protocol=None, ssl_cert=None, ssl_key=None, stickiness=None, __props__=None, __name__=None, __opts__=None)

Create a NodeBalancerConfig resource with the given unique name, props, and options.

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

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

  • algorithm (pulumi.Input[str]) – What algorithm this NodeBalancer should use for routing traffic to backends: roundrobin, leastconn, source

  • check (pulumi.Input[str]) – The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected.

  • check_attempts (pulumi.Input[float]) – How many times to attempt a check before considering a backend to be down. (1-30)

  • check_interval (pulumi.Input[float]) – How often, in seconds, to check that backends are up and serving requests.

  • check_passive (pulumi.Input[bool]) – If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.

  • check_path (pulumi.Input[str]) – The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.

  • check_timeout (pulumi.Input[float]) – How long, in seconds, to wait for a check attempt before considering it failed. (1-30)

  • cipher_suite (pulumi.Input[str]) – What ciphers to use for SSL connections served by this NodeBalancer. legacy is considered insecure and should only be used if necessary.

  • nodebalancer_id (pulumi.Input[float]) – The ID of the NodeBalancer to access.

  • port (pulumi.Input[float]) – The TCP port this Config is for. These values must be unique across configs on a single NodeBalancer (you can’t have two configs for port 80, for example). While some ports imply some protocols, no enforcement is done and you may configure your NodeBalancer however is useful to you. For example, while port 443 is generally used for HTTPS, you do not need SSL configured to have a NodeBalancer listening on port 443. (Defaults to 80)

  • protocol (pulumi.Input[str]) – The protocol this port is configured to serve. If this is set to https you must include an ssl_cert and an ssl_key. (Defaults to “http”)

  • ssl_cert (pulumi.Input[str]) – The certificate this port is serving. This is not returned. If set, this field will come back as <REDACTED>. Please use the ssl_commonname and ssl_fingerprint to identify the certificate.

  • ssl_key (pulumi.Input[str]) – The private key corresponding to this port’s certificate. This is not returned. If set, this field will come back as <REDACTED>. Please use the ssl_commonname and ssl_fingerprint to identify the certificate.

  • stickiness (pulumi.Input[str]) – Controls how session stickiness is handled on this port: ‘none’, ‘table’, ‘http_cookie’

algorithm = None

What algorithm this NodeBalancer should use for routing traffic to backends: roundrobin, leastconn, source

check = None

The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected.

check_attempts = None

How many times to attempt a check before considering a backend to be down. (1-30)

check_interval = None

How often, in seconds, to check that backends are up and serving requests.

check_passive = None

If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.

check_path = None

The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.

check_timeout = None

How long, in seconds, to wait for a check attempt before considering it failed. (1-30)

cipher_suite = None

What ciphers to use for SSL connections served by this NodeBalancer. legacy is considered insecure and should only be used if necessary.

nodebalancer_id = None

The ID of the NodeBalancer to access.

port = None

The TCP port this Config is for. These values must be unique across configs on a single NodeBalancer (you can’t have two configs for port 80, for example). While some ports imply some protocols, no enforcement is done and you may configure your NodeBalancer however is useful to you. For example, while port 443 is generally used for HTTPS, you do not need SSL configured to have a NodeBalancer listening on port 443. (Defaults to 80)

protocol = None

The protocol this port is configured to serve. If this is set to https you must include an ssl_cert and an ssl_key. (Defaults to “http”)

ssl_cert = None

The certificate this port is serving. This is not returned. If set, this field will come back as <REDACTED>. Please use the ssl_commonname and ssl_fingerprint to identify the certificate.

ssl_key = None

The private key corresponding to this port’s certificate. This is not returned. If set, this field will come back as <REDACTED>. Please use the ssl_commonname and ssl_fingerprint to identify the certificate.

stickiness = None

Controls how session stickiness is handled on this port: ‘none’, ‘table’, ‘http_cookie’

static get(resource_name, id, opts=None, algorithm=None, check=None, check_attempts=None, check_body=None, check_interval=None, check_passive=None, check_path=None, check_timeout=None, cipher_suite=None, node_status=None, nodebalancer_id=None, port=None, protocol=None, ssl_cert=None, ssl_commonname=None, ssl_fingerprint=None, ssl_key=None, stickiness=None)

Get an existing NodeBalancerConfig 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 (str) – The unique provider ID of the resource to lookup.

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

  • algorithm (pulumi.Input[str]) – What algorithm this NodeBalancer should use for routing traffic to backends: roundrobin, leastconn, source

  • check (pulumi.Input[str]) – The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected.

  • check_attempts (pulumi.Input[float]) – How many times to attempt a check before considering a backend to be down. (1-30)

  • check_interval (pulumi.Input[float]) – How often, in seconds, to check that backends are up and serving requests.

  • check_passive (pulumi.Input[bool]) – If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.

  • check_path (pulumi.Input[str]) – The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.

  • check_timeout (pulumi.Input[float]) – How long, in seconds, to wait for a check attempt before considering it failed. (1-30)

  • cipher_suite (pulumi.Input[str]) – What ciphers to use for SSL connections served by this NodeBalancer. legacy is considered insecure and should only be used if necessary.

  • nodebalancer_id (pulumi.Input[float]) – The ID of the NodeBalancer to access.

  • port (pulumi.Input[float]) – The TCP port this Config is for. These values must be unique across configs on a single NodeBalancer (you can’t have two configs for port 80, for example). While some ports imply some protocols, no enforcement is done and you may configure your NodeBalancer however is useful to you. For example, while port 443 is generally used for HTTPS, you do not need SSL configured to have a NodeBalancer listening on port 443. (Defaults to 80)

  • protocol (pulumi.Input[str]) – The protocol this port is configured to serve. If this is set to https you must include an ssl_cert and an ssl_key. (Defaults to “http”)

  • ssl_cert (pulumi.Input[str]) – The certificate this port is serving. This is not returned. If set, this field will come back as <REDACTED>. Please use the ssl_commonname and ssl_fingerprint to identify the certificate.

  • ssl_key (pulumi.Input[str]) – The private key corresponding to this port’s certificate. This is not returned. If set, this field will come back as <REDACTED>. Please use the ssl_commonname and ssl_fingerprint to identify the certificate.

  • stickiness (pulumi.Input[str]) – Controls how session stickiness is handled on this port: ‘none’, ‘table’, ‘http_cookie’

The node_status object supports the following:

  • status_down (pulumi.Input[float])

  • status_up (pulumi.Input[float])

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_linode.NodeBalancerNode(resource_name, opts=None, address=None, config_id=None, label=None, mode=None, nodebalancer_id=None, weight=None, __props__=None, __name__=None, __opts__=None)

Create a NodeBalancerNode resource with the given unique name, props, and options.

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

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

  • address (pulumi.Input[str]) – The private IP Address where this backend can be reached. This must be a private IP address.

  • config_id (pulumi.Input[float]) – The ID of the NodeBalancerConfig to access.

  • label (pulumi.Input[str]) – The label of the Linode NodeBalancer Node. This is for display purposes only.

  • mode (pulumi.Input[str]) – The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it

  • nodebalancer_id (pulumi.Input[float]) – The ID of the NodeBalancer to access.

  • weight (pulumi.Input[float]) – Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).

address = None

The private IP Address where this backend can be reached. This must be a private IP address.

config_id = None

The ID of the NodeBalancerConfig to access.

label = None

The label of the Linode NodeBalancer Node. This is for display purposes only.

mode = None

The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it

nodebalancer_id = None

The ID of the NodeBalancer to access.

weight = None

Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).

static get(resource_name, id, opts=None, address=None, config_id=None, label=None, mode=None, nodebalancer_id=None, status=None, weight=None)

Get an existing NodeBalancerNode 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 (str) – The unique provider ID of the resource to lookup.

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

  • address (pulumi.Input[str]) – The private IP Address where this backend can be reached. This must be a private IP address.

  • config_id (pulumi.Input[float]) – The ID of the NodeBalancerConfig to access.

  • label (pulumi.Input[str]) – The label of the Linode NodeBalancer Node. This is for display purposes only.

  • mode (pulumi.Input[str]) – The mode this NodeBalancer should use when sending traffic to this backend. If set to accept this backend is accepting traffic. If set to reject this backend will not receive traffic. If set to drain this backend will not receive new traffic, but connections already pinned to it will continue to be routed to it

  • nodebalancer_id (pulumi.Input[float]) – The ID of the NodeBalancer to access.

  • weight (pulumi.Input[float]) – Used when picking a backend to serve a request and is not pinned to a single backend yet. Nodes with a higher weight will receive more traffic. (1-255).

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_linode.Provider(resource_name, opts=None, token=None, ua_prefix=None, url=None, __props__=None, __name__=None, __opts__=None)

The provider type for the linode 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
  • resource_name (str) – The name of the resource.

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

static get(resource_name, id, opts=None)

Get an existing Provider 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 (str) – The unique provider ID of the resource to lookup.

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

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_linode.Rdns(resource_name, opts=None, address=None, rdns=None, __props__=None, __name__=None, __opts__=None)

Provides a Linode RDNS resource. This can be used to create and modify RDNS records.

Linode RDNS names must have a matching address value in an A or AAAA record. This A or AAAA name must be resolvable at the time the RDNS resource is being associated.

For more information, see the Linode APIv4 docs and the Configure your Linode for Reverse DNS guide.

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

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

  • address (pulumi.Input[str]) – The Public IPv4 or IPv6 address that will receive the PTR record. A matching A or AAAA record must exist.

  • rdns (pulumi.Input[str]) – The name of the RDNS address.

address = None

The Public IPv4 or IPv6 address that will receive the PTR record. A matching A or AAAA record must exist.

rdns = None

The name of the RDNS address.

static get(resource_name, id, opts=None, address=None, rdns=None)

Get an existing Rdns 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 (str) – The unique provider ID of the resource to lookup.

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

  • address (pulumi.Input[str]) – The Public IPv4 or IPv6 address that will receive the PTR record. A matching A or AAAA record must exist.

  • rdns (pulumi.Input[str]) – The name of the RDNS address.

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_linode.SshKey(resource_name, opts=None, label=None, ssh_key=None, __props__=None, __name__=None, __opts__=None)

Provides a Linode SSH Key resource. This can be used to create, modify, and delete Linodes SSH Keys. Managed SSH Keys allow instances to be created with a list of Linode usernames, whose SSH keys will be automatically applied to the root account’s ~/.ssh/authorized_keys file. For more information, see the Linode APIv4 docs.

This resource exports the following attributes:

  • created - The date this SSH Key was created.

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

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

  • label (pulumi.Input[str]) – A label for the SSH Key.

  • ssh_key (pulumi.Input[str]) – The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy.

label = None

A label for the SSH Key.

ssh_key = None

The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy.

static get(resource_name, id, opts=None, created=None, label=None, ssh_key=None)

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 (str) – The unique provider ID of the resource to lookup.

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

  • label (pulumi.Input[str]) – A label for the SSH Key.

  • ssh_key (pulumi.Input[str]) – The public SSH Key, which is used to authenticate to the root user of the Linodes you deploy.

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_linode.StackScript(resource_name, opts=None, description=None, images=None, is_public=None, label=None, rev_note=None, script=None, user_defined_fields=None, __props__=None, __name__=None, __opts__=None)

Create a StackScript resource with the given unique name, props, and options.

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

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

  • description (pulumi.Input[str]) – A description for the StackScript.

  • images (pulumi.Input[list]) – An array of Image IDs representing the Images that this StackScript is compatible for deploying with.

  • is_public (pulumi.Input[bool]) – This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private. Changing ``is_public`` forces the creation of a new StackScript

  • label (pulumi.Input[str]) – The StackScript’s label is for display purposes only.

  • rev_note (pulumi.Input[str]) – This field allows you to add notes for the set of revisions made to this StackScript.

  • script (pulumi.Input[str]) – The script to execute when provisioning a new Linode with this StackScript.

The user_defined_fields object supports the following:

  • default (pulumi.Input[str])

  • example (pulumi.Input[str])

  • label (pulumi.Input[str]) - The StackScript’s label is for display purposes only.

  • manyOf (pulumi.Input[str])

  • name (pulumi.Input[str])

  • oneOf (pulumi.Input[str])

description = None

A description for the StackScript.

images = None

An array of Image IDs representing the Images that this StackScript is compatible for deploying with.

is_public = None

This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private. Changing ``is_public`` forces the creation of a new StackScript

label = None

The StackScript’s label is for display purposes only.

rev_note = None

This field allows you to add notes for the set of revisions made to this StackScript.

script = None

The script to execute when provisioning a new Linode with this StackScript.

static get(resource_name, id, opts=None, created=None, deployments_active=None, deployments_total=None, description=None, images=None, is_public=None, label=None, rev_note=None, script=None, updated=None, user_defined_fields=None, user_gravatar_id=None, username=None)

Get an existing StackScript 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 (str) – The unique provider ID of the resource to lookup.

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

  • description (pulumi.Input[str]) – A description for the StackScript.

  • images (pulumi.Input[list]) – An array of Image IDs representing the Images that this StackScript is compatible for deploying with.

  • is_public (pulumi.Input[bool]) – This determines whether other users can use your StackScript. Once a StackScript is made public, it cannot be made private. Changing ``is_public`` forces the creation of a new StackScript

  • label (pulumi.Input[str]) – The StackScript’s label is for display purposes only.

  • rev_note (pulumi.Input[str]) – This field allows you to add notes for the set of revisions made to this StackScript.

  • script (pulumi.Input[str]) – The script to execute when provisioning a new Linode with this StackScript.

The user_defined_fields object supports the following:

  • default (pulumi.Input[str])

  • example (pulumi.Input[str])

  • label (pulumi.Input[str]) - The StackScript’s label is for display purposes only.

  • manyOf (pulumi.Input[str])

  • name (pulumi.Input[str])

  • oneOf (pulumi.Input[str])

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_linode.Token(resource_name, opts=None, expiry=None, label=None, scopes=None, __props__=None, __name__=None, __opts__=None)

Create a Token resource with the given unique name, props, and options.

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

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

  • expiry (pulumi.Input[str]) – When this token will expire. Personal Access Tokens cannot be renewed, so after this time the token will be completely unusable and a new token will need to be generated. Tokens may be created with ‘null’ as their expiry and will never expire unless revoked.

  • label (pulumi.Input[str]) – A label for the Token.

  • scopes (pulumi.Input[str]) – The scopes this token was created with. These define what parts of the Account the token can be used to access. Many command-line tools, such as the Linode CLI, require tokens with access to *. Tokens with more restrictive scopes are generally more secure.

expiry = None

When this token will expire. Personal Access Tokens cannot be renewed, so after this time the token will be completely unusable and a new token will need to be generated. Tokens may be created with ‘null’ as their expiry and will never expire unless revoked.

label = None

A label for the Token.

scopes = None

The scopes this token was created with. These define what parts of the Account the token can be used to access. Many command-line tools, such as the Linode CLI, require tokens with access to *. Tokens with more restrictive scopes are generally more secure.

static get(resource_name, id, opts=None, created=None, expiry=None, label=None, scopes=None, token=None)

Get an existing Token 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 (str) – The unique provider ID of the resource to lookup.

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

  • expiry (pulumi.Input[str]) – When this token will expire. Personal Access Tokens cannot be renewed, so after this time the token will be completely unusable and a new token will need to be generated. Tokens may be created with ‘null’ as their expiry and will never expire unless revoked.

  • label (pulumi.Input[str]) – A label for the Token.

  • scopes (pulumi.Input[str]) – The scopes this token was created with. These define what parts of the Account the token can be used to access. Many command-line tools, such as the Linode CLI, require tokens with access to *. Tokens with more restrictive scopes are generally more secure.

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_linode.Volume(resource_name, opts=None, label=None, linode_id=None, region=None, size=None, tags=None, __props__=None, __name__=None, __opts__=None)

Provides a Linode Volume resource. This can be used to create, modify, and delete Linodes Block Storage Volumes. Block Storage Volumes are removable storage disks that persist outside the life-cycle of Linode Instances. These volumes can be attached to and detached from Linode instances throughout a region.

For more information, see How to Use Block Storage with Your Linode and the Linode APIv4 docs.

This resource exports the following attributes:

  • status - The label of the Linode Volume.

  • filesystem_path - The full filesystem path for the Volume based on the Volume’s label. The path is “/dev/disk/by-id/scsi-0LinodeVolume” + the Volume label

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

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

  • label (pulumi.Input[str]) – The label of the Linode Volume

  • linode_id (pulumi.Input[float]) – The ID of a Linode Instance where the the Volume should be attached.

  • region (pulumi.Input[str]) – The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. Changing ``region`` forces the creation of a new Linode Volume..

  • size (pulumi.Input[float]) – Size of the Volume in GB.

  • tags (pulumi.Input[list]) – A list of tags applied to this object. Tags are for organizational purposes only.

label = None

The label of the Linode Volume

linode_id = None

The ID of a Linode Instance where the the Volume should be attached.

region = None

The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. Changing ``region`` forces the creation of a new Linode Volume..

size = None

Size of the Volume in GB.

tags = None

A list of tags applied to this object. Tags are for organizational purposes only.

static get(resource_name, id, opts=None, filesystem_path=None, label=None, linode_id=None, region=None, size=None, status=None, tags=None)

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 (str) – The unique provider ID of the resource to lookup.

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

  • label (pulumi.Input[str]) – The label of the Linode Volume

  • linode_id (pulumi.Input[float]) – The ID of a Linode Instance where the the Volume should be attached.

  • region (pulumi.Input[str]) – The region where this volume will be deployed. Examples are "us-east", "us-west", "ap-south", etc. Changing ``region`` forces the creation of a new Linode Volume..

  • size (pulumi.Input[float]) – Size of the Volume in GB.

  • tags (pulumi.Input[list]) – A list of tags applied to this object. Tags are for organizational purposes only.

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_linode.get_account(opts=None)

Provides information about a Linode account.

This data source should not be used in conjuction with the LINODE_DEBUG option. See the debugging notes for more details.

The Linode Account resource exports the following attributes:

  • email - The email address for this Account, for account management communications, and may be used for other communications as configured.

  • first_name - The first name of the person associated with this Account.

  • last_name - The last name of the person associated with this Account.

  • company - The company name associated with this Account.

  • address_1 - First line of this Account’s billing address.

  • address_2 - Second line of this Account’s billing address.

  • phone - The phone number associated with this Account.

  • city - The city for this Account’s billing address.

  • state - If billing address is in the United States, this is the State portion of the Account’s billing address. If the address is outside the US, this is the Province associated with the Account’s billing address.

  • country - The two-letter country code of this Account’s billing address.

  • zip - The zip code of this Account’s billing address.

  • balance - This Account’s balance, in US dollars.

pulumi_linode.get_domain(domain=None, id=None, opts=None)

Provides information about a Linode domain.

The Linode Domain resource exports the following attributes:

  • id - The unique ID of this Domain.

  • domain - The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain

  • type - If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave)

  • group - The group this Domain belongs to.

  • status - Used to control whether this Domain is currently being rendered.

  • description - A description for this Domain.

  • master_ips - The IP addresses representing the master DNS for this Domain.

  • axfr_ips - The list of IPs that may perform a zone transfer for this Domain.

  • ttl_sec - ‘Time to Live’-the amount of time in seconds that this Domain’s records may be cached by resolvers or other domain servers.

  • retry_sec - The interval, in seconds, at which a failed refresh should be retried. *

  • expire_sec - The amount of time in seconds that may pass before this Domain is no longer authoritative.

  • refresh_sec - The amount of time in seconds before this Domain should be refreshed.

  • soa_email - Start of Authority email address.

  • tags - An array of tags applied to this object.

Parameters
  • domain (str) – The unique domain name of the Domain record to query.

  • id (str) – The unique numeric ID of the Domain record to query.

pulumi_linode.get_image(id=None, opts=None)

Provides information about a Linode image

The Linode Image resource exports the following attributes:

  • label - A short description of the Image.

  • created - When this Image was created.

  • created_by - The name of the User who created this Image, or “linode” for official Images.

  • deprecated - Whether or not this Image is deprecated. Will only be true for deprecated public Images.

  • description - A detailed description of this Image.

  • is_public - True if the Image is public.

  • size - The minimum size this Image needs to deploy. Size is in MB. example: 2500

  • type - How the Image was created. Manual Images can be created at any time. image”Automatic” Images are created automatically from a deleted Linode.

  • vendor - The upstream distribution vendor. None for private Images.

Parameters

id (str) – The unique ID of this Image. The ID of private images begin with private/ followed by the numeric identifier of the private image, for example private/12345.

pulumi_linode.get_instance_type(id=None, label=None, opts=None)

Provides information about a Linode instance type

The Linode Instance Type resource exports the following attributes:

  • id - The ID representing the Linode Type

  • label - The Linode Type’s label is for display purposes only

  • class - The class of the Linode Type

  • disk - The Disk size, in MB, of the Linode Type

  • price.0.hourly - Cost (in US dollars) per hour.

  • price.0.monthly - Cost (in US dollars) per month.

  • addons.0.backups.0.price.0.hourly - The cost (in US dollars) per hour to add Backups service.

  • addons.0.backups.0.price.0.monthly - The cost (in US dollars) per month to add Backups service.

Parameters

id (str) – Label used to identify instance type

pulumi_linode.get_networking_ip(address=None, opts=None)

Provides information about a Linode Networking IP Address

The Linode Network IP Address resource exports the following attributes:

  • address - The IP address.

  • gateway - The default gateway for this address.

  • subnet_mask - The mask that separates host bits from network bits for this address.

  • prefix - The number of bits set in the subnet mask.

  • type - The type of address this is (ipv4, ipv6, ipv6/pool, ipv6/range).

  • public - Whether this is a public or private IP address.

  • rdns - The reverse DNS assigned to this address. For public IPv4 addresses, this will be set to a default value provided by Linode if not explicitly set.

  • linode_id - The ID of the Linode this address currently belongs to.

  • region - The Region this IP address resides in.

Parameters

address (str) – The IP Address to access. The address must be associated with the account and a resource that the user has access to view.

pulumi_linode.get_profile(opts=None)

Provides information about a Linode profile.

The Linode Profile resource exports the following attributes:

  • email - The profile email address. This address will be used for communication with Linode as necessary.

  • timezone - The profile’s preferred timezone. This is not used by the API, and is for the benefit of clients only. All times the API returns are in UTC.

  • email_notifications - If true, email notifications will be sent about account activity. If false, when false business-critical communications may still be sent through email.

  • username - The username for logging in to Linode services.

  • ip_whitelist_enabled - If true, logins for the user will only be allowed from whitelisted IPs. This setting is currently deprecated, and cannot be enabled.

  • lish_auth_method - The methods of authentication allowed when connecting via Lish. ‘keys_only’ is the most secure with the intent to use Lish, and ‘disabled’ is recommended for users that will not use Lish at all.

  • authorized_keys - The list of SSH Keys authorized to use Lish for this user. This value is ignored if lish_auth_method is ‘disabled’.

  • two_factor_auth - If true, logins from untrusted computers will require Two Factor Authentication.

  • restricted - If true, the user has restrictions on what can be accessed on the Account.

  • referrals - Credit Card information associated with this Account.

  • referrals.0.total - The number of users who have signed up with the referral code.

  • referrals.0.credit - The amount of account credit in US Dollars issued to the account through the referral program.

  • referrals.0.completed - The number of completed signups with the referral code.

  • referrals.0.pending - The number of pending signups for the referral code. To receive credit the signups must be completed.

  • referrals.0.code - The Profile referral code. If new accounts use this when signing up for Linode, referring account will receive credit.

  • referrals.0.url - The referral URL.

pulumi_linode.get_region(country=None, id=None, opts=None)

.getRegion provides details about a specific Linode region.

pulumi_linode.get_ssh_key(label=None, opts=None)

.SshKey provides access to a specifically labeled SSH Key in the Profile of the User identified by the access token.

pulumi_linode.get_user(username=None, opts=None)

Provides information about a Linode user

The Linode User resource exports the following attributes:

  • ssh_keys - A list of SSH Key labels added by this User. These are the keys that will be deployed if this User is included in the authorized_users field of a create Linode, rebuild Linode, or create Disk request.

  • email - The email address for this User, for account management communications, and may be used for other communications as configured.

  • restricted - If true, this User must be granted access to perform actions or access entities on this Account.

Parameters

username (str) – The unique username of this User.