This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

lightsail¶

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

class pulumi_aws.lightsail.Domain(resource_name, opts=None, domain_name=None, __props__=None, __name__=None, __opts__=None)¶

Creates a domain resource for the specified domain (e.g., example.com). You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.

Note: Lightsail is currently only supported in a limited number of AWS Regions, please see “Regions and Availability Zones in Amazon Lightsail” for more details

import pulumi
import pulumi_aws as aws

domain_test = aws.lightsail.Domain("domainTest", domain_name="mydomain.com")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
domain_name (pulumi.Input[str]) – The name of the Lightsail domain to manage

arn: pulumi.Output[str] = None¶: The ARN of the Lightsail domain

domain_name: pulumi.Output[str] = None¶: The name of the Lightsail domain to manage

static get(resource_name, id, opts=None, arn=None, domain_name=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.
arn (pulumi.Input[str]) – The ARN of the Lightsail domain
domain_name (pulumi.Input[str]) – The name of the Lightsail domain to manage

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_aws.lightsail.Instance(resource_name, opts=None, availability_zone=None, blueprint_id=None, bundle_id=None, key_pair_name=None, name=None, tags=None, user_data=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Lightsail Instance. Amazon Lightsail is a service to provide easy virtual private servers with custom software already setup. See What is Amazon Lightsail? for more information.

Note: Lightsail is currently only supported in a limited number of AWS Regions, please see “Regions and Availability Zones in Amazon Lightsail” for more details

import pulumi
import pulumi_aws as aws

# Create a new GitLab Lightsail Instance
gitlab_test = aws.lightsail.Instance("gitlabTest",
    availability_zone="us-east-1b",
    blueprint_id="string",
    bundle_id="string",
    key_pair_name="some_key_name",
    tags={
        "foo": "bar",
    })

Lightsail currently supports the following Availability Zones (e.g. us-east-1a):

ap-northeast-1{a,c,d}
ap-northeast-2{a,c}
ap-south-1{a,b}
ap-southeast-1{a,b,c}
ap-southeast-2{a,b,c}
ca-central-1{a,b}
eu-central-1{a,b,c}
eu-west-1{a,b,c}
eu-west-2{a,b,c}
eu-west-3{a,b,c}
us-east-1{a,b,c,d,e,f}
us-east-2{a,b,c}
us-west-2{a,b,c}

Lightsail currently supports the following Blueprint IDs:

amazon_linux_2018_03_0_2
centos_7_1901_01
debian_8_7
debian_9_5
freebsd_11_1
opensuse_42_2
ubuntu_16_04_2
ubuntu_18_04

drupal_8_5_6
gitlab_11_1_4_1
joomla_3_8_11
lamp_5_6_37_2
lamp_7_1_20_1
magento_2_2_5
mean_4_0_1
nginx_1_14_0_1
nodejs_10_8_0
plesk_ubuntu_17_8_11_1
redmine_3_4_6
wordpress_4_9_8
wordpress_multisite_4_9_8

Lightsail currently supports the following Bundle IDs (e.g. an instance in ap-northeast-1 would use small_2_0):

A Bundle ID starts with one of the below size prefixes:

nano_
micro_
small_
medium_
large_
xlarge_
2xlarge_

A Bundle ID ends with one of the following suffixes depending on Availability Zone:

ap-northeast-1: 2_0
ap-northeast-2: 2_0
ap-south-1: 2_1
ap-southeast-1: 2_0
ap-southeast-2: 2_2
ca-central-1: 2_0
eu-central-1: 2_0
eu-west-1: 2_0
eu-west-2: 2_0
eu-west-3: 2_0
us-east-1: 2_0
us-east-2: 2_0
us-west-2: 2_0

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
availability_zone (pulumi.Input[str]) – The Availability Zone in which to create your instance (see list below)
blueprint_id (pulumi.Input[str]) – The ID for a virtual private server image (see list below)
bundle_id (pulumi.Input[str]) – The bundle of specification information (see list below)
key_pair_name (pulumi.Input[str]) – The name of your key pair. Created in the Lightsail console (cannot use ec2.KeyPair at this time)
name (pulumi.Input[str]) – The name of the Lightsail Instance. Names be unique within each AWS Region in your Lightsail account.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
user_data (pulumi.Input[str]) – launch script to configure server with additional user data

arn: pulumi.Output[str] = None¶: The ARN of the Lightsail instance (matches id).

availability_zone: pulumi.Output[str] = None¶: The Availability Zone in which to create your instance (see list below)

blueprint_id: pulumi.Output[str] = None¶: The ID for a virtual private server image (see list below)

bundle_id: pulumi.Output[str] = None¶: The bundle of specification information (see list below)

created_at: pulumi.Output[str] = None¶

The timestamp when the instance was created.

availability_zone
blueprint_id
bundle_id
key_pair_name
user_data

key_pair_name: pulumi.Output[str] = None¶: The name of your key pair. Created in the Lightsail console (cannot use ec2.KeyPair at this time)

name: pulumi.Output[str] = None¶: The name of the Lightsail Instance. Names be unique within each AWS Region in your Lightsail account.

tags: pulumi.Output[dict] = None¶: A map of tags to assign to the resource.

user_data: pulumi.Output[str] = None¶: launch script to configure server with additional user data

static get(resource_name, id, opts=None, arn=None, availability_zone=None, blueprint_id=None, bundle_id=None, cpu_count=None, created_at=None, ipv6_address=None, is_static_ip=None, key_pair_name=None, name=None, private_ip_address=None, public_ip_address=None, ram_size=None, tags=None, user_data=None, username=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.
arn (pulumi.Input[str]) – The ARN of the Lightsail instance (matches id).
availability_zone (pulumi.Input[str]) – The Availability Zone in which to create your instance (see list below)
blueprint_id (pulumi.Input[str]) – The ID for a virtual private server image (see list below)
bundle_id (pulumi.Input[str]) – The bundle of specification information (see list below)
created_at (pulumi.Input[str]) – The timestamp when the instance was created.

* `availability_zone`
* `blueprint_id`
* `bundle_id`
* `key_pair_name`
* `user_data`

Parameters

key_pair_name (pulumi.Input[str]) – The name of your key pair. Created in the Lightsail console (cannot use ec2.KeyPair at this time)
name (pulumi.Input[str]) – The name of the Lightsail Instance. Names be unique within each AWS Region in your Lightsail account.
tags (pulumi.Input[dict]) – A map of tags to assign to the resource.
user_data (pulumi.Input[str]) – launch script to configure server with additional user data

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_aws.lightsail.KeyPair(resource_name, opts=None, name=None, name_prefix=None, pgp_key=None, public_key=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Lightsail Key Pair, for use with Lightsail Instances. These key pairs are separate from EC2 Key Pairs, and must be created or imported for use with Lightsail.

Note: Lightsail is currently only supported in a limited number of AWS Regions, please see “Regions and Availability Zones in Amazon Lightsail” for more details

import pulumi
import pulumi_aws as aws

# Create a new Lightsail Key Pair
lg_key_pair = aws.lightsail.KeyPair("lgKeyPair")

import pulumi
import pulumi_aws as aws

lg_key_pair = aws.lightsail.KeyPair("lgKeyPair", pgp_key="keybase:keybaseusername")

import pulumi
import pulumi_aws as aws

lg_key_pair = aws.lightsail.KeyPair("lgKeyPair", public_key=(lambda path: open(path).read())("~/.ssh/id_rsa.pub"))

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name of the Lightsail Key Pair. If omitted, a unique name will be generated by this provider
pgp_key (pulumi.Input[str]) – An optional PGP key to encrypt the resulting private key material. Only used when creating a new key pair
public_key (pulumi.Input[str]) – The public key material. This public key will be imported into Lightsail

arn: pulumi.Output[str] = None¶: The ARN of the Lightsail key pair

encrypted_fingerprint: pulumi.Output[str] = None¶: The MD5 public key fingerprint for the encrypted private key

encrypted_private_key: pulumi.Output[str] = None¶: the private key material, base 64 encoded and encrypted with the given pgp_key. This is only populated when creating a new key and pgp_key is supplied

fingerprint: pulumi.Output[str] = None¶: The MD5 public key fingerprint as specified in section 4 of RFC 4716.

name: pulumi.Output[str] = None¶: The name of the Lightsail Key Pair. If omitted, a unique name will be generated by this provider

pgp_key: pulumi.Output[str] = None¶: An optional PGP key to encrypt the resulting private key material. Only used when creating a new key pair

private_key: pulumi.Output[str] = None¶: the private key, base64 encoded. This is only populated when creating a new key, and when no pgp_key is provided

public_key: pulumi.Output[str] = None¶: The public key material. This public key will be imported into Lightsail

static get(resource_name, id, opts=None, arn=None, encrypted_fingerprint=None, encrypted_private_key=None, fingerprint=None, name=None, name_prefix=None, pgp_key=None, private_key=None, public_key=None)¶

Get an existing KeyPair 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.
arn (pulumi.Input[str]) – The ARN of the Lightsail key pair
encrypted_fingerprint (pulumi.Input[str]) – The MD5 public key fingerprint for the encrypted private key
encrypted_private_key (pulumi.Input[str]) – the private key material, base 64 encoded and encrypted with the given pgp_key. This is only populated when creating a new key and pgp_key is supplied
fingerprint (pulumi.Input[str]) – The MD5 public key fingerprint as specified in section 4 of RFC 4716.
name (pulumi.Input[str]) – The name of the Lightsail Key Pair. If omitted, a unique name will be generated by this provider
pgp_key (pulumi.Input[str]) – An optional PGP key to encrypt the resulting private key material. Only used when creating a new key pair
private_key (pulumi.Input[str]) – the private key, base64 encoded. This is only populated when creating a new key, and when no pgp_key is provided
public_key (pulumi.Input[str]) – The public key material. This public key will be imported into Lightsail

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_aws.lightsail.StaticIp(resource_name, opts=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Allocates a static IP address.

Note: Lightsail is currently only supported in a limited number of AWS Regions, please see “Regions and Availability Zones in Amazon Lightsail” for more details

import pulumi
import pulumi_aws as aws

test = aws.lightsail.StaticIp("test")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
name (pulumi.Input[str]) – The name for the allocated static IP

arn: pulumi.Output[str] = None¶: The ARN of the Lightsail static IP

ip_address: pulumi.Output[str] = None¶: The allocated static IP address

name: pulumi.Output[str] = None¶: The name for the allocated static IP

support_code: pulumi.Output[str] = None¶: The support code.

static get(resource_name, id, opts=None, arn=None, ip_address=None, name=None, support_code=None)¶

Get an existing StaticIp 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.
arn (pulumi.Input[str]) – The ARN of the Lightsail static IP
ip_address (pulumi.Input[str]) – The allocated static IP address
name (pulumi.Input[str]) – The name for the allocated static IP
support_code (pulumi.Input[str]) – The support code.

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_aws.lightsail.StaticIpAttachment(resource_name, opts=None, instance_name=None, static_ip_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a static IP address attachment - relationship between a Lightsail static IP & Lightsail instance.

Note: Lightsail is currently only supported in a limited number of AWS Regions, please see “Regions and Availability Zones in Amazon Lightsail” for more details

import pulumi
import pulumi_aws as aws

test_static_ip = aws.lightsail.StaticIp("testStaticIp")
test_instance = aws.lightsail.Instance("testInstance",
    availability_zone="us-east-1b",
    blueprint_id="string",
    bundle_id="string",
    key_pair_name="some_key_name")
test_static_ip_attachment = aws.lightsail.StaticIpAttachment("testStaticIpAttachment",
    instance_name=test_instance.id,
    static_ip_name=test_static_ip.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_name (pulumi.Input[str]) – The name of the Lightsail instance to attach the IP to
static_ip_name (pulumi.Input[str]) – The name of the allocated static IP

instance_name: pulumi.Output[str] = None¶: The name of the Lightsail instance to attach the IP to

ip_address: pulumi.Output[str] = None¶: The allocated static IP address

static_ip_name: pulumi.Output[str] = None¶: The name of the allocated static IP

static get(resource_name, id, opts=None, instance_name=None, ip_address=None, static_ip_name=None)¶

Get an existing StaticIpAttachment 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.
instance_name (pulumi.Input[str]) – The name of the Lightsail instance to attach the IP to
ip_address (pulumi.Input[str]) – The allocated static IP address
static_ip_name (pulumi.Input[str]) – The name of the allocated static IP

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

lightsail¶

On This Page