software.amazon.awssdk.services.ec2.model

Class SecurityGroupRuleRequest

java.lang.Object

software.amazon.awssdk.services.ec2.model.SecurityGroupRuleRequest

All Implemented Interfaces:

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

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

Describes a security group rule.

You must specify exactly one of the following parameters, based on the rule type:

• CidrIpv4

• CidrIpv6

• PrefixListId

• ReferencedGroupId

When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 address range.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SecurityGroupRuleRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SecurityGroupRuleRequest.Builder	builder()
String	cidrIpv4() The IPv4 CIDR range.
String	cidrIpv6() The IPv6 CIDR range.
String	description() The description of the security group rule.
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)
int	hashCode()
String	ipProtocol() The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
String	prefixListId() The ID of the prefix list.
String	referencedGroupId() The ID of the security group that is referenced in the security group rule.
List<SdkField<?>>	sdkFields()
static Class<? extends SecurityGroupRuleRequest.Builder>	serializableBuilderClass()
SecurityGroupRuleRequest.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

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 code. 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 code. 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. To specify a single IPv4 address, use the /32 prefix length.

Returns:

The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.

cidrIpv6

public final String cidrIpv6()

The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.

Returns:

The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.

prefixListId

public final String prefixListId()

The ID of the prefix list.

Returns:

The ID of the prefix list.

referencedGroupId

public final String referencedGroupId()

The ID of the security group that is referenced in the security group rule.

Returns:

The ID of the security group that is referenced in the security group rule.

description

public final String description()

The description of the security group rule.

Returns:

The description of the security group rule.

toBuilder

public SecurityGroupRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SecurityGroupRuleRequest.Builder,SecurityGroupRuleRequest>

builder

public static SecurityGroupRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SecurityGroupRuleRequest.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