AwsEc2SecurityGroupIpPermission (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsEc2SecurityGroupIpPermission

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsEc2SecurityGroupIpPermission
extends Object
implements Serializable, Cloneable, StructuredPojo

An IP permission for an EC2 security group.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsEc2SecurityGroupIpPermission()

Constructors
Constructor and Description
`AwsEc2SecurityGroupIpPermission()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsEc2SecurityGroupIpPermission`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getFromPort()` The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
`String`	`getIpProtocol()` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number.
`List<AwsEc2SecurityGroupIpRange>`	`getIpRanges()` The IPv4 ranges.
`List<AwsEc2SecurityGroupIpv6Range>`	`getIpv6Ranges()` The IPv6 ranges.
`List<AwsEc2SecurityGroupPrefixListId>`	`getPrefixListIds()` [VPC only] The prefix list IDs for an Amazon Web Services service.
`Integer`	`getToPort()` The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
`List<AwsEc2SecurityGroupUserIdGroupPair>`	`getUserIdGroupPairs()` The security group and Amazon Web Services account ID pairs.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFromPort(Integer fromPort)` The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
`void`	`setIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number.
`void`	`setIpRanges(Collection<AwsEc2SecurityGroupIpRange> ipRanges)` The IPv4 ranges.
`void`	`setIpv6Ranges(Collection<AwsEc2SecurityGroupIpv6Range> ipv6Ranges)` The IPv6 ranges.
`void`	`setPrefixListIds(Collection<AwsEc2SecurityGroupPrefixListId> prefixListIds)` [VPC only] The prefix list IDs for an Amazon Web Services service.
`void`	`setToPort(Integer toPort)` The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
`void`	`setUserIdGroupPairs(Collection<AwsEc2SecurityGroupUserIdGroupPair> userIdGroupPairs)` The security group and Amazon Web Services account ID pairs.
`String`	`toString()` Returns a string representation of this object.
`AwsEc2SecurityGroupIpPermission`	`withFromPort(Integer fromPort)` The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
`AwsEc2SecurityGroupIpPermission`	`withIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number.
`AwsEc2SecurityGroupIpPermission`	`withIpRanges(AwsEc2SecurityGroupIpRange... ipRanges)` The IPv4 ranges.
`AwsEc2SecurityGroupIpPermission`	`withIpRanges(Collection<AwsEc2SecurityGroupIpRange> ipRanges)` The IPv4 ranges.
`AwsEc2SecurityGroupIpPermission`	`withIpv6Ranges(AwsEc2SecurityGroupIpv6Range... ipv6Ranges)` The IPv6 ranges.
`AwsEc2SecurityGroupIpPermission`	`withIpv6Ranges(Collection<AwsEc2SecurityGroupIpv6Range> ipv6Ranges)` The IPv6 ranges.
`AwsEc2SecurityGroupIpPermission`	`withPrefixListIds(AwsEc2SecurityGroupPrefixListId... prefixListIds)` [VPC only] The prefix list IDs for an Amazon Web Services service.
`AwsEc2SecurityGroupIpPermission`	`withPrefixListIds(Collection<AwsEc2SecurityGroupPrefixListId> prefixListIds)` [VPC only] The prefix list IDs for an Amazon Web Services service.
`AwsEc2SecurityGroupIpPermission`	`withToPort(Integer toPort)` The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
`AwsEc2SecurityGroupIpPermission`	`withUserIdGroupPairs(AwsEc2SecurityGroupUserIdGroupPair... userIdGroupPairs)` The security group and Amazon Web Services account ID pairs.
`AwsEc2SecurityGroupIpPermission`	`withUserIdGroupPairs(Collection<AwsEc2SecurityGroupUserIdGroupPair> userIdGroupPairs)` The security group and Amazon Web Services account ID pairs.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AwsEc2SecurityGroupIpPermission
```
public AwsEc2SecurityGroupIpPermission()
```
- Method Detail
  - setIpProtocol
```
public void setIpProtocol(String ipProtocol)
```
    The IP protocol name (tcp, udp, icmp, icmpv6) or number.
    
    [VPC only] Use -1 to specify all protocols.
    
    When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.
    
    For tcp, udp, and icmp, you must specify a port range.
    
    For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.
    
    Parameters:
    
    ipProtocol - The IP protocol name (tcp, udp, icmp, icmpv6) or number.
    
    [VPC only] Use -1 to specify all protocols.
    
    When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.
    
    For tcp, udp, and icmp, you must specify a port range.
    
    For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.
  - getIpProtocol
```
public String getIpProtocol()
```
    The IP protocol name (tcp, udp, icmp, icmpv6) or number.
    
    [VPC only] Use -1 to specify all protocols.
    
    When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.
    
    For tcp, udp, and icmp, you must specify a port range.
    
    For icmpv6, 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.
    
    [VPC only] Use -1 to specify all protocols.
    
    When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.
    
    For tcp, udp, and icmp, you must specify a port range.
    
    For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.
  - withIpProtocol
```
public AwsEc2SecurityGroupIpPermission withIpProtocol(String ipProtocol)
```
    The IP protocol name (tcp, udp, icmp, icmpv6) or number.
    
    [VPC only] Use -1 to specify all protocols.
    
    When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.
    
    For tcp, udp, and icmp, you must specify a port range.
    
    For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.
    
    Parameters:
    
    ipProtocol - The IP protocol name (tcp, udp, icmp, icmpv6) or number.
    
    [VPC only] Use -1 to specify all protocols.
    
    When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify.
    
    For tcp, udp, and icmp, you must specify a port range.
    
    For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFromPort
```
public void setFromPort(Integer fromPort)
```
    The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
    
    A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Parameters:
    
    fromPort - The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
    
    A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
  - getFromPort
```
public Integer getFromPort()
```
    The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
    
    A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Returns:
    
    The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
    
    A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
  - withFromPort
```
public AwsEc2SecurityGroupIpPermission withFromPort(Integer fromPort)
```
    The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
    
    A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Parameters:
    
    fromPort - The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number.
    
    A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setToPort
```
public void setToPort(Integer toPort)
```
    The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    
    A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Parameters:
    
    toPort - The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    
    A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
  - getToPort
```
public Integer getToPort()
```
    The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    
    A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Returns:
    
    The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    
    A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
  - withToPort
```
public AwsEc2SecurityGroupIpPermission withToPort(Integer toPort)
```
    The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    
    A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Parameters:
    
    toPort - The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
    
    A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getUserIdGroupPairs
```
public List<AwsEc2SecurityGroupUserIdGroupPair> getUserIdGroupPairs()
```
    The security group and Amazon Web Services account ID pairs.
    
    Returns:
    
    The security group and Amazon Web Services account ID pairs.
  - setUserIdGroupPairs
```
public void setUserIdGroupPairs(Collection<AwsEc2SecurityGroupUserIdGroupPair> userIdGroupPairs)
```
    The security group and Amazon Web Services account ID pairs.
    
    Parameters:
    
    userIdGroupPairs - The security group and Amazon Web Services account ID pairs.
  - withUserIdGroupPairs
```
public AwsEc2SecurityGroupIpPermission withUserIdGroupPairs(AwsEc2SecurityGroupUserIdGroupPair... userIdGroupPairs)
```
    The security group and Amazon Web Services account ID pairs.
    
    NOTE: This method appends the values to the existing list (if any). Use setUserIdGroupPairs(java.util.Collection) or withUserIdGroupPairs(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    userIdGroupPairs - The security group and Amazon Web Services account ID pairs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUserIdGroupPairs
```
public AwsEc2SecurityGroupIpPermission withUserIdGroupPairs(Collection<AwsEc2SecurityGroupUserIdGroupPair> userIdGroupPairs)
```
    The security group and Amazon Web Services account ID pairs.
    
    Parameters:
    
    userIdGroupPairs - The security group and Amazon Web Services account ID pairs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIpRanges
```
public List<AwsEc2SecurityGroupIpRange> getIpRanges()
```
    The IPv4 ranges.
    
    Returns:
    
    The IPv4 ranges.
  - setIpRanges
```
public void setIpRanges(Collection<AwsEc2SecurityGroupIpRange> ipRanges)
```
    The IPv4 ranges.
    
    Parameters:
    
    ipRanges - The IPv4 ranges.
  - withIpRanges
```
public AwsEc2SecurityGroupIpPermission withIpRanges(AwsEc2SecurityGroupIpRange... ipRanges)
```
    The IPv4 ranges.
    
    NOTE: This method appends the values to the existing list (if any). Use setIpRanges(java.util.Collection) or withIpRanges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ipRanges - The IPv4 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIpRanges
```
public AwsEc2SecurityGroupIpPermission withIpRanges(Collection<AwsEc2SecurityGroupIpRange> ipRanges)
```
    The IPv4 ranges.
    
    Parameters:
    
    ipRanges - The IPv4 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIpv6Ranges
```
public List<AwsEc2SecurityGroupIpv6Range> getIpv6Ranges()
```
    The IPv6 ranges.
    
    Returns:
    
    The IPv6 ranges.
  - setIpv6Ranges
```
public void setIpv6Ranges(Collection<AwsEc2SecurityGroupIpv6Range> ipv6Ranges)
```
    The IPv6 ranges.
    
    Parameters:
    
    ipv6Ranges - The IPv6 ranges.
  - withIpv6Ranges
```
public AwsEc2SecurityGroupIpPermission withIpv6Ranges(AwsEc2SecurityGroupIpv6Range... ipv6Ranges)
```
    The IPv6 ranges.
    
    NOTE: This method appends the values to the existing list (if any). Use setIpv6Ranges(java.util.Collection) or withIpv6Ranges(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ipv6Ranges - The IPv6 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIpv6Ranges
```
public AwsEc2SecurityGroupIpPermission withIpv6Ranges(Collection<AwsEc2SecurityGroupIpv6Range> ipv6Ranges)
```
    The IPv6 ranges.
    
    Parameters:
    
    ipv6Ranges - The IPv6 ranges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getPrefixListIds
```
public List<AwsEc2SecurityGroupPrefixListId> getPrefixListIds()
```
    [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.
    
    Returns:
    
    [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.
  - setPrefixListIds
```
public void setPrefixListIds(Collection<AwsEc2SecurityGroupPrefixListId> prefixListIds)
```
    [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.
    
    Parameters:
    
    prefixListIds - [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.
  - withPrefixListIds
```
public AwsEc2SecurityGroupIpPermission withPrefixListIds(AwsEc2SecurityGroupPrefixListId... prefixListIds)
```
    [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.
    
    NOTE: This method appends the values to the existing list (if any). Use setPrefixListIds(java.util.Collection) or withPrefixListIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    prefixListIds - [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withPrefixListIds
```
public AwsEc2SecurityGroupIpPermission withPrefixListIds(Collection<AwsEc2SecurityGroupPrefixListId> prefixListIds)
```
    [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.
    
    Parameters:
    
    prefixListIds - [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AwsEc2SecurityGroupIpPermission clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class AwsEc2SecurityGroupIpPermission

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsEc2SecurityGroupIpPermission

Method Detail

setIpProtocol

getIpProtocol

withIpProtocol

setFromPort

getFromPort

withFromPort

setToPort

getToPort

withToPort

getUserIdGroupPairs

setUserIdGroupPairs

withUserIdGroupPairs

withUserIdGroupPairs

getIpRanges

setIpRanges

withIpRanges

withIpRanges

getIpv6Ranges

setIpv6Ranges

withIpv6Ranges

withIpv6Ranges

getPrefixListIds

setPrefixListIds

withPrefixListIds

withPrefixListIds

toString

equals

hashCode

clone

marshall