AuthorizeSecurityGroupIngressRequest (AWS SDK for Android

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

All Implemented Interfaces:

DryRunSupportedRequest<AuthorizeSecurityGroupIngressRequest>, java.io.Serializable, java.lang.Cloneable
```
public class AuthorizeSecurityGroupIngressRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<AuthorizeSecurityGroupIngressRequest>
```
Container for the parameters to the AuthorizeSecurityGroupIngress operation.
Adds one or more ingress rules to a security group.

IMPORTANT: EC2-Classic: You can have up to 100 rules per group. EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups ) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups ) permission to access a security group for your VPC. The security groups must all be for the same VPC.

See Also:

AmazonEC2.authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest), Serialized Form

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getCidrIp()` The CIDR IP address range.
`Request<AuthorizeSecurityGroupIngressRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`java.lang.Integer`	`getFromPort()` The start of port range for the TCP and UDP protocols, or an ICMP type number.
`java.lang.String`	`getGroupId()` The ID of the security group.
`java.lang.String`	`getGroupName()` [EC2-Classic, default VPC] The name of the security group.
`java.util.List<IpPermission>`	`getIpPermissions()` A set of IP permissions.
`java.lang.String`	`getIpProtocol()` The IP protocol name (`tcp`, `udp`, `icmp`) or number (see Protocol Numbers).
`java.lang.String`	`getSourceSecurityGroupName()` [EC2-Classic, default VPC] The name of the source security group.
`java.lang.String`	`getSourceSecurityGroupOwnerId()` [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account.
`java.lang.Integer`	`getToPort()` The end of port range for the TCP and UDP protocols, or an ICMP code number.
`int`	`hashCode()`
`void`	`setCidrIp(java.lang.String cidrIp)` The CIDR IP address range.
`void`	`setFromPort(java.lang.Integer fromPort)` The start of port range for the TCP and UDP protocols, or an ICMP type number.
`void`	`setGroupId(java.lang.String groupId)` The ID of the security group.
`void`	`setGroupName(java.lang.String groupName)` [EC2-Classic, default VPC] The name of the security group.
`void`	`setIpPermissions(java.util.Collection<IpPermission> ipPermissions)` A set of IP permissions.
`void`	`setIpProtocol(java.lang.String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`) or number (see Protocol Numbers).
`void`	`setSourceSecurityGroupName(java.lang.String sourceSecurityGroupName)` [EC2-Classic, default VPC] The name of the source security group.
`void`	`setSourceSecurityGroupOwnerId(java.lang.String sourceSecurityGroupOwnerId)` [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account.
`void`	`setToPort(java.lang.Integer toPort)` The end of port range for the TCP and UDP protocols, or an ICMP code number.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AuthorizeSecurityGroupIngressRequest`	`withCidrIp(java.lang.String cidrIp)` The CIDR IP address range.
`AuthorizeSecurityGroupIngressRequest`	`withFromPort(java.lang.Integer fromPort)` The start of port range for the TCP and UDP protocols, or an ICMP type number.
`AuthorizeSecurityGroupIngressRequest`	`withGroupId(java.lang.String groupId)` The ID of the security group.
`AuthorizeSecurityGroupIngressRequest`	`withGroupName(java.lang.String groupName)` [EC2-Classic, default VPC] The name of the security group.
`AuthorizeSecurityGroupIngressRequest`	`withIpPermissions(java.util.Collection<IpPermission> ipPermissions)` A set of IP permissions.
`AuthorizeSecurityGroupIngressRequest`	`withIpPermissions(IpPermission... ipPermissions)` A set of IP permissions.
`AuthorizeSecurityGroupIngressRequest`	`withIpProtocol(java.lang.String ipProtocol)` The IP protocol name (`tcp`, `udp`, `icmp`) or number (see Protocol Numbers).
`AuthorizeSecurityGroupIngressRequest`	`withSourceSecurityGroupName(java.lang.String sourceSecurityGroupName)` [EC2-Classic, default VPC] The name of the source security group.
`AuthorizeSecurityGroupIngressRequest`	`withSourceSecurityGroupOwnerId(java.lang.String sourceSecurityGroupOwnerId)` [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account.
`AuthorizeSecurityGroupIngressRequest`	`withToPort(java.lang.Integer toPort)` The end of port range for the TCP and UDP protocols, or an ICMP code number.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - AuthorizeSecurityGroupIngressRequest
```
public AuthorizeSecurityGroupIngressRequest()
```
    Default constructor for a new AuthorizeSecurityGroupIngressRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
  - AuthorizeSecurityGroupIngressRequest
```
public AuthorizeSecurityGroupIngressRequest(java.lang.String groupName,
                                            java.util.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 - [EC2-Classic, default VPC] The name of the security group.
    
    ipPermissions - A set of IP permissions. Can be used to specify multiple rules in a single command.
- Method Detail
  - getGroupName
```
public java.lang.String getGroupName()
```
    [EC2-Classic, default VPC] The name of the security group.
    
    Returns:
    
    [EC2-Classic, default VPC] The name of the security group.
  - setGroupName
```
public void setGroupName(java.lang.String groupName)
```
    [EC2-Classic, default VPC] The name of the security group.
    
    Parameters:
    
    groupName - [EC2-Classic, default VPC] The name of the security group.
  - withGroupName
```
public AuthorizeSecurityGroupIngressRequest withGroupName(java.lang.String groupName)
```
    [EC2-Classic, default VPC] The name of the security group.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    groupName - [EC2-Classic, default VPC] The name of the security group.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getGroupId
```
public java.lang.String getGroupId()
```
    The ID of the security group. Required for a nondefault VPC.
    
    Returns:
    
    The ID of the security group. Required for a nondefault VPC.
  - setGroupId
```
public void setGroupId(java.lang.String groupId)
```
    The ID of the security group. Required for a nondefault VPC.
    
    Parameters:
    
    groupId - The ID of the security group. Required for a nondefault VPC.
  - withGroupId
```
public AuthorizeSecurityGroupIngressRequest withGroupId(java.lang.String groupId)
```
    The ID of the security group. Required for a nondefault VPC.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    groupId - The ID of the security group. Required for a nondefault VPC.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSourceSecurityGroupName
```
public java.lang.String getSourceSecurityGroupName()
```
    [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.
    
    Returns:
    
    [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.
  - setSourceSecurityGroupName
```
public void setSourceSecurityGroupName(java.lang.String sourceSecurityGroupName)
```
    [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.
    
    Parameters:
    
    sourceSecurityGroupName - [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.
  - withSourceSecurityGroupName
```
public AuthorizeSecurityGroupIngressRequest withSourceSecurityGroupName(java.lang.String sourceSecurityGroupName)
```
    [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    sourceSecurityGroupName - [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSourceSecurityGroupOwnerId
```
public java.lang.String getSourceSecurityGroupOwnerId()
```
    [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.
    
    Returns:
    
    [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.
  - setSourceSecurityGroupOwnerId
```
public void setSourceSecurityGroupOwnerId(java.lang.String sourceSecurityGroupOwnerId)
```
    [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.
    
    Parameters:
    
    sourceSecurityGroupOwnerId - [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.
  - withSourceSecurityGroupOwnerId
```
public AuthorizeSecurityGroupIngressRequest withSourceSecurityGroupOwnerId(java.lang.String sourceSecurityGroupOwnerId)
```
    [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    sourceSecurityGroupOwnerId - [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getIpProtocol
```
public java.lang.String getIpProtocol()
```
    The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.
    
    Returns:
    
    The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.
  - setIpProtocol
```
public void setIpProtocol(java.lang.String ipProtocol)
```
    The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.
    
    Parameters:
    
    ipProtocol - The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.
  - withIpProtocol
```
public AuthorizeSecurityGroupIngressRequest withIpProtocol(java.lang.String ipProtocol)
```
    The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    ipProtocol - The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFromPort
```
public java.lang.Integer getFromPort()
```
    The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
    
    Returns:
    
    The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
  - setFromPort
```
public void setFromPort(java.lang.Integer fromPort)
```
    The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
    
    Parameters:
    
    fromPort - The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
  - withFromPort
```
public AuthorizeSecurityGroupIngressRequest withFromPort(java.lang.Integer fromPort)
```
    The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    fromPort - The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getToPort
```
public java.lang.Integer getToPort()
```
    The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
    
    Returns:
    
    The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
  - setToPort
```
public void setToPort(java.lang.Integer toPort)
```
    The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
    
    Parameters:
    
    toPort - The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
  - withToPort
```
public AuthorizeSecurityGroupIngressRequest withToPort(java.lang.Integer toPort)
```
    The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    toPort - The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getCidrIp
```
public java.lang.String getCidrIp()
```
    The CIDR IP address range. You can't specify this parameter when specifying a source security group.
    
    Returns:
    
    The CIDR IP address range. You can't specify this parameter when specifying a source security group.
  - setCidrIp
```
public void setCidrIp(java.lang.String cidrIp)
```
    The CIDR IP address range. You can't specify this parameter when specifying a source security group.
    
    Parameters:
    
    cidrIp - The CIDR IP address range. You can't specify this parameter when specifying a source security group.
  - withCidrIp
```
public AuthorizeSecurityGroupIngressRequest withCidrIp(java.lang.String cidrIp)
```
    The CIDR IP address range. You can't specify this parameter when specifying a source security group.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    cidrIp - The CIDR IP address range. You can't specify this parameter when specifying a source security group.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getIpPermissions
```
public java.util.List<IpPermission> getIpPermissions()
```
    A set of IP permissions. Can be used to specify multiple rules in a single command.
    
    Returns:
    
    A set of IP permissions. Can be used to specify multiple rules in a single command.
  - setIpPermissions
```
public void setIpPermissions(java.util.Collection<IpPermission> ipPermissions)
```
    A set of IP permissions. Can be used to specify multiple rules in a single command.
    
    Parameters:
    
    ipPermissions - A set of IP permissions. Can be used to specify multiple rules in a single command.
  - withIpPermissions
```
public AuthorizeSecurityGroupIngressRequest withIpPermissions(IpPermission... ipPermissions)
```
    A set of IP permissions. Can be used to specify multiple rules in a single command.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    ipPermissions - A set of IP permissions. Can be used to specify multiple rules in a single command.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withIpPermissions
```
public AuthorizeSecurityGroupIngressRequest withIpPermissions(java.util.Collection<IpPermission> ipPermissions)
```
    A set of IP permissions. Can be used to specify multiple rules in a single command.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    ipPermissions - A set of IP permissions. Can be used to specify multiple rules in a single command.
    
    Returns:
    
    A reference to this updated 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 java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class AuthorizeSecurityGroupIngressRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AuthorizeSecurityGroupIngressRequest

AuthorizeSecurityGroupIngressRequest

Method Detail

getGroupName

setGroupName

withGroupName

getGroupId

setGroupId

withGroupId

getSourceSecurityGroupName

setSourceSecurityGroupName

withSourceSecurityGroupName

getSourceSecurityGroupOwnerId

setSourceSecurityGroupOwnerId

withSourceSecurityGroupOwnerId

getIpProtocol

setIpProtocol

withIpProtocol

getFromPort

setFromPort

withFromPort

getToPort

setToPort

withToPort

getCidrIp

setCidrIp

withCidrIp

getIpPermissions

setIpPermissions

withIpPermissions

withIpPermissions

getDryRunRequest

toString

hashCode

equals