SecurityGroupRuleRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.SecurityGroupRuleRequest

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SecurityGroupRuleRequest
extends Object
implements Serializable, Cloneable
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SecurityGroupRuleRequest()

Constructors
Constructor and Description
`SecurityGroupRuleRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SecurityGroupRuleRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCidrIpv4()` The IPv4 CIDR range.
`String`	`getCidrIpv6()` The IPv6 CIDR range.
`String`	`getDescription()` The description of the security group rule.
`Integer`	`getFromPort()` The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.
`String`	`getIpProtocol()` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number (see Protocol Numbers).
`String`	`getPrefixListId()` The ID of the prefix list.
`String`	`getReferencedGroupId()` The ID of the security group that is referenced in the security group rule.
`Integer`	`getToPort()` The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
`int`	`hashCode()`
`void`	`setCidrIpv4(String cidrIpv4)` The IPv4 CIDR range.
`void`	`setCidrIpv6(String cidrIpv6)` The IPv6 CIDR range.
`void`	`setDescription(String description)` The description of the security group rule.
`void`	`setFromPort(Integer fromPort)` The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.
`void`	`setIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number (see Protocol Numbers).
`void`	`setPrefixListId(String prefixListId)` The ID of the prefix list.
`void`	`setReferencedGroupId(String referencedGroupId)` The ID of the security group that is referenced in the security group rule.
`void`	`setToPort(Integer toPort)` The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.
`String`	`toString()` Returns a string representation of this object.
`SecurityGroupRuleRequest`	`withCidrIpv4(String cidrIpv4)` The IPv4 CIDR range.
`SecurityGroupRuleRequest`	`withCidrIpv6(String cidrIpv6)` The IPv6 CIDR range.
`SecurityGroupRuleRequest`	`withDescription(String description)` The description of the security group rule.
`SecurityGroupRuleRequest`	`withFromPort(Integer fromPort)` The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type.
`SecurityGroupRuleRequest`	`withIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number (see Protocol Numbers).
`SecurityGroupRuleRequest`	`withPrefixListId(String prefixListId)` The ID of the prefix list.
`SecurityGroupRuleRequest`	`withReferencedGroupId(String referencedGroupId)` The ID of the security group that is referenced in the security group rule.
`SecurityGroupRuleRequest`	`withToPort(Integer toPort)` The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code.

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

- Constructor Detail
  - SecurityGroupRuleRequest
```
public SecurityGroupRuleRequest()
```
- Method Detail
  - setIpProtocol
```
public void setIpProtocol(String ipProtocol)
```
    The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
    
    Use -1 to specify all protocols.
    
    Parameters:
    
    ipProtocol - The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
    
    Use -1 to specify all protocols.
  - getIpProtocol
```
public String getIpProtocol()
```
    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.
  - withIpProtocol
```
public SecurityGroupRuleRequest withIpProtocol(String ipProtocol)
```
    The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
    
    Use -1 to specify all protocols.
    
    Parameters:
    
    ipProtocol - The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
    
    Use -1 to specify all protocols.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFromPort
```
public void setFromPort(Integer fromPort)
```
    The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. 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 port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. 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 port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. 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 port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
  - withFromPort
```
public SecurityGroupRuleRequest withFromPort(Integer fromPort)
```
    The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. 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 port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type. 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 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 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 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 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 SecurityGroupRuleRequest withToPort(Integer toPort)
```
    The end of 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 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.
  - setCidrIpv4
```
public void setCidrIpv4(String cidrIpv4)
```
    The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
    
    Parameters:
    
    cidrIpv4 - The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
  - getCidrIpv4
```
public String getCidrIpv4()
```
    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.
  - withCidrIpv4
```
public SecurityGroupRuleRequest withCidrIpv4(String cidrIpv4)
```
    The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
    
    Parameters:
    
    cidrIpv4 - The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCidrIpv6
```
public void setCidrIpv6(String cidrIpv6)
```
    The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
    
    Parameters:
    
    cidrIpv6 - The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
  - getCidrIpv6
```
public String getCidrIpv6()
```
    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.
  - withCidrIpv6
```
public SecurityGroupRuleRequest withCidrIpv6(String cidrIpv6)
```
    The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
    
    Parameters:
    
    cidrIpv6 - The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrefixListId
```
public void setPrefixListId(String prefixListId)
```
    The ID of the prefix list.
    
    Parameters:
    
    prefixListId - The ID of the prefix list.
  - getPrefixListId
```
public String getPrefixListId()
```
    The ID of the prefix list.
    
    Returns:
    
    The ID of the prefix list.
  - withPrefixListId
```
public SecurityGroupRuleRequest withPrefixListId(String prefixListId)
```
    The ID of the prefix list.
    
    Parameters:
    
    prefixListId - The ID of the prefix list.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReferencedGroupId
```
public void setReferencedGroupId(String referencedGroupId)
```
    The ID of the security group that is referenced in the security group rule.
    
    Parameters:
    
    referencedGroupId - The ID of the security group that is referenced in the security group rule.
  - getReferencedGroupId
```
public String getReferencedGroupId()
```
    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.
  - withReferencedGroupId
```
public SecurityGroupRuleRequest withReferencedGroupId(String referencedGroupId)
```
    The ID of the security group that is referenced in the security group rule.
    
    Parameters:
    
    referencedGroupId - The ID of the security group that is referenced in the security group rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the security group rule.
    
    Parameters:
    
    description - The description of the security group rule.
  - getDescription
```
public String getDescription()
```
    The description of the security group rule.
    
    Returns:
    
    The description of the security group rule.
  - withDescription
```
public SecurityGroupRuleRequest withDescription(String description)
```
    The description of the security group rule.
    
    Parameters:
    
    description - The description of the security group rule.
    
    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 SecurityGroupRuleRequest clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class SecurityGroupRuleRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SecurityGroupRuleRequest

Method Detail

setIpProtocol

getIpProtocol

withIpProtocol

setFromPort

getFromPort

withFromPort

setToPort

getToPort

withToPort

setCidrIpv4

getCidrIpv4

withCidrIpv4

setCidrIpv6

getCidrIpv6

withCidrIpv6

setPrefixListId

getPrefixListId

withPrefixListId

setReferencedGroupId

getReferencedGroupId

withReferencedGroupId

setDescription

getDescription

withDescription

toString

equals

hashCode

clone