AWS::Lightsail::Instance

Lightsail Instance

Resource Type definition for AWS::Lightsail::Instance

Properties

12 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`BlueprintId`	`string`	RequiredCreate-only
`BundleId`	`string`	RequiredCreate-only
`InstanceName`	`string`	RequiredCreate-only
`AddOns`	`Array<AddOn>`
`AvailabilityZone`	`string`	Create-only
`Hardware`	`Hardware`
`KeyPairName`	`string`
`Location`	`Location`
`Networking`	`Networking`
`State`	`State`
`Tags`	`Array<Tag>`
`UserData`	`string`	Write-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`InstanceArn`	`string`	-
`Ipv6Addresses`	`Array<string>`	IPv6 addresses of the instance
`IsStaticIp`	`boolean`	Is the IP Address of the Instance is the static IP
`PrivateIpAddress`	`string`	Private IP Address of the Instance
`PublicIpAddress`	`string`	Public IP Address of the Instance
`ResourceType`	`string`	Resource type of Lightsail instance.
`SshKeyName`	`string`	SSH Key Name of the Lightsail instance.
`SupportCode`	`string`	Support code to help identify any issues
`UserName`	`string`	Username of the Lightsail instance.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Lightsail::Instance

Resources:
  MyResource:
    Type: AWS::Lightsail::Instance
    Properties:
      InstanceName: "my-instancename"
      BlueprintId: "my-blueprintid"
      BundleId: "my-bundleid"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

lightsail:CreateInstanceslightsail:GetInstanceslightsail:EnableAddOnlightsail:GetInstancelightsail:DisableAddOnlightsail:PutInstancePublicPortslightsail:AttachDisklightsail:DetachDisk

read

lightsail:GetInstanceslightsail:GetInstance

delete

lightsail:GetInstanceslightsail:GetInstancelightsail:DeleteInstance

list

lightsail:GetInstances

update

lightsail:GetInstanceslightsail:GetInstancelightsail:DeleteInstancelightsail:EnableAddOnlightsail:DisableAddOnlightsail:PutInstancePublicPortslightsail:AttachDisklightsail:DetachDisk

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceLightsail

Properties21

Required3

TaggingSupported

Primary IDInstanceName

Supported Operations

CreateReadDeleteListUpdate

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

InstanceNameBlueprintIdBundleIdAvailabilityZone

Related Resources

External Links

AWS Documentation