software.amazon.awssdk.services.ec2.model

Interface SecurityGroupRule.Builder

All Superinterfaces:

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

Enclosing class:

SecurityGroupRule

public static interface SecurityGroupRule.Builder
extends SdkPojo, CopyableBuilder<SecurityGroupRule.Builder,SecurityGroupRule>

Method Summary

Modifier and Type	Method and Description
SecurityGroupRule.Builder	cidrIpv4(String cidrIpv4) The IPv4 CIDR range.
SecurityGroupRule.Builder	cidrIpv6(String cidrIpv6) The IPv6 CIDR range.
SecurityGroupRule.Builder	description(String description) The security group rule description.
SecurityGroupRule.Builder	fromPort(Integer fromPort) If the protocol is TCP or UDP, this is the start of the port range.
SecurityGroupRule.Builder	groupId(String groupId) The ID of the security group.
SecurityGroupRule.Builder	groupOwnerId(String groupOwnerId) The ID of the Amazon Web Services account that owns the security group.
SecurityGroupRule.Builder	ipProtocol(String ipProtocol) The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
SecurityGroupRule.Builder	isEgress(Boolean isEgress) Indicates whether the security group rule is an outbound rule.
SecurityGroupRule.Builder	prefixListId(String prefixListId) The ID of the prefix list.
default SecurityGroupRule.Builder	referencedGroupInfo(Consumer<ReferencedSecurityGroup.Builder> referencedGroupInfo) Describes the security group that is referenced in the rule.
SecurityGroupRule.Builder	referencedGroupInfo(ReferencedSecurityGroup referencedGroupInfo) Describes the security group that is referenced in the rule.
SecurityGroupRule.Builder	securityGroupRuleId(String securityGroupRuleId) The ID of the security group rule.
SecurityGroupRule.Builder	tags(Collection<Tag> tags) The tags applied to the security group rule.
SecurityGroupRule.Builder	tags(Consumer<Tag.Builder>... tags) The tags applied to the security group rule.
SecurityGroupRule.Builder	tags(Tag... tags) The tags applied to the security group rule.
SecurityGroupRule.Builder	toPort(Integer toPort) If the protocol is TCP or UDP, this is the end of the port range.

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

equalsBySdkFields, sdkFields

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

securityGroupRuleId

SecurityGroupRule.Builder securityGroupRuleId(String securityGroupRuleId)

The ID of the security group rule.

Parameters:

securityGroupRuleId - The ID of the security group rule.

Returns:

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

groupId

SecurityGroupRule.Builder groupId(String groupId)

The ID of the security group.

Parameters:

groupId - The ID of the security group.

Returns:

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

groupOwnerId

SecurityGroupRule.Builder groupOwnerId(String groupOwnerId)

The ID of the Amazon Web Services account that owns the security group.

Parameters:

groupOwnerId - The ID of the Amazon Web Services account that owns the security group.

Returns:

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

isEgress

SecurityGroupRule.Builder isEgress(Boolean isEgress)

Indicates whether the security group rule is an outbound rule.

Parameters:

isEgress - Indicates whether the security group rule is an outbound rule.

Returns:

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

ipProtocol

SecurityGroupRule.Builder ipProtocol(String ipProtocol)

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

Use -1 to specify all protocols.

Parameters:

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

Use -1 to specify all protocols.

Returns:

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

fromPort

SecurityGroupRule.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 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

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 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

Returns:

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

toPort

SecurityGroupRule.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 type number. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 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 type number. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.

Returns:

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

cidrIpv4

SecurityGroupRule.Builder cidrIpv4(String cidrIpv4)

The IPv4 CIDR range.

Parameters:

cidrIpv4 - The IPv4 CIDR range.

Returns:

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

cidrIpv6

SecurityGroupRule.Builder cidrIpv6(String cidrIpv6)

The IPv6 CIDR range.

Parameters:

cidrIpv6 - The IPv6 CIDR range.

Returns:

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

prefixListId

SecurityGroupRule.Builder prefixListId(String prefixListId)

The ID of the prefix list.

Parameters:

prefixListId - The ID of the prefix list.

Returns:

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

referencedGroupInfo

SecurityGroupRule.Builder referencedGroupInfo(ReferencedSecurityGroup referencedGroupInfo)

Describes the security group that is referenced in the rule.

Parameters:

referencedGroupInfo - Describes the security group that is referenced in the rule.

Returns:

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

referencedGroupInfo

default SecurityGroupRule.Builder referencedGroupInfo(Consumer<ReferencedSecurityGroup.Builder> referencedGroupInfo)

Describes the security group that is referenced in the rule.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to referencedGroupInfo(ReferencedSecurityGroup).

Parameters:

referencedGroupInfo - a consumer that will call methods on ReferencedSecurityGroup.Builder

Returns:

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

See Also:

referencedGroupInfo(ReferencedSecurityGroup)

description

SecurityGroupRule.Builder description(String description)

The security group rule description.

Parameters:

description - The security group rule description.

Returns:

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

tags

SecurityGroupRule.Builder tags(Collection<Tag> tags)

The tags applied to the security group rule.

Parameters:

tags - The tags applied to the security group rule.

Returns:

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

tags

SecurityGroupRule.Builder tags(Tag... tags)

The tags applied to the security group rule.

Parameters:

tags - The tags applied to the security group rule.

Returns:

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

tags

SecurityGroupRule.Builder tags(Consumer<Tag.Builder>... tags)

The tags applied to the security group rule.

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

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

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)