software.amazon.awscdk.services.ec2

Class ConnectionRule.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.ConnectionRule.Builder

Enclosing interface:

ConnectionRule

@Stability(value=Stable)
public static final class ConnectionRule.Builder
extends Object

A builder for ConnectionRule

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ConnectionRule	build() Builds the configured instance.
ConnectionRule.Builder	description(String description) Sets the value of ConnectionRule.getDescription()
ConnectionRule.Builder	fromPort(Number fromPort) Sets the value of ConnectionRule.getFromPort()
ConnectionRule.Builder	protocol(String protocol) Sets the value of ConnectionRule.getProtocol()
ConnectionRule.Builder	toPort(Number toPort) Sets the value of ConnectionRule.getToPort()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

fromPort

@Stability(value=Stable)
public ConnectionRule.Builder fromPort(Number fromPort)

Sets the value of ConnectionRule.getFromPort()

Parameters:

fromPort - Start of port range for the TCP and UDP protocols, or an ICMP type number. This parameter is required. If you specify icmp for the IpProtocol property, you can specify -1 as a wildcard (i.e., any ICMP type number).

Returns:

this

description

@Stability(value=Stable)
public ConnectionRule.Builder description(String description)

Sets the value of ConnectionRule.getDescription()

Parameters:

description - Description of this connection. It is applied to both the ingress rule and the egress rule.

Returns:

this

protocol

@Stability(value=Stable)
public ConnectionRule.Builder protocol(String protocol)

Sets the value of ConnectionRule.getProtocol()

Parameters:

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

Returns:

this

toPort

@Stability(value=Stable)
public ConnectionRule.Builder toPort(Number toPort)

Sets the value of ConnectionRule.getToPort()

Parameters:

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

Returns:

this

build

@Stability(value=Stable)
public ConnectionRule build()

Builds the configured instance.

Returns:

a new instance of ConnectionRule

Throws:

NullPointerException - if any required attribute was not provided