Package software.amazon.awssdk.services.ec2.model

Interface IpPermission.Builder

All Superinterfaces:

Buildable, CopyableBuilder<IpPermission.Builder,IpPermission>, SdkBuilder<IpPermission.Builder,IpPermission>, SdkPojo

Enclosing class:

IpPermission

@Mutable
@NotThreadSafe
public static interface IpPermission.Builder
extends SdkPojo, CopyableBuilder<IpPermission.Builder,IpPermission>

Method Summary

Modifier and Type	Method	Description
IpPermission.Builder	fromPort(Integer fromPort)	If the protocol is TCP or UDP, this is the start of the port range.
IpPermission.Builder	ipProtocol(String ipProtocol)	The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
IpPermission.Builder	ipRanges(Collection<IpRange> ipRanges)	The IPv4 address ranges.
IpPermission.Builder	ipRanges(Consumer<IpRange.Builder>... ipRanges)	The IPv4 address ranges.
IpPermission.Builder	ipRanges(IpRange... ipRanges)	The IPv4 address ranges.
IpPermission.Builder	ipv6Ranges(Collection<Ipv6Range> ipv6Ranges)	The IPv6 address ranges.
IpPermission.Builder	ipv6Ranges(Consumer<Ipv6Range.Builder>... ipv6Ranges)	The IPv6 address ranges.
IpPermission.Builder	ipv6Ranges(Ipv6Range... ipv6Ranges)	The IPv6 address ranges.
IpPermission.Builder	prefixListIds(Collection<PrefixListId> prefixListIds)	The prefix list IDs.
IpPermission.Builder	prefixListIds(Consumer<PrefixListId.Builder>... prefixListIds)	The prefix list IDs.
IpPermission.Builder	prefixListIds(PrefixListId... prefixListIds)	The prefix list IDs.
IpPermission.Builder	toPort(Integer toPort)	If the protocol is TCP or UDP, this is the end of the port range.
IpPermission.Builder	userIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs)	The security group and Amazon Web Services account ID pairs.
IpPermission.Builder	userIdGroupPairs(Consumer<UserIdGroupPair.Builder>... userIdGroupPairs)	The security group and Amazon Web Services account ID pairs.
IpPermission.Builder	userIdGroupPairs(UserIdGroupPair... userIdGroupPairs)	The security group and Amazon Web Services account ID pairs.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

ipProtocol

IpPermission.Builder ipProtocol(String ipProtocol)

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

Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

Parameters:

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

Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

Returns:

Returns a reference to this object so that method calls can be chained together.

fromPort

IpPermission.Builder fromPort(Integer fromPort)

If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

Parameters:

fromPort - If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

Returns:

Returns a reference to this object so that method calls can be chained together.

toPort

IpPermission.Builder toPort(Integer toPort)

If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

Parameters:

toPort - If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

Returns:

Returns a reference to this object so that method calls can be chained together.

userIdGroupPairs

IpPermission.Builder userIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs)

The security group and Amazon Web Services account ID pairs.

Parameters:

userIdGroupPairs - The security group and Amazon Web Services account ID pairs.

Returns:

Returns a reference to this object so that method calls can be chained together.

userIdGroupPairs

IpPermission.Builder userIdGroupPairs(UserIdGroupPair... userIdGroupPairs)

The security group and Amazon Web Services account ID pairs.

Parameters:

userIdGroupPairs - The security group and Amazon Web Services account ID pairs.

Returns:

Returns a reference to this object so that method calls can be chained together.

userIdGroupPairs

IpPermission.Builder userIdGroupPairs(Consumer<UserIdGroupPair.Builder>... userIdGroupPairs)

The security group and Amazon Web Services account ID pairs.

This is a convenience method that creates an instance of the UserIdGroupPair.Builder avoiding the need to create one manually via UserIdGroupPair.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #userIdGroupPairs(List).

Parameters:

userIdGroupPairs - a consumer that will call methods on UserIdGroupPair.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#userIdGroupPairs(java.util.Collection)

ipRanges

IpPermission.Builder ipRanges(Collection<IpRange> ipRanges)

The IPv4 address ranges.

Parameters:

ipRanges - The IPv4 address ranges.

Returns:

Returns a reference to this object so that method calls can be chained together.

ipRanges

IpPermission.Builder ipRanges(IpRange... ipRanges)

The IPv4 address ranges.

Parameters:

ipRanges - The IPv4 address ranges.

Returns:

Returns a reference to this object so that method calls can be chained together.

ipRanges

IpPermission.Builder ipRanges(Consumer<IpRange.Builder>... ipRanges)

The IPv4 address ranges.

This is a convenience method that creates an instance of the IpRange.Builder avoiding the need to create one manually via IpRange.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #ipRanges(List).

Parameters:

ipRanges - a consumer that will call methods on IpRange.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#ipRanges(java.util.Collection)

ipv6Ranges

IpPermission.Builder ipv6Ranges(Collection<Ipv6Range> ipv6Ranges)

The IPv6 address ranges.

Parameters:

ipv6Ranges - The IPv6 address ranges.

Returns:

Returns a reference to this object so that method calls can be chained together.

ipv6Ranges

IpPermission.Builder ipv6Ranges(Ipv6Range... ipv6Ranges)

The IPv6 address ranges.

Parameters:

ipv6Ranges - The IPv6 address ranges.

Returns:

Returns a reference to this object so that method calls can be chained together.

ipv6Ranges

IpPermission.Builder ipv6Ranges(Consumer<Ipv6Range.Builder>... ipv6Ranges)

The IPv6 address ranges.

This is a convenience method that creates an instance of the Ipv6Range.Builder avoiding the need to create one manually via Ipv6Range.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #ipv6Ranges(List).

Parameters:

ipv6Ranges - a consumer that will call methods on Ipv6Range.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#ipv6Ranges(java.util.Collection)

prefixListIds

IpPermission.Builder prefixListIds(Collection<PrefixListId> prefixListIds)

The prefix list IDs.

Parameters:

prefixListIds - The prefix list IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

prefixListIds

IpPermission.Builder prefixListIds(PrefixListId... prefixListIds)

The prefix list IDs.

Parameters:

prefixListIds - The prefix list IDs.

Returns:

Returns a reference to this object so that method calls can be chained together.

prefixListIds

IpPermission.Builder prefixListIds(Consumer<PrefixListId.Builder>... prefixListIds)

The prefix list IDs.

This is a convenience method that creates an instance of the PrefixListId.Builder avoiding the need to create one manually via PrefixListId.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #prefixListIds(List).

Parameters:

prefixListIds - a consumer that will call methods on PrefixListId.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#prefixListIds(java.util.Collection)