Skip to content
v2.273.0

ConnectionRule Struct ​

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const connectionRule: ec2.ConnectionRule = {
  fromPort: 123,

  // the properties below are optional
  description: 'description',
  protocol: 'protocol',
  toPort: 123,
};

Properties ​

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= No description#
Description of this connection.

It is applied to both the ingress rule and the egress rule.

fromPortnumberfrom_portint | floatfromPortNumberFromPortdoubleFromPort*float64required#
Start of port range for the TCP and UDP protocols, or an ICMP type number.

If you specify icmp for the IpProtocol property, you can specify -1 as a wildcard (i.e., any ICMP type number).

protocolstringprotocolstrprotocolStringProtocolstringProtocol*string= tcp#
The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
notes

Use -1 to specify all protocols. If you specify -1, or a protocol number other than tcp, udp, icmp, or 58 (ICMPv6), traffic on all ports is allowed, regardless of any ports you specify. For tcp, udp, and icmp, you must specify a port range. For protocol 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed.

toPortnumberto_portint | floattoPortNumberToPortdoubleToPort*float64= If toPort is not specified, it w…#
End of port range for the TCP and UDP protocols, or an ICMP code.

If you specify icmp for the IpProtocol property, you can specify -1 as a wildcard (i.e., any ICMP code).

default

Default: If toPort is not specified, it will be the same as fromPort.