com.amazonaws.services.ec2.model
Class AuthorizeSecurityGroupEgressRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.ec2.model.AuthorizeSecurityGroupEgressRequest
All Implemented Interfaces:
DryRunSupportedRequest<AuthorizeSecurityGroupEgressRequest>, java.io.Serializable

public class AuthorizeSecurityGroupEgressRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<AuthorizeSecurityGroupEgressRequest>

Container for the parameters to the AuthorizeSecurityGroupEgress operation.

Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more CIDR IP address ranges, or to one or more security groups for the same VPC.

IMPORTANT: You can have up to 50 rules per security group (covering both ingress and egress rules).

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide .

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

See Also:
AmazonEC2.authorizeSecurityGroupEgress(AuthorizeSecurityGroupEgressRequest), Serialized Form

Constructor Summary
AuthorizeSecurityGroupEgressRequest()
           
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 java.lang.String getCidrIp()
          The CIDR IP address range.
 Request<AuthorizeSecurityGroupEgressRequest> 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.util.List<IpPermission> getIpPermissions()
          

 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()
          The ID of the source security group.
 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 setIpPermissions(java.util.Collection<IpPermission> ipPermissions)
          

 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)
          The ID of the source security group.
 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.
 AuthorizeSecurityGroupEgressRequest withCidrIp(java.lang.String cidrIp)
          The CIDR IP address range.
 AuthorizeSecurityGroupEgressRequest withFromPort(java.lang.Integer fromPort)
          The start of port range for the TCP and UDP protocols, or an ICMP type number.
 AuthorizeSecurityGroupEgressRequest withGroupId(java.lang.String groupId)
          The ID of the security group.
 AuthorizeSecurityGroupEgressRequest withIpPermissions(java.util.Collection<IpPermission> ipPermissions)
          

 AuthorizeSecurityGroupEgressRequest withIpPermissions(IpPermission... ipPermissions)
          

 AuthorizeSecurityGroupEgressRequest withIpProtocol(java.lang.String ipProtocol)
          The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers).
 AuthorizeSecurityGroupEgressRequest withSourceSecurityGroupName(java.lang.String sourceSecurityGroupName)
          [EC2-Classic, default VPC] The name of the source security group.
 AuthorizeSecurityGroupEgressRequest withSourceSecurityGroupOwnerId(java.lang.String sourceSecurityGroupOwnerId)
          The ID of the source security group.
 AuthorizeSecurityGroupEgressRequest 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
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AuthorizeSecurityGroupEgressRequest

public AuthorizeSecurityGroupEgressRequest()
Method Detail

getGroupId

public java.lang.String getGroupId()
The ID of the security group.

Returns:
The ID of the security group.

setGroupId

public void setGroupId(java.lang.String groupId)
The ID of the security group.

Parameters:
groupId - The ID of the security group.

withGroupId

public AuthorizeSecurityGroupEgressRequest withGroupId(java.lang.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 java.lang.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(java.lang.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 AuthorizeSecurityGroupEgressRequest withSourceSecurityGroupName(java.lang.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 java.lang.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(java.lang.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 AuthorizeSecurityGroupEgressRequest withSourceSecurityGroupOwnerId(java.lang.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 java.lang.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(java.lang.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 AuthorizeSecurityGroupEgressRequest withIpProtocol(java.lang.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 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 AuthorizeSecurityGroupEgressRequest 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 AuthorizeSecurityGroupEgressRequest 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 AuthorizeSecurityGroupEgressRequest 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()

Returns:


setIpPermissions

public void setIpPermissions(java.util.Collection<IpPermission> ipPermissions)

Parameters:
ipPermissions -


withIpPermissions

public AuthorizeSecurityGroupEgressRequest withIpPermissions(IpPermission... ipPermissions)

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

Parameters:
ipPermissions -

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

withIpPermissions

public AuthorizeSecurityGroupEgressRequest withIpPermissions(java.util.Collection<IpPermission> ipPermissions)

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

Parameters:
ipPermissions -

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

getDryRunRequest

public Request<AuthorizeSecurityGroupEgressRequest> 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<AuthorizeSecurityGroupEgressRequest>

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


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