Skip to main content

blueprints

Creates, updates, deletes, gets or lists a blueprints resource.

Overview

Nameblueprints
TypeResource
Idaws.lightsail.blueprints

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringThe friendly name of the blueprint (Amazon Linux). (pattern: <code>\w[\w-]*\w</code>)
app_categorystringVirtual computer blueprints that are supported by Lightsail for Research. This parameter only applies to Lightsail for Research resources. (LfR)
blueprint_idstringThe ID for the virtual private server image (app_wordpress_x_x or app_lamp_x_x). (pattern: <code>.\S.</code>)
descriptionstringThe description of the blueprint.
groupstringThe group name of the blueprint (amazon-linux). (pattern: <code>.\S.</code>)
is_activebooleanA Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.
license_urlstringThe end-user license agreement URL for the image or blueprint.
min_powerintegerThe minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.
platformstringThe operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint. (LINUX_UNIX, WINDOWS)
product_urlstringThe product URL to learn more about the image or blueprint.
type_stringThe type of the blueprint (os or app). (os, app)
versionstringThe version number of the operating system, application, or stack ( 2016.03.0).
version_codestringThe version code.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_blueprintsselectregionReturns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose. Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose. Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

SELECT
name,
app_category,
blueprint_id,
description,
group,
is_active,
license_url,
min_power,
platform,
product_url,
type_,
version,
version_code
FROM aws.lightsail.blueprints
WHERE region = '{{ region }}' -- required
;