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

Class SecurityGroupRule

java.lang.Object

software.amazon.awssdk.services.ec2.model.SecurityGroupRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SecurityGroupRule.Builder,SecurityGroupRule>

@Generated("software.amazon.awssdk:codegen")
public final class SecurityGroupRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SecurityGroupRule.Builder,SecurityGroupRule>

Describes a security group rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SecurityGroupRule.Builder

Method Summary

Modifier and Type	Method	Description
static SecurityGroupRule.Builder	builder()
String	cidrIpv4()	The IPv4 CIDR range.
String	cidrIpv6()	The IPv6 CIDR range.
String	description()	The security group rule description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	fromPort()	If the protocol is TCP or UDP, this is the start of the port range.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupId()	The ID of the security group.
String	groupOwnerId()	The ID of the Amazon Web Services account that owns the security group.
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	ipProtocol()	The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Boolean	isEgress()	Indicates whether the security group rule is an outbound rule.
String	prefixListId()	The ID of the prefix list.
ReferencedSecurityGroup	referencedGroupInfo()	Describes the security group that is referenced in the rule.
List<SdkField<?>>	sdkFields()
String	securityGroupRuleId()	The ID of the security group rule.
static Class<? extends SecurityGroupRule.Builder>	serializableBuilderClass()
List<Tag>	tags()	The tags applied to the security group rule.
SecurityGroupRule.Builder	toBuilder()
Integer	toPort()	If the protocol is TCP or UDP, this is the end of the port range.
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

securityGroupRuleId

public final String securityGroupRuleId()

The ID of the security group rule.

Returns:

The ID of the security group rule.

groupId

public final String groupId()

The ID of the security group.

Returns:

The ID of the security group.

groupOwnerId

public final String groupOwnerId()

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

Returns:

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

isEgress

public final Boolean isEgress()

Indicates whether the security group rule is an outbound rule.

Returns:

Indicates whether the security group rule is an outbound rule.

ipProtocol

public final String ipProtocol()

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

Use -1 to specify all protocols.

Returns:

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

Use -1 to specify all protocols.

fromPort

public final 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.

Returns:

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.

toPort

public final 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.

Returns:

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.

cidrIpv4

public final String cidrIpv4()

The IPv4 CIDR range.

Returns:

The IPv4 CIDR range.

cidrIpv6

public final String cidrIpv6()

The IPv6 CIDR range.

Returns:

The IPv6 CIDR range.

prefixListId

public final String prefixListId()

The ID of the prefix list.

Returns:

The ID of the prefix list.

referencedGroupInfo

public final ReferencedSecurityGroup referencedGroupInfo()

Describes the security group that is referenced in the rule.

Returns:

Describes the security group that is referenced in the rule.

description

public final String description()

The security group rule description.

Returns:

The security group rule description.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

The tags applied to the security group rule.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The tags applied to the security group rule.

toBuilder

public SecurityGroupRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SecurityGroupRule.Builder,SecurityGroupRule>

builder

public static SecurityGroupRule.Builder builder()

serializableBuilderClass

public static Class<? extends SecurityGroupRule.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo