Class SecurityGroupRuleRequest
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
cidrIpv4()
The IPv4 CIDR range.final String
cidrIpv6()
The IPv6 CIDR range.final String
The description of the security group rule.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
fromPort()
If the protocol is TCP or UDP, this is the start of the port range.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
final String
The ID of the prefix list.final String
The ID of the security group that is referenced in the security group rule.static Class
<? extends SecurityGroupRuleRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final Integer
toPort()
If the protocol is TCP or UDP, this is the end of the port range.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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:
- 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).
-
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:
- 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).
-
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
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
The ID of the prefix list.
- Returns:
- The ID of the prefix list.
-
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
The description of the security group rule.
- Returns:
- The description of the security group rule.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<SecurityGroupRuleRequest.Builder,
SecurityGroupRuleRequest> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-