software.amazon.awssdk.services.ec2.model

Interface IpPermission.Builder

All Superinterfaces:

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

Enclosing class:

IpPermission

public static interface IpPermission.Builder
extends CopyableBuilder<IpPermission.Builder,IpPermission>

Method Summary

Modifier and Type	Method and Description
IpPermission.Builder	fromPort(Integer fromPort) The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
IpPermission.Builder	ipProtocol(String ipProtocol) The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
IpPermission.Builder	ipv4Ranges(Collection<IpRange> ipv4Ranges) One or more IPv4 ranges.
IpPermission.Builder	ipv4Ranges(Consumer<IpRange.Builder>... ipv4Ranges) One or more IPv4 ranges.
IpPermission.Builder	ipv4Ranges(IpRange... ipv4Ranges) One or more IPv4 ranges.
IpPermission.Builder	ipv6Ranges(Collection<Ipv6Range> ipv6Ranges) [EC2-VPC only] One or more IPv6 ranges.
IpPermission.Builder	ipv6Ranges(Consumer<Ipv6Range.Builder>... ipv6Ranges) [EC2-VPC only] One or more IPv6 ranges.
IpPermission.Builder	ipv6Ranges(Ipv6Range... ipv6Ranges) [EC2-VPC only] One or more IPv6 ranges.
IpPermission.Builder	prefixListIds(Collection<PrefixListId> prefixListIds) (Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service.
IpPermission.Builder	prefixListIds(Consumer<PrefixListId.Builder>... prefixListIds) (Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service.
IpPermission.Builder	prefixListIds(PrefixListId... prefixListIds) (Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service.
IpPermission.Builder	toPort(Integer toPort) The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
IpPermission.Builder	userIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs) One or more security group and AWS account ID pairs.
IpPermission.Builder	userIdGroupPairs(Consumer<UserIdGroupPair.Builder>... userIdGroupPairs) One or more security group and AWS account ID pairs.
IpPermission.Builder	userIdGroupPairs(UserIdGroupPair... userIdGroupPairs) One or more security group and AWS 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

Method Detail

fromPort

IpPermission.Builder fromPort(Integer fromPort)

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

Parameters:

fromPort - The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

Returns:

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

ipProtocol

IpPermission.Builder ipProtocol(String ipProtocol)

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

[EC2-VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or 58 (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 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed when authorizing rules.

Parameters:

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

[EC2-VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or 58 (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 58 (ICMPv6), you can optionally specify a port range; if you don't, traffic for all types and codes is allowed when authorizing rules.

Returns:

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

ipv6Ranges

IpPermission.Builder ipv6Ranges(Collection<Ipv6Range> ipv6Ranges)

[EC2-VPC only] One or more IPv6 ranges.

Parameters:

ipv6Ranges - [EC2-VPC only] One or more IPv6 ranges.

Returns:

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

ipv6Ranges

IpPermission.Builder ipv6Ranges(Ipv6Range... ipv6Ranges)

[EC2-VPC only] One or more IPv6 ranges.

Parameters:

ipv6Ranges - [EC2-VPC only] One or more IPv6 ranges.

Returns:

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

ipv6Ranges

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

[EC2-VPC only] One or more IPv6 ranges.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #ipv6Ranges(List).

Parameters:

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

Returns:

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

See Also:

#ipv6Ranges(List)

prefixListIds

IpPermission.Builder prefixListIds(Collection<PrefixListId> prefixListIds)

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

Parameters:

prefixListIds - (Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

Returns:

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

prefixListIds

IpPermission.Builder prefixListIds(PrefixListId... prefixListIds)

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

Parameters:

prefixListIds - (Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

Returns:

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

prefixListIds

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

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #prefixListIds(List).

Parameters:

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

Returns:

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

See Also:

#prefixListIds(List)

toPort

IpPermission.Builder toPort(Integer toPort)

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.

Parameters:

toPort - The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes for the specified ICMP type. If you specify all ICMP/ICMPv6 types, you must specify all codes.

Returns:

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

userIdGroupPairs

IpPermission.Builder userIdGroupPairs(Collection<UserIdGroupPair> userIdGroupPairs)

One or more security group and AWS account ID pairs.

Parameters:

userIdGroupPairs - One or more security group and AWS account ID pairs.

Returns:

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

userIdGroupPairs

IpPermission.Builder userIdGroupPairs(UserIdGroupPair... userIdGroupPairs)

One or more security group and AWS account ID pairs.

Parameters:

userIdGroupPairs - One or more security group and AWS 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)

One or more security group and AWS account ID pairs.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #userIdGroupPairs(List).

Parameters:

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

Returns:

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

See Also:

#userIdGroupPairs(List)

ipv4Ranges

IpPermission.Builder ipv4Ranges(Collection<IpRange> ipv4Ranges)

One or more IPv4 ranges.

Parameters:

ipv4Ranges - One or more IPv4 ranges.

Returns:

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

ipv4Ranges

IpPermission.Builder ipv4Ranges(IpRange... ipv4Ranges)

One or more IPv4 ranges.

Parameters:

ipv4Ranges - One or more IPv4 ranges.

Returns:

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

ipv4Ranges

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

One or more IPv4 ranges.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #ipv4Ranges(List).

Parameters:

ipv4Ranges - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#ipv4Ranges(List)