AuthorizeSecurityGroupIngressRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<AuthorizeSecurityGroupIngressRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AuthorizeSecurityGroupIngressRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<AuthorizeSecurityGroupIngressRequest>

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`AuthorizeSecurityGroupIngressRequest()` Default constructor for AuthorizeSecurityGroupIngressRequest object.
`AuthorizeSecurityGroupIngressRequest(String groupName, List<IpPermission> ipPermissions)` Constructs a new AuthorizeSecurityGroupIngressRequest object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthorizeSecurityGroupIngressRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getCidrIp()` The IPv4 address range, in CIDR format.
`Request<AuthorizeSecurityGroupIngressRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`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`	`getGroupName()` [Default VPC] The name of the security group.
`List<IpPermission>`	`getIpPermissions()` The permissions for the security group rules.
`String`	`getIpProtocol()` The IP protocol name (`tcp`, `udp`, `icmp`) or number (see Protocol Numbers).
`String`	`getSourceSecurityGroupName()` [Default VPC] The name of the source security group.
`String`	`getSourceSecurityGroupOwnerId()` The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
`List<TagSpecification>`	`getTagSpecifications()` 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()`
`void`	`setCidrIp(String cidrIp)` The IPv4 address range, in CIDR format.
`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`	`setGroupName(String groupName)` [Default VPC] The name of the security group.
`void`	`setIpPermissions(Collection<IpPermission> ipPermissions)` The permissions for the security group rules.
`void`	`setIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`) or number (see Protocol Numbers).
`void`	`setSourceSecurityGroupName(String sourceSecurityGroupName)` [Default VPC] The name of the source security group.
`void`	`setSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)` The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
`void`	`setTagSpecifications(Collection<TagSpecification> tagSpecifications)` 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.
`AuthorizeSecurityGroupIngressRequest`	`withCidrIp(String cidrIp)` The IPv4 address range, in CIDR format.
`AuthorizeSecurityGroupIngressRequest`	`withFromPort(Integer fromPort)` If the protocol is TCP or UDP, this is the start of the port range.
`AuthorizeSecurityGroupIngressRequest`	`withGroupId(String groupId)` The ID of the security group.
`AuthorizeSecurityGroupIngressRequest`	`withGroupName(String groupName)` [Default VPC] The name of the security group.
`AuthorizeSecurityGroupIngressRequest`	`withIpPermissions(Collection<IpPermission> ipPermissions)` The permissions for the security group rules.
`AuthorizeSecurityGroupIngressRequest`	`withIpPermissions(IpPermission... ipPermissions)` The permissions for the security group rules.
`AuthorizeSecurityGroupIngressRequest`	`withIpProtocol(String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`) or number (see Protocol Numbers).
`AuthorizeSecurityGroupIngressRequest`	`withSourceSecurityGroupName(String sourceSecurityGroupName)` [Default VPC] The name of the source security group.
`AuthorizeSecurityGroupIngressRequest`	`withSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)` The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
`AuthorizeSecurityGroupIngressRequest`	`withTagSpecifications(Collection<TagSpecification> tagSpecifications)` The tags applied to the security group rule.
`AuthorizeSecurityGroupIngressRequest`	`withTagSpecifications(TagSpecification... tagSpecifications)` The tags applied to the security group rule.
`AuthorizeSecurityGroupIngressRequest`	`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
  - AuthorizeSecurityGroupIngressRequest
```
public AuthorizeSecurityGroupIngressRequest()
```
    Default constructor for AuthorizeSecurityGroupIngressRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.
  - AuthorizeSecurityGroupIngressRequest
```
public AuthorizeSecurityGroupIngressRequest(String groupName,
                                            List<IpPermission> ipPermissions)
```
    Constructs a new AuthorizeSecurityGroupIngressRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    
    groupName - [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.
    
    ipPermissions - The permissions for the security group rules.
- Method Detail
  - setCidrIp
```
public void setCidrIp(String cidrIp)
```
    The IPv4 address range, in CIDR format.
    
    To specify an IPv6 address range, use IP permissions instead.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Parameters:
    
    cidrIp - The IPv4 address range, in CIDR format.
    
    To specify an IPv6 address range, use IP permissions instead.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
  - getCidrIp
```
public String getCidrIp()
```
    The IPv4 address range, in CIDR format.
    
    To specify an IPv6 address range, use IP permissions instead.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Returns:
    
    The IPv4 address range, in CIDR format.
    
    To specify an IPv6 address range, use IP permissions instead.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
  - withCidrIp
```
public AuthorizeSecurityGroupIngressRequest withCidrIp(String cidrIp)
```
    The IPv4 address range, in CIDR format.
    
    To specify an IPv6 address range, use IP permissions instead.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Parameters:
    
    cidrIp - The IPv4 address range, in CIDR format.
    
    To specify an IPv6 address range, use IP permissions instead.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    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, this is the ICMP type or -1 (all ICMP types).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Parameters:
    
    fromPort - If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
  - getFromPort
```
public Integer getFromPort()
```
    If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Returns:
    
    If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
  - withFromPort
```
public AuthorizeSecurityGroupIngressRequest withFromPort(Integer fromPort)
```
    If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Parameters:
    
    fromPort - If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    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 AuthorizeSecurityGroupIngressRequest 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.
  - setGroupName
```
public void setGroupName(String groupName)
```
    [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.
    
    Parameters:
    
    groupName - [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.
  - getGroupName
```
public String getGroupName()
```
    [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.
    
    Returns:
    
    [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.
  - withGroupName
```
public AuthorizeSecurityGroupIngressRequest withGroupName(String groupName)
```
    [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.
    
    Parameters:
    
    groupName - [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIpPermissions
```
public List<IpPermission> getIpPermissions()
```
    The permissions for the security group rules.
    
    Returns:
    
    The permissions for the security group rules.
  - setIpPermissions
```
public void setIpPermissions(Collection<IpPermission> ipPermissions)
```
    The permissions for the security group rules.
    
    Parameters:
    
    ipPermissions - The permissions for the security group rules.
  - withIpPermissions
```
public AuthorizeSecurityGroupIngressRequest withIpPermissions(IpPermission... ipPermissions)
```
    The permissions for the security group rules.
    
    NOTE: This method appends the values to the existing list (if any). Use setIpPermissions(java.util.Collection) or withIpPermissions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ipPermissions - The permissions for the security group rules.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIpPermissions
```
public AuthorizeSecurityGroupIngressRequest withIpPermissions(Collection<IpPermission> ipPermissions)
```
    The permissions for the security group rules.
    
    Parameters:
    
    ipPermissions - The permissions for the security group rules.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpProtocol
```
public void setIpProtocol(String ipProtocol)
```
    The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify all protocols, use -1.
    
    To specify icmpv6, use IP permissions instead.
    
    If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Parameters:
    
    ipProtocol - The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify all protocols, use -1.
    
    To specify icmpv6, use IP permissions instead.
    
    If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
  - getIpProtocol
```
public String getIpProtocol()
```
    The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify all protocols, use -1.
    
    To specify icmpv6, use IP permissions instead.
    
    If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Returns:
    
    The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify all protocols, use -1.
    
    To specify icmpv6, use IP permissions instead.
    
    If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
  - withIpProtocol
```
public AuthorizeSecurityGroupIngressRequest withIpProtocol(String ipProtocol)
```
    The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify all protocols, use -1.
    
    To specify icmpv6, use IP permissions instead.
    
    If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Parameters:
    
    ipProtocol - The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify all protocols, use -1.
    
    To specify icmpv6, use IP permissions instead.
    
    If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify.
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceSecurityGroupName
```
public void setSourceSecurityGroupName(String sourceSecurityGroupName)
```
    [Default VPC] The name of the source security group.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.
    
    Parameters:
    
    sourceSecurityGroupName - [Default VPC] The name of the source security group.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.
  - getSourceSecurityGroupName
```
public String getSourceSecurityGroupName()
```
    [Default VPC] The name of the source security group.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.
    
    Returns:
    
    [Default VPC] The name of the source security group.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.
  - withSourceSecurityGroupName
```
public AuthorizeSecurityGroupIngressRequest withSourceSecurityGroupName(String sourceSecurityGroupName)
```
    [Default VPC] The name of the source security group.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.
    
    Parameters:
    
    sourceSecurityGroupName - [Default VPC] The name of the source security group.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceSecurityGroupOwnerId
```
public void setSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)
```
    The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.
    
    Parameters:
    
    sourceSecurityGroupOwnerId - The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.
  - getSourceSecurityGroupOwnerId
```
public String getSourceSecurityGroupOwnerId()
```
    The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.
    
    Returns:
    
    The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.
  - withSourceSecurityGroupOwnerId
```
public AuthorizeSecurityGroupIngressRequest withSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)
```
    The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.
    
    Parameters:
    
    sourceSecurityGroupOwnerId - The Amazon Web Services account ID for the source security group, if the source security group is in a different account.
    
    The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead.
    
    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, 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).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Parameters:
    
    toPort - If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, 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).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
  - getToPort
```
public Integer getToPort()
```
    If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, 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).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Returns:
    
    If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, 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).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
  - withToPort
```
public AuthorizeSecurityGroupIngressRequest withToPort(Integer toPort)
```
    If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, 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).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Parameters:
    
    toPort - If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, 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).
    
    To specify multiple rules and descriptions for the rules, use IP permissions instead.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTagSpecifications
```
public List<TagSpecification> getTagSpecifications()
```
    The tags applied to the security group rule.
    
    Returns:
    
    The tags applied to the security group rule.
  - setTagSpecifications
```
public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)
```
    The tags applied to the security group rule.
    
    Parameters:
    
    tagSpecifications - The tags applied to the security group rule.
  - withTagSpecifications
```
public AuthorizeSecurityGroupIngressRequest withTagSpecifications(TagSpecification... tagSpecifications)
```
    The tags applied to the security group rule.
    
    NOTE: This method appends the values to the existing list (if any). Use setTagSpecifications(java.util.Collection) or withTagSpecifications(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tagSpecifications - The tags applied to the security group rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTagSpecifications
```
public AuthorizeSecurityGroupIngressRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)
```
    The tags applied to the security group rule.
    
    Parameters:
    
    tagSpecifications - The tags applied to the security group rule.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDryRunRequest
```
public Request<AuthorizeSecurityGroupIngressRequest> getDryRunRequest()
```
    This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.
    
    Specified by:
    
    getDryRunRequest in interface DryRunSupportedRequest<AuthorizeSecurityGroupIngressRequest>
  - 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 AuthorizeSecurityGroupIngressRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.780

Class AuthorizeSecurityGroupIngressRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AuthorizeSecurityGroupIngressRequest

AuthorizeSecurityGroupIngressRequest

Method Detail

setCidrIp

getCidrIp

withCidrIp

setFromPort

getFromPort

withFromPort

setGroupId

getGroupId

withGroupId

setGroupName

getGroupName

withGroupName

getIpPermissions

setIpPermissions

withIpPermissions

withIpPermissions

setIpProtocol

getIpProtocol

withIpProtocol

setSourceSecurityGroupName

getSourceSecurityGroupName

withSourceSecurityGroupName

setSourceSecurityGroupOwnerId

getSourceSecurityGroupOwnerId

withSourceSecurityGroupOwnerId

setToPort

getToPort

withToPort

getTagSpecifications

setTagSpecifications

withTagSpecifications

withTagSpecifications

getDryRunRequest

toString

equals

hashCode

clone