Top / Amazon Web Service / AWS Lightsail / Instance Public Ports

AWS Lightsail Instance Public Ports

This page shows how to write Terraform and CloudFormation for Lightsail Instance Public Ports and write them securely.

terraform-logo

Review your .tf file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

aws_lightsail_instance_public_ports (Terraform)

The Instance Public Ports in Lightsail can be configured in Terraform with the resource name aws_lightsail_instance_public_ports. The following sections describe 2 examples of how to use the resource and its parameters.

Example Usage from GitHub

aws-security.tf#L1
resource "aws_lightsail_instance_public_ports" "ph-ports-dnsonlyvpn" {
  count                   = var.dns_novpn == 0 ? 1 : 0
  instance_name           = aws_lightsail_instance.ph-instance.name
  port_info {
    protocol                = "tcp"
    from_port               = "22"
lightsail.tf#L13
resource "aws_lightsail_instance_public_ports" "test" {
  instance_name = aws_lightsail_instance.test.name

  port_info {
    protocol  = "tcp"
    from_port = 22

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

>> from Terraform Registry

Explanation in Terraform Registry

Opens ports for a specific Amazon Lightsail instance, and specifies the IP addresses allowed to connect to the instance through the ports, and the protocol. -> 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.

>> from Terraform Registry

AWS::Lightsail::Instance Port (CloudFormation)

The Instance Port in Lightsail can be configured in CloudFormation with the resource name AWS::Lightsail::Instance Port. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

AccessDirection The access direction (inbound or outbound).
Lightsail currently supports only inbound access direction. Required: No
Type: String
Update requires: No interruption

AccessFrom The location from which access is allowed. For example, Anywhere (0.0.0.0/0), or Custom if a specific IP address or range of IP addresses is allowed.
Required: No
Type: String
Update requires: No interruption

AccessType The type of access (Public or Private).
Required: No
Type: String
Update requires: No interruption

CidrListAliases An alias that defines access for a preconfigured range of IP addresses.
The only alias currently supported is lightsail-connect, which allows IP addresses of the browser-based RDP/SSH client in the Lightsail console to connect to your instance.
Required: No
Type: List of String
Update requires: No interruption

Cidrs The IPv4 address, or range of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol.
The ipv6Cidrs parameter lists the IPv6 addresses that are allowed to connect to an instance. Examples:

  • To allow the IP address 192.0.2.44, specify 192.0.2.44 or 192.0.2.44/32.
  • To allow the IP addresses 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.Required: No
    Type: List of String
    Update requires: No interruption

CommonName The common name of the port information.
Required: No
Type: String
Update requires: No interruption

FromPort The first port in a range of open ports on an instance.
Allowed ports:

  • TCP and UDP - 0 to 65535
  • ICMP - The ICMP type for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping.
  • ICMPv6 - The ICMP type for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code).Required: No
    Type: Integer
    Update requires: No interruption

Ipv6Cidrs The IPv6 address, or range of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. Only devices with an IPv6 address can connect to an instance through IPv6; otherwise, IPv4 should be used.
The cidrs parameter lists the IPv4 addresses that are allowed to connect to an instance. Required: No
Type: List of String
Update requires: No interruption

Protocol The IP protocol name.
The name can be one of the following:

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.
  • all - All transport layer protocol types.
  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.
  • icmp - Internet Control Message Protocol (ICMP) is used to send error messages and operational information indicating success or failure when communicating with an instance. For example, an error is indicated when an instance could not be reached. When you specify icmp as the protocol, you must specify the ICMP type using the fromPort parameter, and ICMP code using the toPort parameter.Required: No
    Type: String
    Update requires: No interruption

ToPort The last port in a range of open ports on an instance.
Allowed ports:

  • TCP and UDP - 0 to 65535
  • ICMP - The ICMP code for IPv4 addresses. For example, specify 8 as the fromPort (ICMP type), and -1 as the toPort (ICMP code), to enable ICMP Ping.
  • ICMPv6 - The ICMP code for IPv6 addresses. For example, specify 128 as the fromPort (ICMPv6 type), and 0 as toPort (ICMPv6 code).Required: No
    Type: Integer
    Update requires: No interruption

>> from AWS CloudFormation Documentation

Explanation in CloudFormation Registry

Port is a property of the Networking property. It describes information about ports for an instance.

>> from AWS CloudFormation Documentation

The Other Related AWS Lightsail Resources

Frequently asked questions

What is AWS Lightsail Instance Public Ports?

AWS Lightsail Instance Public Ports is a resource for Lightsail of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

Where can I find the example code for the AWS Lightsail Instance Public Ports?

For Terraform, the chadgeary/cloudblock and akkisain/TerraFrom-learniing source code examples are useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

Table of Contents