Menu
Amazon Lightsail
REST API Reference (API Version 2016-11-28)

Blueprint

Describes a blueprint (a virtual private server image).

Contents

blueprintId

The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).

Type: String

Pattern: .*\S.*

Required: No

description

The description of the blueprint.

Type: String

Required: No

group

The group name of the blueprint (e.g., amazon-linux).

Type: String

Pattern: .*\S.*

Required: No

isActive

A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.

Type: Boolean

Required: No

licenseUrl

The end-user license agreement URL for the image or blueprint.

Type: String

Required: No

minPower

The 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.

Type: Integer

Required: No

name

The friendly name of the blueprint (e.g., Amazon Linux).

Type: String

Pattern: \w[\w\-]*\w

Required: No

platform

The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.

Type: String

Valid Values: LINUX_UNIX | WINDOWS

Required: No

productUrl

The product URL to learn more about the image or blueprint.

Type: String

Required: No

type

The type of the blueprint (e.g., os or app).

Type: String

Valid Values: os | app

Required: No

version

The version number of the operating system, application, or stack (e.g., 2016.03.0).

Type: String

Required: No

versionCode

The version code.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: