Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-lightsail-instance.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::Lightsail::Instance. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-lightsail.git

Properties

InstanceName string | Aws_CF_FunctionString required

The names to use for your new Lightsail instance.

BundleId string | Aws_CF_FunctionString required

The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ).

BlueprintId string | Aws_CF_FunctionString required

The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ).

Location object

Location of a resource.

2 nested properties
AvailabilityZone string | Aws_CF_FunctionString

The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.

RegionName string | Aws_CF_FunctionString

The Region Name in which to create your instance.

Hardware object

Hardware of the Instance.

3 nested properties
CpuCount integer

CPU count of the Instance.

RamSizeInGb integer

RAM Size of the Instance.

Disks Disk[]

Disks attached to the Instance.

uniqueItems=true
State object

Current State of the Instance.

2 nested properties
Code integer

Status code of the Instance.

Name string | Aws_CF_FunctionString

Status code of the Instance.

Networking object

Networking of the Instance.

2 nested properties
Ports Port[] required

Ports to the Instance.

uniqueItems=true
MonthlyTransfer object

Monthly Transfer of the Instance.

1 nested properties
GbPerMonthAllocated string | Aws_CF_FunctionString

GbPerMonthAllocated of the Instance.

AddOns AddOn[]

An array of objects representing the add-ons to enable for the new instance.

UserData string | Aws_CF_FunctionString

A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

KeyPairName string | Aws_CF_FunctionString

The name of your key pair.

Tags Tag[]

An array of key-value pairs to apply to this resource.

uniqueItems=true

Definitions

Tag object

A key-value pair to associate with a resource.

Key string | Aws_CF_FunctionString required

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string | Aws_CF_FunctionString

The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

ipv6Cidrs string[]

IPv6 Cidrs

cidrs string[]

cidrs

cidrListAliases string[]

cidr List Aliases

AutoSnapshotAddOn object

An object that represents additional parameters when enabling or modifying the automatic snapshot add-on

SnapshotTimeOfDay string | Aws_CF_FunctionString

The daily time when an automatic snapshot will be created.

AddOn object

A addon associate with a resource.

AddOnType string | Aws_CF_FunctionString required

The add-on type

Status string | Aws_CF_FunctionString

Status of the Addon

AutoSnapshotAddOnRequest object

An object that represents additional parameters when enabling or modifying the automatic snapshot add-on

1 nested properties
SnapshotTimeOfDay string | Aws_CF_FunctionString

The daily time when an automatic snapshot will be created.

Location object

Location of a resource.

AvailabilityZone string | Aws_CF_FunctionString

The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request.

RegionName string | Aws_CF_FunctionString

The Region Name in which to create your instance.

Disk object

Disk associated with the Instance.

DiskName string | Aws_CF_FunctionString required

The names to use for your new Lightsail disk.

Path string | Aws_CF_FunctionString required

Path of the disk attached to the instance.

SizeInGb string | Aws_CF_FunctionString

Size of the disk attached to the Instance.

IsSystemDisk boolean

Is the Attached disk is the system disk of the Instance.

IOPS integer

IOPS of disk.

AttachedTo string | Aws_CF_FunctionString

Instance attached to the disk.

AttachmentState string | Aws_CF_FunctionString

Attachment state of the disk.

Hardware object

Hardware of the Instance.

CpuCount integer

CPU count of the Instance.

RamSizeInGb integer

RAM Size of the Instance.

Disks Disk[]

Disks attached to the Instance.

uniqueItems=true
State object

Current State of the Instance.

Code integer

Status code of the Instance.

Name string | Aws_CF_FunctionString

Status code of the Instance.

Port object

Port of the Instance.

FromPort integer

From Port of the Instance.

ToPort integer

To Port of the Instance.

Protocol string | Aws_CF_FunctionString

Port Protocol of the Instance.

AccessFrom string | Aws_CF_FunctionString

Access From Protocol of the Instance.

AccessType string | Aws_CF_FunctionString

Access Type Protocol of the Instance.

CommonName string | Aws_CF_FunctionString

CommonName for Protocol of the Instance.

AccessDirection string | Aws_CF_FunctionString

Access Direction for Protocol of the Instance(inbound/outbound).

Ipv6Cidrs string[]

IPv6 Cidrs

CidrListAliases string[]

cidr List Aliases

Cidrs string[]

cidrs

MonthlyTransfer object

Monthly Transfer of the Instance.

GbPerMonthAllocated string | Aws_CF_FunctionString

GbPerMonthAllocated of the Instance.

Networking object

Networking of the Instance.

Ports Port[] required

Ports to the Instance.

uniqueItems=true
MonthlyTransfer object

Monthly Transfer of the Instance.

1 nested properties
GbPerMonthAllocated string | Aws_CF_FunctionString

GbPerMonthAllocated of the Instance.