Package software.amazon.awscdk.services.ec2

Interface ConnectionRule

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ConnectionRule.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:39.279Z")
@Stability(Stable)
public interface ConnectionRule
extends software.amazon.jsii.JsiiSerializable

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 ConnectionRule connectionRule = ConnectionRule.builder()
         .fromPort(123)
         // the properties below are optional
         .description("description")
         .protocol("protocol")
         .toPort(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ConnectionRule.Builder	A builder for ConnectionRule
static final class	ConnectionRule.Jsii$Proxy	An implementation for ConnectionRule

Method Summary

Modifier and Type	Method	Description
static ConnectionRule.Builder	builder()
default String	getDescription()	Description of this connection.
Number	getFromPort()	Start of port range for the TCP and UDP protocols, or an ICMP type number.
default String	getProtocol()	The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
default Number	getToPort()	End of port range for the TCP and UDP protocols, or an ICMP code.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFromPort

@Stability(Stable)
@NotNull
Number getFromPort()

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).

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

Description of this connection.

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

Default: No description

getProtocol

@Stability(Stable)
@Nullable
default String getProtocol()

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).

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.

Default: tcp

getToPort

@Stability(Stable)
@Nullable
default Number getToPort()

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: If toPort is not specified, it will be the same as fromPort.

builder

@Stability(Stable)
static ConnectionRule.Builder builder()

Returns:

a ConnectionRule.Builder of ConnectionRule