Class IpPermission
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IpPermission.Builder,
IpPermission>
Describes the permissions for a security group rule.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic IpPermission.Builder
builder()
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 boolean
For responses, this returns true if the service returned a value for the IpRanges property.final boolean
For responses, this returns true if the service returned a value for the Ipv6Ranges property.final boolean
For responses, this returns true if the service returned a value for the PrefixListIds property.final boolean
For responses, this returns true if the service returned a value for the UserIdGroupPairs property.final String
ipRanges()
The IPv4 address ranges.The IPv6 address ranges.final List
<PrefixListId> The prefix list IDs.static Class
<? extends IpPermission.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.final List
<UserIdGroupPair> The security group and Amazon Web Services account ID pairs.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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).
-
ipProtocol
The IP protocol name (
tcp
,udp
,icmp
,icmpv6
) or number (see Protocol Numbers).Use
-1
to specify all protocols. When authorizing security group rules, specifying-1
or a protocol number other thantcp
,udp
,icmp
, oricmpv6
allows traffic on all ports, regardless of any port range you specify. Fortcp
,udp
, andicmp
, you must specify a port range. Foricmpv6
, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.- Returns:
- The IP protocol name (
tcp
,udp
,icmp
,icmpv6
) or number (see Protocol Numbers).Use
-1
to specify all protocols. When authorizing security group rules, specifying-1
or a protocol number other thantcp
,udp
,icmp
, oricmpv6
allows traffic on all ports, regardless of any port range you specify. Fortcp
,udp
, andicmp
, you must specify a port range. Foricmpv6
, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
-
hasIpRanges
public final boolean hasIpRanges()For responses, this returns true if the service returned a value for the IpRanges property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
ipRanges
The IPv4 address ranges.
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
hasIpRanges()
method.- Returns:
- The IPv4 address ranges.
-
hasIpv6Ranges
public final boolean hasIpv6Ranges()For responses, this returns true if the service returned a value for the Ipv6Ranges property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
ipv6Ranges
The IPv6 address ranges.
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
hasIpv6Ranges()
method.- Returns:
- The IPv6 address ranges.
-
hasPrefixListIds
public final boolean hasPrefixListIds()For responses, this returns true if the service returned a value for the PrefixListIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
prefixListIds
The prefix list IDs.
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
hasPrefixListIds()
method.- Returns:
- The prefix list IDs.
-
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).
-
hasUserIdGroupPairs
public final boolean hasUserIdGroupPairs()For responses, this returns true if the service returned a value for the UserIdGroupPairs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
userIdGroupPairs
The security group and Amazon Web Services account ID pairs.
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
hasUserIdGroupPairs()
method.- Returns:
- The security group and Amazon Web Services account ID pairs.
-
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<IpPermission.Builder,
IpPermission> - 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
-