com.amazonaws.services.ec2.model

Class AuthorizeSecurityGroupIngressRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressRequest

All Implemented Interfaces:

DryRunSupportedRequest<AuthorizeSecurityGroupIngressRequest>, Serializable

public class AuthorizeSecurityGroupIngressRequest
extends AmazonWebServiceRequest
implements 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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Methods

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

copyBaseTo, copyPrivateRequestParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, 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(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 - [EC2-Classic, default VPC] The name of the security group.

ipPermissions - A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

Method Detail

getGroupName

public 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(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(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 String getGroupId()

The ID of the security group.

Returns:

The ID of the security group.

setGroupId

public void setGroupId(String groupId)

The ID of the security group.

Parameters:

groupId - The ID of the security group.

withGroupId

public AuthorizeSecurityGroupIngressRequest withGroupId(String groupId)

The ID of the security group.

Returns a reference to this object so that method calls can be chained together.

Parameters:

groupId - The ID of the security group.

Returns:

A reference to this updated object so that method calls can be chained together.

getSourceSecurityGroupName

public String getSourceSecurityGroupName()

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

Returns:

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

setSourceSecurityGroupName

public void setSourceSecurityGroupName(String sourceSecurityGroupName)

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

Parameters:

sourceSecurityGroupName - [EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

withSourceSecurityGroupName

public AuthorizeSecurityGroupIngressRequest withSourceSecurityGroupName(String sourceSecurityGroupName)

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

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 a source security group and a CIDR IP address range.

Returns:

A reference to this updated object so that method calls can be chained together.

getSourceSecurityGroupOwnerId

public String getSourceSecurityGroupOwnerId()

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

Returns:

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

setSourceSecurityGroupOwnerId

public void setSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

Parameters:

sourceSecurityGroupOwnerId - The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

withSourceSecurityGroupOwnerId

public AuthorizeSecurityGroupIngressRequest withSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

Returns a reference to this object so that method calls can be chained together.

Parameters:

sourceSecurityGroupOwnerId - The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

Returns:

A reference to this updated object so that method calls can be chained together.

getIpProtocol

public 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(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(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 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(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(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 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(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(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 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(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(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 List<IpPermission> getIpPermissions()

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

Returns:

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

setIpPermissions

public void setIpPermissions(Collection<IpPermission> ipPermissions)

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

Parameters:

ipPermissions - A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

withIpPermissions

public AuthorizeSecurityGroupIngressRequest withIpPermissions(IpPermission... ipPermissions)

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

Returns a reference to this object so that method calls can be chained together.

Parameters:

ipPermissions - A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

Returns:

A reference to this updated object so that method calls can be chained together.

withIpPermissions

public AuthorizeSecurityGroupIngressRequest withIpPermissions(Collection<IpPermission> ipPermissions)

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

Returns a reference to this object so that method calls can be chained together.

Parameters:

ipPermissions - A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

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 String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object