com.amazonaws.services.ec2.model
Class RevokeSecurityGroupIngressRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.ec2.model.RevokeSecurityGroupIngressRequest

public class RevokeSecurityGroupIngressRequest
extends AmazonWebServiceRequest

Container for the parameters to the RevokeSecurityGroupIngress operation.

The RevokeSecurityGroupIngress operation revokes permissions from a security group. The permissions used to revoke must be specified using the same values used to grant the permissions.

Permissions are specified by IP protocol (TCP, UDP, or ICMP), the source of the request (by IP range or an Amazon EC2 user-group pair), the source and destination port ranges (for TCP and UDP), and the ICMP codes and types (for ICMP).

Permission changes are quickly propagated to instances within the security group. However, depending on the number of instances in the group, a small delay might occur.

See Also:
AmazonEC2.revokeSecurityGroupIngress(RevokeSecurityGroupIngressRequest)

Constructor Summary
RevokeSecurityGroupIngressRequest()
          Default constructor for a new RevokeSecurityGroupIngressRequest object.
RevokeSecurityGroupIngressRequest(String groupName, List<IpPermission> ipPermissions)
          Constructs a new RevokeSecurityGroupIngressRequest object.
 
Method Summary
 boolean equals(Object obj)
           
 String getCidrIp()
          Deprecated
 Integer getFromPort()
          Deprecated
 String getGroupId()
          ID of the standard (EC2) or VPC security group to modify.
 String getGroupName()
          Name of the standard (EC2) security group to modify.
 List<IpPermission> getIpPermissions()
          List of IP permissions to revoke on the specified security group.
 String getIpProtocol()
          Deprecated
 String getSourceSecurityGroupName()
          Deprecated
 String getSourceSecurityGroupOwnerId()
          Deprecated
 Integer getToPort()
          Deprecated
 int hashCode()
           
 void setCidrIp(String cidrIp)
          Deprecated
 void setFromPort(Integer fromPort)
          Deprecated
 void setGroupId(String groupId)
          ID of the standard (EC2) or VPC security group to modify.
 void setGroupName(String groupName)
          Name of the standard (EC2) security group to modify.
 void setIpPermissions(Collection<IpPermission> ipPermissions)
          List of IP permissions to revoke on the specified security group.
 void setIpProtocol(String ipProtocol)
          Deprecated
 void setSourceSecurityGroupName(String sourceSecurityGroupName)
          Deprecated
 void setSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)
          Deprecated
 void setToPort(Integer toPort)
          Deprecated
 String toString()
          Returns a string representation of this object; useful for testing and debugging.
 RevokeSecurityGroupIngressRequest withCidrIp(String cidrIp)
          Deprecated
 RevokeSecurityGroupIngressRequest withFromPort(Integer fromPort)
          Deprecated
 RevokeSecurityGroupIngressRequest withGroupId(String groupId)
          ID of the standard (EC2) or VPC security group to modify.
 RevokeSecurityGroupIngressRequest withGroupName(String groupName)
          Name of the standard (EC2) security group to modify.
 RevokeSecurityGroupIngressRequest withIpPermissions(Collection<IpPermission> ipPermissions)
          List of IP permissions to revoke on the specified security group.
 RevokeSecurityGroupIngressRequest withIpPermissions(IpPermission... ipPermissions)
          List of IP permissions to revoke on the specified security group.
 RevokeSecurityGroupIngressRequest withIpProtocol(String ipProtocol)
          Deprecated
 RevokeSecurityGroupIngressRequest withSourceSecurityGroupName(String sourceSecurityGroupName)
          Deprecated
 RevokeSecurityGroupIngressRequest withSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)
          Deprecated
 RevokeSecurityGroupIngressRequest withToPort(Integer toPort)
          Deprecated
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials
 
Methods inherited from class java.lang.Object
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 - Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.
ipPermissions - List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.
Method Detail

getGroupName

public String getGroupName()
Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.

Returns:
Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.

setGroupName

public void setGroupName(String groupName)
Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.

Parameters:
groupName - Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.

withGroupName

public RevokeSecurityGroupIngressRequest withGroupName(String groupName)
Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.

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

Parameters:
groupName - Name of the standard (EC2) security group to modify. The group must belong to your account. Can be used instead of GroupID for standard (EC2) security groups.
Returns:
A reference to this updated object so that method calls can be chained together.

getGroupId

public String getGroupId()
ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.

Returns:
ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.

setGroupId

public void setGroupId(String groupId)
ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.

Parameters:
groupId - ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.

withGroupId

public RevokeSecurityGroupIngressRequest withGroupId(String groupId)
ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.

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

Parameters:
groupId - ID of the standard (EC2) or VPC security group to modify. The group must belong to your account. Required for VPC security groups; can be used instead of GroupName for standard (EC2) security groups.
Returns:
A reference to this updated object so that method calls can be chained together.

getSourceSecurityGroupName

public String getSourceSecurityGroupName()
Deprecated

Returns:
Deprecated

setSourceSecurityGroupName

public void setSourceSecurityGroupName(String sourceSecurityGroupName)
Deprecated

Parameters:
sourceSecurityGroupName - Deprecated

withSourceSecurityGroupName

public RevokeSecurityGroupIngressRequest withSourceSecurityGroupName(String sourceSecurityGroupName)
Deprecated

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

Parameters:
sourceSecurityGroupName - Deprecated
Returns:
A reference to this updated object so that method calls can be chained together.

getSourceSecurityGroupOwnerId

public String getSourceSecurityGroupOwnerId()
Deprecated

Returns:
Deprecated

setSourceSecurityGroupOwnerId

public void setSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)
Deprecated

Parameters:
sourceSecurityGroupOwnerId - Deprecated

withSourceSecurityGroupOwnerId

public RevokeSecurityGroupIngressRequest withSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)
Deprecated

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

Parameters:
sourceSecurityGroupOwnerId - Deprecated
Returns:
A reference to this updated object so that method calls can be chained together.

getIpProtocol

public String getIpProtocol()
Deprecated

Returns:
Deprecated

setIpProtocol

public void setIpProtocol(String ipProtocol)
Deprecated

Parameters:
ipProtocol - Deprecated

withIpProtocol

public RevokeSecurityGroupIngressRequest withIpProtocol(String ipProtocol)
Deprecated

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

Parameters:
ipProtocol - Deprecated
Returns:
A reference to this updated object so that method calls can be chained together.

getFromPort

public Integer getFromPort()
Deprecated

Returns:
Deprecated

setFromPort

public void setFromPort(Integer fromPort)
Deprecated

Parameters:
fromPort - Deprecated

withFromPort

public RevokeSecurityGroupIngressRequest withFromPort(Integer fromPort)
Deprecated

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

Parameters:
fromPort - Deprecated
Returns:
A reference to this updated object so that method calls can be chained together.

getToPort

public Integer getToPort()
Deprecated

Returns:
Deprecated

setToPort

public void setToPort(Integer toPort)
Deprecated

Parameters:
toPort - Deprecated

withToPort

public RevokeSecurityGroupIngressRequest withToPort(Integer toPort)
Deprecated

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

Parameters:
toPort - Deprecated
Returns:
A reference to this updated object so that method calls can be chained together.

getCidrIp

public String getCidrIp()
Deprecated

Returns:
Deprecated

setCidrIp

public void setCidrIp(String cidrIp)
Deprecated

Parameters:
cidrIp - Deprecated

withCidrIp

public RevokeSecurityGroupIngressRequest withCidrIp(String cidrIp)
Deprecated

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

Parameters:
cidrIp - Deprecated
Returns:
A reference to this updated object so that method calls can be chained together.

getIpPermissions

public List<IpPermission> getIpPermissions()
List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.

Returns:
List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.

setIpPermissions

public void setIpPermissions(Collection<IpPermission> ipPermissions)
List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.

Parameters:
ipPermissions - List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.

withIpPermissions

public RevokeSecurityGroupIngressRequest withIpPermissions(IpPermission... ipPermissions)
List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.

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

Parameters:
ipPermissions - List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.
Returns:
A reference to this updated object so that method calls can be chained together.

withIpPermissions

public RevokeSecurityGroupIngressRequest withIpPermissions(Collection<IpPermission> ipPermissions)
List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.

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

Parameters:
ipPermissions - List of IP permissions to revoke on the specified security group. For an IP permission to be removed, it must exactly match one of the IP permissions you specify in this list. Specifying permissions through IP permissions is the preferred way of revoking permissions since it offers more flexibility and control.
Returns:
A reference to this updated object so that method calls can be chained together.

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


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.