Fork me on GitHub

Module lightsail

@pulumi/aws > lightsail

Index

lightsail/domain.ts lightsail/instance.ts lightsail/keyPair.ts lightsail/staticIp.ts lightsail/staticIpAttachment.ts

class Domain

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

constructor

new Domain(name: string, args: DomainArgs, opts?: pulumi.CustomResourceOptions)

Create a Domain resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainState): Domain

Get an existing Domain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the Lightsail domain

property domainName

public domainName: pulumi.Output<string>;

The name of the Lightsail domain to manage

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Instance

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

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState): Instance

Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the Lightsail instance (matches id).

  • availability_zone
  • blueprint_id
  • bundle_id
  • key_pair_name
  • user_data

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The Availability Zone in which to create your instance. At this time, must be in us-east-1, us-east-2, us-west-2, eu-west-1, eu-west-2, eu-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-south-1 regions

property blueprintId

public blueprintId: pulumi.Output<string>;

The ID for a virtual private server image (see list below)

property bundleId

public bundleId: pulumi.Output<string>;

The bundle of specification information (see list below)

property cpuCount

public cpuCount: pulumi.Output<number>;

property createdAt

public createdAt: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipv6Address

public ipv6Address: pulumi.Output<string>;

property isStaticIp

public isStaticIp: pulumi.Output<boolean>;

property keyPairName

public keyPairName: pulumi.Output<string | undefined>;

The name of your key pair. Created in the Lightsail console (cannot use aws_key_pair at this time)

property name

public name: pulumi.Output<string>;

The name of the Lightsail Instance

property privateIpAddress

public privateIpAddress: pulumi.Output<string>;

property publicIpAddress

public publicIpAddress: pulumi.Output<string>;

property ramSize

public ramSize: pulumi.Output<number>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userData

public userData: pulumi.Output<string | undefined>;

launch script to configure server with additional user data

property username

public username: pulumi.Output<string>;

class KeyPair

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

constructor

new KeyPair(name: string, args?: KeyPairArgs, opts?: pulumi.CustomResourceOptions)

Create a KeyPair resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: KeyPairState): KeyPair

Get an existing KeyPair resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the Lightsail key pair

property encryptedFingerprint

public encryptedFingerprint: pulumi.Output<string>;

The MD5 public key fingerprint for the encrypted private key

property encryptedPrivateKey

public encryptedPrivateKey: pulumi.Output<string>;

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

property fingerprint

public fingerprint: pulumi.Output<string>;

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the Lightsail Key Pair. If omitted, a unique name will be generated by Terraform

property namePrefix

public namePrefix: pulumi.Output<string | undefined>;

property pgpKey

public pgpKey: pulumi.Output<string | undefined>;

An optional PGP key to encrypt the resulting private key material. Only used when creating a new key pair

property privateKey

public privateKey: pulumi.Output<string>;

the private key, base64 encoded. This is only populated when creating a new key, and when no pgp_key is provided

property publicKey

public publicKey: pulumi.Output<string>;

The public key material. This public key will be imported into Lightsail

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class StaticIp

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

constructor

new StaticIp(name: string, args?: StaticIpArgs, opts?: pulumi.CustomResourceOptions)

Create a StaticIp resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StaticIpState): StaticIp

Get an existing StaticIp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the Lightsail static IP

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipAddress

public ipAddress: pulumi.Output<string>;

The allocated static IP address

property name

public name: pulumi.Output<string>;

The name for the allocated static IP

property supportCode

public supportCode: pulumi.Output<string>;

The support code.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class StaticIpAttachment

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

constructor

new StaticIpAttachment(name: string, args: StaticIpAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a StaticIpAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StaticIpAttachmentState): StaticIpAttachment

Get an existing StaticIpAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceName

public instanceName: pulumi.Output<string>;

The name of the Lightsail instance to attach the IP to

property staticIpName

public staticIpName: pulumi.Output<string>;

The name of the allocated static IP

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface DomainArgs

The set of arguments for constructing a Domain resource.

property domainName

domainName: pulumi.Input<string>;

The name of the Lightsail domain to manage

interface DomainState

Input properties used for looking up and filtering Domain resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the Lightsail domain

property domainName

domainName?: pulumi.Input<string>;

The name of the Lightsail domain to manage

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property availabilityZone

availabilityZone: pulumi.Input<string>;

The Availability Zone in which to create your instance. At this time, must be in us-east-1, us-east-2, us-west-2, eu-west-1, eu-west-2, eu-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-south-1 regions

property blueprintId

blueprintId: pulumi.Input<string>;

The ID for a virtual private server image (see list below)

property bundleId

bundleId: pulumi.Input<string>;

The bundle of specification information (see list below)

property keyPairName

keyPairName?: pulumi.Input<string>;

The name of your key pair. Created in the Lightsail console (cannot use aws_key_pair at this time)

property name

name?: pulumi.Input<string>;

The name of the Lightsail Instance

property userData

userData?: pulumi.Input<string>;

launch script to configure server with additional user data

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the Lightsail instance (matches id).

  • availability_zone
  • blueprint_id
  • bundle_id
  • key_pair_name
  • user_data

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The Availability Zone in which to create your instance. At this time, must be in us-east-1, us-east-2, us-west-2, eu-west-1, eu-west-2, eu-central-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-south-1 regions

property blueprintId

blueprintId?: pulumi.Input<string>;

The ID for a virtual private server image (see list below)

property bundleId

bundleId?: pulumi.Input<string>;

The bundle of specification information (see list below)

property cpuCount

cpuCount?: pulumi.Input<number>;

property createdAt

createdAt?: pulumi.Input<string>;

property ipv6Address

ipv6Address?: pulumi.Input<string>;

property isStaticIp

isStaticIp?: pulumi.Input<boolean>;

property keyPairName

keyPairName?: pulumi.Input<string>;

The name of your key pair. Created in the Lightsail console (cannot use aws_key_pair at this time)

property name

name?: pulumi.Input<string>;

The name of the Lightsail Instance

property privateIpAddress

privateIpAddress?: pulumi.Input<string>;

property publicIpAddress

publicIpAddress?: pulumi.Input<string>;

property ramSize

ramSize?: pulumi.Input<number>;

property userData

userData?: pulumi.Input<string>;

launch script to configure server with additional user data

property username

username?: pulumi.Input<string>;

interface KeyPairArgs

The set of arguments for constructing a KeyPair resource.

property name

name?: pulumi.Input<string>;

The name of the Lightsail Key Pair. If omitted, a unique name will be generated by Terraform

property namePrefix

namePrefix?: pulumi.Input<string>;

property pgpKey

pgpKey?: pulumi.Input<string>;

An optional PGP key to encrypt the resulting private key material. Only used when creating a new key pair

property publicKey

publicKey?: pulumi.Input<string>;

The public key material. This public key will be imported into Lightsail

interface KeyPairState

Input properties used for looking up and filtering KeyPair resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the Lightsail key pair

property encryptedFingerprint

encryptedFingerprint?: pulumi.Input<string>;

The MD5 public key fingerprint for the encrypted private key

property encryptedPrivateKey

encryptedPrivateKey?: pulumi.Input<string>;

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

property fingerprint

fingerprint?: pulumi.Input<string>;

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

property name

name?: pulumi.Input<string>;

The name of the Lightsail Key Pair. If omitted, a unique name will be generated by Terraform

property namePrefix

namePrefix?: pulumi.Input<string>;

property pgpKey

pgpKey?: pulumi.Input<string>;

An optional PGP key to encrypt the resulting private key material. Only used when creating a new key pair

property privateKey

privateKey?: pulumi.Input<string>;

the private key, base64 encoded. This is only populated when creating a new key, and when no pgp_key is provided

property publicKey

publicKey?: pulumi.Input<string>;

The public key material. This public key will be imported into Lightsail

interface StaticIpArgs

The set of arguments for constructing a StaticIp resource.

property name

name?: pulumi.Input<string>;

The name for the allocated static IP

interface StaticIpAttachmentArgs

The set of arguments for constructing a StaticIpAttachment resource.

property instanceName

instanceName: pulumi.Input<string>;

The name of the Lightsail instance to attach the IP to

property staticIpName

staticIpName: pulumi.Input<string>;

The name of the allocated static IP

interface StaticIpAttachmentState

Input properties used for looking up and filtering StaticIpAttachment resources.

property instanceName

instanceName?: pulumi.Input<string>;

The name of the Lightsail instance to attach the IP to

property staticIpName

staticIpName?: pulumi.Input<string>;

The name of the allocated static IP

interface StaticIpState

Input properties used for looking up and filtering StaticIp resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the Lightsail static IP

property ipAddress

ipAddress?: pulumi.Input<string>;

The allocated static IP address

property name

name?: pulumi.Input<string>;

The name for the allocated static IP

property supportCode

supportCode?: pulumi.Input<string>;

The support code.