com.amazonaws.services.ec2.model

Class RevokeSecurityGroupIngressRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.RevokeSecurityGroupIngressRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<RevokeSecurityGroupIngressRequest>, Serializable, Cloneable

public class RevokeSecurityGroupIngressRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<RevokeSecurityGroupIngressRequest>

Container for the parameters to the RevokeSecurityGroupIngress operation.

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

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

See Also:

AmazonEC2.revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
RevokeSecurityGroupIngressRequest	clone()
boolean	equals(Object obj)
String	getCidrIp() The CIDR IP address range.
Request<RevokeSecurityGroupIngressRequest>	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() [EC2-Classic, default VPC] The AWS account 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) [EC2-Classic, default VPC] The AWS account 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.
RevokeSecurityGroupIngressRequest	withCidrIp(String cidrIp) The CIDR IP address range.
RevokeSecurityGroupIngressRequest	withFromPort(Integer fromPort) The start of port range for the TCP and UDP protocols, or an ICMP type number.
RevokeSecurityGroupIngressRequest	withGroupId(String groupId) The ID of the security group.
RevokeSecurityGroupIngressRequest	withGroupName(String groupName) [EC2-Classic, default VPC] The name of the security group.
RevokeSecurityGroupIngressRequest	withIpPermissions(Collection<IpPermission> ipPermissions) A set of IP permissions.
RevokeSecurityGroupIngressRequest	withIpPermissions(IpPermission... ipPermissions) A set of IP permissions.
RevokeSecurityGroupIngressRequest	withIpProtocol(String ipProtocol) The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
RevokeSecurityGroupIngressRequest	withSourceSecurityGroupName(String sourceSecurityGroupName) [EC2-Classic, default VPC] The name of the source security group.
RevokeSecurityGroupIngressRequest	withSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId) [EC2-Classic, default VPC] The AWS account ID of the source security group.
RevokeSecurityGroupIngressRequest	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, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RevokeSecurityGroupIngressRequest

public RevokeSecurityGroupIngressRequest()

Default constructor for a new RevokeSecurityGroupIngressRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

RevokeSecurityGroupIngressRequest

public RevokeSecurityGroupIngressRequest(String groupName,
                                 List<IpPermission> ipPermissions)

Constructs a new RevokeSecurityGroupIngressRequest 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 RevokeSecurityGroupIngressRequest 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. Required for a security group in a nondefault VPC.

Returns:

The ID of the security group. Required for a security group in a nondefault VPC.

setGroupId

public void setGroupId(String groupId)

The ID of the security group. Required for a security group in a nondefault VPC.

Parameters:

groupId - The ID of the security group. Required for a security group in a nondefault VPC.

withGroupId

public RevokeSecurityGroupIngressRequest withGroupId(String groupId)

The ID of the security group. Required for a security group in 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 security group in a nondefault VPC.

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 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. 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. For EC2-VPC, the source security group must be in the same VPC.

setSourceSecurityGroupName

public void setSourceSecurityGroupName(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. 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. For EC2-VPC, the source security group must be in the same VPC.

withSourceSecurityGroupName

public RevokeSecurityGroupIngressRequest withSourceSecurityGroupName(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. 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. 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 String getSourceSecurityGroupOwnerId()

[EC2-Classic, default VPC] The AWS account ID of the source security group. For EC2-VPC, the source security group must be in the same VPC. 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. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

Returns:

[EC2-Classic, default VPC] The AWS account ID of the source security group. For EC2-VPC, the source security group must be in the same VPC. 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. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

setSourceSecurityGroupOwnerId

public void setSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)

[EC2-Classic, default VPC] The AWS account ID of the source security group. For EC2-VPC, the source security group must be in the same VPC. 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. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

Parameters:

sourceSecurityGroupOwnerId - [EC2-Classic, default VPC] The AWS account ID of the source security group. For EC2-VPC, the source security group must be in the same VPC. 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. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

withSourceSecurityGroupOwnerId

public RevokeSecurityGroupIngressRequest withSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)

[EC2-Classic, default VPC] The AWS account ID of the source security group. For EC2-VPC, the source security group must be in the same VPC. 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. To revoke a specific rule for an 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, default VPC] The AWS account ID of the source security group. For EC2-VPC, the source security group must be in the same VPC. 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. To revoke a specific rule for an 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 String getIpProtocol()

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

Returns:

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

setIpProtocol

public void setIpProtocol(String ipProtocol)

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

Parameters:

ipProtocol - The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

withIpProtocol

public RevokeSecurityGroupIngressRequest withIpProtocol(String ipProtocol)

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). 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). 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 RevokeSecurityGroupIngressRequest 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 RevokeSecurityGroupIngressRequest 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 RevokeSecurityGroupIngressRequest 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 RevokeSecurityGroupIngressRequest withIpPermissions(IpPermission... ipPermissions)

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

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.

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 RevokeSecurityGroupIngressRequest 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<RevokeSecurityGroupIngressRequest> 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<RevokeSecurityGroupIngressRequest>

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

clone

public RevokeSecurityGroupIngressRequest clone()

Overrides:

clone in class AmazonWebServiceRequest