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.
The OpenInstancePublicPorts
action supports tag-based access control via resource tags applied to the resource identified by instanceName
. For more information, see the Amazon Lightsail Developer Guide .
See also: AWS API Documentation
open-instance-public-ports
--port-info <value>
--instance-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--port-info
(structure)
An object to describe the ports to open for the specified instance.
fromPort -> (integer)
The first port in a range of open ports on an instance.
Allowed ports:
TCP and UDP -
0
to65535
ICMP - The ICMP type for IPv4 addresses. For example, specify
8
as thefromPort
(ICMP type), and-1
as thetoPort
(ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .ICMPv6 - The ICMP type for IPv6 addresses. For example, specify
128
as thefromPort
(ICMPv6 type), and0
astoPort
(ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6 .toPort -> (integer)
The last port in a range of open ports on an instance.
Allowed ports:
TCP and UDP -
0
to65535
ICMP - The ICMP code for IPv4 addresses. For example, specify
8
as thefromPort
(ICMP type), and-1
as thetoPort
(ICMP code), to enable ICMP Ping. For more information, see Control Messages on Wikipedia .ICMPv6 - The ICMP code for IPv6 addresses. For example, specify
128
as thefromPort
(ICMPv6 type), and0
astoPort
(ICMPv6 code). For more information, see Internet Control Message Protocol for IPv6 .protocol -> (string)
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. For more general information, see Transport layer on Wikipedia .
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 specifyicmp
as theprotocol
, you must specify the ICMP type using thefromPort
parameter, and ICMP code using thetoPort
parameter.cidrs -> (list)
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.
Note
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
, specify192.0.2.44
or192.0.2.44/32
.To allow the IP addresses
192.0.2.0
to192.0.2.255
, specify192.0.2.0/24
.For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia .
(string)
ipv6Cidrs -> (list)
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.
Note
The
cidrs
parameter lists the IPv4 addresses that are allowed to connect to an instance.For more information about CIDR block notation, see Classless Inter-Domain Routing on Wikipedia .
(string)
cidrListAliases -> (list)
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.(string)
Shorthand Syntax:
fromPort=integer,toPort=integer,protocol=string,cidrs=string,string,ipv6Cidrs=string,string,cidrListAliases=string,stringJSON Syntax:
{ "fromPort": integer, "toPort": integer, "protocol": "tcp"|"all"|"udp"|"icmp", "cidrs": ["string", ...], "ipv6Cidrs": ["string", ...], "cidrListAliases": ["string", ...] }
--instance-name
(string)The name of the instance for which to open ports.
--cli-input-json
|--cli-input-yaml
(string) Reads arguments from the JSON string provided. The JSON string follows the format provided by--generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with--cli-input-yaml
.
--generate-cli-skeleton
(string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the valueinput
, prints a sample input JSON that can be used as an argument for--cli-input-json
. Similarly, if providedyaml-input
it will print a sample input YAML that can be used with--cli-input-yaml
. If provided with the valueoutput
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.Global Options¶
--debug
(boolean)Turn on debug logging.
--endpoint-url
(string)Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)Disable automatic pagination.
--output
(string)The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)A JMESPath query to use in filtering the response data.
--profile
(string)Use a specific profile from your credential file.
--region
(string)The region to use. Overrides config/env settings.
--version
(string)Display the version of this tool.
--color
(string)Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb://
will always be treated as binary and use the file contents directly regardless of thecli-binary-format
setting. When usingfile://
the file contents will need to properly formatted for the configuredcli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)Disable cli pager for output.
--cli-auto-prompt
(boolean)Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To open firewall ports for an instance
The following
open-instance-public-ports
example opens TCP port 22 on the specified instance.aws lightsail open-instance-public-ports \ --instance-name MEAN-2 \ --port-info fromPort=22,protocol=TCP,toPort=22Output:
{ "operation": { "id": "719744f0-a022-46f2-9f11-6EXAMPLE4642", "resourceName": "MEAN-2", "resourceType": "Instance", "createdAt": 1571072906.849, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "isTerminal": true, "operationDetails": "22/tcp", "operationType": "OpenInstancePublicPorts", "status": "Succeeded", "statusChangedAt": 1571072906.849 } }Output¶
operation -> (structure)
An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
id -> (string)
The ID of the operation.
resourceName -> (string)
The resource name.
resourceType -> (string)
The resource type.
createdAt -> (timestamp)
The timestamp when the operation was initialized (e.g.,
1479816991.349
).location -> (structure)
The Amazon Web Services Region and Availability Zone.
availabilityZone -> (string)
The Availability Zone. Follows the format
us-east-2a
(case-sensitive).regionName -> (string)
The Amazon Web Services Region name.
isTerminal -> (boolean)
A Boolean value indicating whether the operation is terminal.
operationDetails -> (string)
Details about the operation (e.g.,
Debian-1GB-Ohio-1
).operationType -> (string)
The type of operation.
status -> (string)
The status of the operation.
statusChangedAt -> (timestamp)
The timestamp when the status was changed (e.g.,
1479816991.349
).errorCode -> (string)
The error code.
errorDetails -> (string)
The error details.