SecurityGroupRule (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

Describes a security group rule.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SecurityGroupRule()

Constructors
Constructor and Description
`SecurityGroupRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SecurityGroupRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCidrIpv4()` The IPv4 CIDR range.
`String`	`getCidrIpv6()` The IPv6 CIDR range.
`String`	`getDescription()` The security group rule description.
`Integer`	`getFromPort()` If the protocol is TCP or UDP, this is the start of the port range.
`String`	`getGroupId()` The ID of the security group.
`String`	`getGroupOwnerId()` The ID of the Amazon Web Services account that owns the security group.
`String`	`getIpProtocol()` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number (see Protocol Numbers).
`Boolean`	`getIsEgress()` Indicates whether the security group rule is an outbound rule.
`String`	`getPrefixListId()` The ID of the prefix list.
`ReferencedSecurityGroup`	`getReferencedGroupInfo()` Describes the security group that is referenced in the rule.
`String`	`getSecurityGroupRuleId()` The ID of the security group rule.
`List<Tag>`	`getTags()` The tags applied to the security group rule.
`Integer`	`getToPort()` If the protocol is TCP or UDP, this is the end of the port range.
`int`	`hashCode()`
`Boolean`	`isEgress()` Indicates whether the security group rule is an outbound rule.
`void`	`setCidrIpv4(String cidrIpv4)` The IPv4 CIDR range.
`void`	`setCidrIpv6(String cidrIpv6)` The IPv6 CIDR range.
`void`	`setDescription(String description)` The security group rule description.
`void`	`setFromPort(Integer fromPort)` If the protocol is TCP or UDP, this is the start of the port range.
`void`	`setGroupId(String groupId)` The ID of the security group.
`void`	`setGroupOwnerId(String groupOwnerId)` The ID of the Amazon Web Services account that owns the security group.
`void`	`setIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number (see Protocol Numbers).
`void`	`setIsEgress(Boolean isEgress)` Indicates whether the security group rule is an outbound rule.
`void`	`setPrefixListId(String prefixListId)` The ID of the prefix list.
`void`	`setReferencedGroupInfo(ReferencedSecurityGroup referencedGroupInfo)` Describes the security group that is referenced in the rule.
`void`	`setSecurityGroupRuleId(String securityGroupRuleId)` The ID of the security group rule.
`void`	`setTags(Collection<Tag> tags)` The tags applied to the security group rule.
`void`	`setToPort(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.
`SecurityGroupRule`	`withCidrIpv4(String cidrIpv4)` The IPv4 CIDR range.
`SecurityGroupRule`	`withCidrIpv6(String cidrIpv6)` The IPv6 CIDR range.
`SecurityGroupRule`	`withDescription(String description)` The security group rule description.
`SecurityGroupRule`	`withFromPort(Integer fromPort)` If the protocol is TCP or UDP, this is the start of the port range.
`SecurityGroupRule`	`withGroupId(String groupId)` The ID of the security group.
`SecurityGroupRule`	`withGroupOwnerId(String groupOwnerId)` The ID of the Amazon Web Services account that owns the security group.
`SecurityGroupRule`	`withIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number (see Protocol Numbers).
`SecurityGroupRule`	`withIsEgress(Boolean isEgress)` Indicates whether the security group rule is an outbound rule.
`SecurityGroupRule`	`withPrefixListId(String prefixListId)` The ID of the prefix list.
`SecurityGroupRule`	`withReferencedGroupInfo(ReferencedSecurityGroup referencedGroupInfo)` Describes the security group that is referenced in the rule.
`SecurityGroupRule`	`withSecurityGroupRuleId(String securityGroupRuleId)` The ID of the security group rule.
`SecurityGroupRule`	`withTags(Collection<Tag> tags)` The tags applied to the security group rule.
`SecurityGroupRule`	`withTags(Tag... tags)` The tags applied to the security group rule.
`SecurityGroupRule`	`withToPort(Integer toPort)` If the protocol is TCP or UDP, this is the end of the port range.

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

- Constructor Detail
  - SecurityGroupRule
```
public SecurityGroupRule()
```
- Method Detail
  - setSecurityGroupRuleId
```
public void setSecurityGroupRuleId(String securityGroupRuleId)
```
    The ID of the security group rule.
    
    Parameters:
    
    securityGroupRuleId - The ID of the security group rule.
  - getSecurityGroupRuleId
```
public String getSecurityGroupRuleId()
```
    The ID of the security group rule.
    
    Returns:
    
    The ID of the security group rule.
  - withSecurityGroupRuleId
```
public SecurityGroupRule withSecurityGroupRuleId(String securityGroupRuleId)
```
    The ID of the security group rule.
    
    Parameters:
    
    securityGroupRuleId - The ID of the security group rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGroupId
```
public void setGroupId(String groupId)
```
    The ID of the security group.
    
    Parameters:
    
    groupId - The ID of the security group.
  - getGroupId
```
public String getGroupId()
```
    The ID of the security group.
    
    Returns:
    
    The ID of the security group.
  - withGroupId
```
public SecurityGroupRule withGroupId(String groupId)
```
    The ID of the security group.
    
    Parameters:
    
    groupId - The ID of the security group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGroupOwnerId
```
public void setGroupOwnerId(String groupOwnerId)
```
    The ID of the Amazon Web Services account that owns the security group.
    
    Parameters:
    
    groupOwnerId - The ID of the Amazon Web Services account that owns the security group.
  - getGroupOwnerId
```
public String getGroupOwnerId()
```
    The ID of the Amazon Web Services account that owns the security group.
    
    Returns:
    
    The ID of the Amazon Web Services account that owns the security group.
  - withGroupOwnerId
```
public SecurityGroupRule withGroupOwnerId(String groupOwnerId)
```
    The ID of the Amazon Web Services account that owns the security group.
    
    Parameters:
    
    groupOwnerId - The ID of the Amazon Web Services account that owns the security group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsEgress
```
public void setIsEgress(Boolean isEgress)
```
    Indicates whether the security group rule is an outbound rule.
    
    Parameters:
    
    isEgress - Indicates whether the security group rule is an outbound rule.
  - getIsEgress
```
public Boolean getIsEgress()
```
    Indicates whether the security group rule is an outbound rule.
    
    Returns:
    
    Indicates whether the security group rule is an outbound rule.
  - withIsEgress
```
public SecurityGroupRule withIsEgress(Boolean isEgress)
```
    Indicates whether the security group rule is an outbound rule.
    
    Parameters:
    
    isEgress - Indicates whether the security group rule is an outbound rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEgress
```
public Boolean isEgress()
```
    Indicates whether the security group rule is an outbound rule.
    
    Returns:
    
    Indicates whether the security group rule is an outbound rule.
  - 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 SecurityGroupRule 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)
```
    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).
    
    Parameters:
    
    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).
  - getFromPort
```
public Integer getFromPort()
```
    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).
  - withFromPort
```
public SecurityGroupRule withFromPort(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 ICMP type or -1 (all ICMP types).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setToPort
```
public void setToPort(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 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).
    
    Parameters:
    
    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).
  - getToPort
```
public Integer getToPort()
```
    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).
  - withToPort
```
public SecurityGroupRule withToPort(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 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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCidrIpv4
```
public void setCidrIpv4(String cidrIpv4)
```
    The IPv4 CIDR range.
    
    Parameters:
    
    cidrIpv4 - The IPv4 CIDR range.
  - getCidrIpv4
```
public String getCidrIpv4()
```
    The IPv4 CIDR range.
    
    Returns:
    
    The IPv4 CIDR range.
  - withCidrIpv4
```
public SecurityGroupRule withCidrIpv4(String cidrIpv4)
```
    The IPv4 CIDR range.
    
    Parameters:
    
    cidrIpv4 - The IPv4 CIDR range.
    
    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.
    
    Parameters:
    
    cidrIpv6 - The IPv6 CIDR range.
  - getCidrIpv6
```
public String getCidrIpv6()
```
    The IPv6 CIDR range.
    
    Returns:
    
    The IPv6 CIDR range.
  - withCidrIpv6
```
public SecurityGroupRule withCidrIpv6(String cidrIpv6)
```
    The IPv6 CIDR range.
    
    Parameters:
    
    cidrIpv6 - The IPv6 CIDR range.
    
    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 SecurityGroupRule 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.
  - setReferencedGroupInfo
```
public void setReferencedGroupInfo(ReferencedSecurityGroup referencedGroupInfo)
```
    Describes the security group that is referenced in the rule.
    
    Parameters:
    
    referencedGroupInfo - Describes the security group that is referenced in the rule.
  - getReferencedGroupInfo
```
public ReferencedSecurityGroup getReferencedGroupInfo()
```
    Describes the security group that is referenced in the rule.
    
    Returns:
    
    Describes the security group that is referenced in the rule.
  - withReferencedGroupInfo
```
public SecurityGroupRule withReferencedGroupInfo(ReferencedSecurityGroup referencedGroupInfo)
```
    Describes the security group that is referenced in the rule.
    
    Parameters:
    
    referencedGroupInfo - Describes the security group that is referenced in the rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The security group rule description.
    
    Parameters:
    
    description - The security group rule description.
  - getDescription
```
public String getDescription()
```
    The security group rule description.
    
    Returns:
    
    The security group rule description.
  - withDescription
```
public SecurityGroupRule withDescription(String description)
```
    The security group rule description.
    
    Parameters:
    
    description - The security group rule description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The tags applied to the security group rule.
    
    Returns:
    
    The tags applied to the security group rule.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tags applied to the security group rule.
    
    Parameters:
    
    tags - The tags applied to the security group rule.
  - withTags
```
public SecurityGroupRule withTags(Tag... tags)
```
    The tags applied to the security group rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tags applied to the security group rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public SecurityGroupRule withTags(Collection<Tag> tags)
```
    The tags applied to the security group rule.
    
    Parameters:
    
    tags - The tags applied to 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 SecurityGroupRule clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class SecurityGroupRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SecurityGroupRule

Method Detail

setSecurityGroupRuleId

getSecurityGroupRuleId

withSecurityGroupRuleId

setGroupId

getGroupId

withGroupId

setGroupOwnerId

getGroupOwnerId

withGroupOwnerId

setIsEgress

getIsEgress

withIsEgress

isEgress

setIpProtocol

getIpProtocol

withIpProtocol

setFromPort

getFromPort

withFromPort

setToPort

getToPort

withToPort

setCidrIpv4

getCidrIpv4

withCidrIpv4

setCidrIpv6

getCidrIpv6

withCidrIpv6

setPrefixListId

getPrefixListId

withPrefixListId

setReferencedGroupInfo

getReferencedGroupInfo

withReferencedGroupInfo

setDescription

getDescription

withDescription

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone