com.amazonaws.services.ec2.model
Class AuthorizeSecurityGroupIngressRequest

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

public class AuthorizeSecurityGroupIngressRequest
extends AmazonWebServiceRequest

Container for the parameters to the AuthorizeSecurityGroupIngress operation.

The AuthorizeSecurityGroupIngress operation adds permissions to a security group.

Permissions are specified by the 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). When authorizing ICMP, -1 can be used as a wildcard in the type and code fields.

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

See Also:

AmazonEC2.authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest)

Constructor Summary

AuthorizeSecurityGroupIngressRequest()
Default constructor for a new AuthorizeSecurityGroupIngressRequest object.

AuthorizeSecurityGroupIngressRequest(String groupName, List<IpPermission> ipPermissions)
Constructs a new AuthorizeSecurityGroupIngressRequest object.

Method Summary

String	getCidrIp() Deprecated - use the list of IP permissions to specify this information instead.
Integer	getFromPort() Deprecated - use the list of IP permissions to specify this information instead.
String	getGroupName() Name of the group to modify.
List<IpPermission>	getIpPermissions() List of IP permissions to authorize on the specified security group.
String	getIpProtocol() Deprecated - use the list of IP permissions to specify this information instead.
String	getSourceSecurityGroupName() Deprecated - use the list of IP permissions to specify this information instead.
String	getSourceSecurityGroupOwnerId() Deprecated - use the list of IP permissions to specify this information instead.
Integer	getToPort() Deprecated - use the list of IP permissions to specify this information instead.
void	setCidrIp(String cidrIp) Deprecated - use the list of IP permissions to specify this information instead.
void	setFromPort(Integer fromPort) Deprecated - use the list of IP permissions to specify this information instead.
void	setGroupName(String groupName) Name of the group to modify.
void	setIpPermissions(Collection<IpPermission> ipPermissions) List of IP permissions to authorize on the specified security group.
void	setIpProtocol(String ipProtocol) Deprecated - use the list of IP permissions to specify this information instead.
void	setSourceSecurityGroupName(String sourceSecurityGroupName) Deprecated - use the list of IP permissions to specify this information instead.
void	setSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId) Deprecated - use the list of IP permissions to specify this information instead.
void	setToPort(Integer toPort) Deprecated - use the list of IP permissions to specify this information instead.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AuthorizeSecurityGroupIngressRequest	withCidrIp(String cidrIp) Deprecated - use the list of IP permissions to specify this information instead.
AuthorizeSecurityGroupIngressRequest	withFromPort(Integer fromPort) Deprecated - use the list of IP permissions to specify this information instead.
AuthorizeSecurityGroupIngressRequest	withGroupName(String groupName) Name of the group to modify.
AuthorizeSecurityGroupIngressRequest	withIpPermissions(Collection<IpPermission> ipPermissions) List of IP permissions to authorize on the specified security group.
AuthorizeSecurityGroupIngressRequest	withIpPermissions(IpPermission... ipPermissions) List of IP permissions to authorize on the specified security group.
AuthorizeSecurityGroupIngressRequest	withIpProtocol(String ipProtocol) Deprecated - use the list of IP permissions to specify this information instead.
AuthorizeSecurityGroupIngressRequest	withSourceSecurityGroupName(String sourceSecurityGroupName) Deprecated - use the list of IP permissions to specify this information instead.
AuthorizeSecurityGroupIngressRequest	withSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId) Deprecated - use the list of IP permissions to specify this information instead.
AuthorizeSecurityGroupIngressRequest	withToPort(Integer toPort) Deprecated - use the list of IP permissions to specify this information instead.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters

Methods inherited from class java.lang.Object

equals, getClass, hashCode, 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 - Name of the group to modify. The name must be valid and belong to the account.

ipPermissions - List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

Method Detail

getGroupName

public String getGroupName()

Name of the group to modify. The name must be valid and belong to the account.

Returns:

Name of the group to modify. The name must be valid and belong to the account.

setGroupName

public void setGroupName(String groupName)

Name of the group to modify. The name must be valid and belong to the account.

Parameters:

groupName - Name of the group to modify. The name must be valid and belong to the account.

withGroupName

public AuthorizeSecurityGroupIngressRequest withGroupName(String groupName)

Name of the group to modify. The name must be valid and belong to the account.

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

Parameters:

groupName - Name of the group to modify. The name must be valid and belong to the account.

Returns:

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

getSourceSecurityGroupName

public String getSourceSecurityGroupName()

Deprecated - use the list of IP permissions to specify this information instead.

Name of the security group. Cannot be used when specifying a CIDR IP address.

Returns:

Deprecated - use the list of IP permissions to specify this information instead.

Name of the security group. Cannot be used when specifying a CIDR IP address.

setSourceSecurityGroupName

public void setSourceSecurityGroupName(String sourceSecurityGroupName)

Deprecated - use the list of IP permissions to specify this information instead.

Name of the security group. Cannot be used when specifying a CIDR IP address.

Parameters:

sourceSecurityGroupName - Deprecated - use the list of IP permissions to specify this information instead.

Name of the security group. Cannot be used when specifying a CIDR IP address.

withSourceSecurityGroupName

public AuthorizeSecurityGroupIngressRequest withSourceSecurityGroupName(String sourceSecurityGroupName)

Deprecated - use the list of IP permissions to specify this information instead.

Name of the security group. Cannot be used when specifying a CIDR IP address.

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

Parameters:

sourceSecurityGroupName - Deprecated - use the list of IP permissions to specify this information instead.

Name of the security group. Cannot be used when specifying a CIDR IP address.

Returns:

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

getSourceSecurityGroupOwnerId

public String getSourceSecurityGroupOwnerId()

Deprecated - use the list of IP permissions to specify this information instead.

AWS user ID of an account. Cannot be used when specifying a CIDR IP address.

Returns:

Deprecated - use the list of IP permissions to specify this information instead.

AWS user ID of an account. Cannot be used when specifying a CIDR IP address.

setSourceSecurityGroupOwnerId

public void setSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)

Deprecated - use the list of IP permissions to specify this information instead.

AWS user ID of an account. Cannot be used when specifying a CIDR IP address.

Parameters:

sourceSecurityGroupOwnerId - Deprecated - use the list of IP permissions to specify this information instead.

AWS user ID of an account. Cannot be used when specifying a CIDR IP address.

withSourceSecurityGroupOwnerId

public AuthorizeSecurityGroupIngressRequest withSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId)

Deprecated - use the list of IP permissions to specify this information instead.

AWS user ID of an account. Cannot be used when specifying a CIDR IP address.

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

Parameters:

sourceSecurityGroupOwnerId - Deprecated - use the list of IP permissions to specify this information instead.

AWS user ID of an account. Cannot be used when specifying a CIDR IP address.

Returns:

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

getIpProtocol

public String getIpProtocol()

Deprecated - use the list of IP permissions to specify this information instead.

IP protocol.

Returns:

Deprecated - use the list of IP permissions to specify this information instead.

IP protocol.

setIpProtocol

public void setIpProtocol(String ipProtocol)

Deprecated - use the list of IP permissions to specify this information instead.

IP protocol.

Parameters:

ipProtocol - Deprecated - use the list of IP permissions to specify this information instead.

IP protocol.

withIpProtocol

public AuthorizeSecurityGroupIngressRequest withIpProtocol(String ipProtocol)

Deprecated - use the list of IP permissions to specify this information instead.

IP protocol.

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

Parameters:

ipProtocol - Deprecated - use the list of IP permissions to specify this information instead.

IP protocol.

Returns:

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

getFromPort

public Integer getFromPort()

Deprecated - use the list of IP permissions to specify this information instead.

Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

Returns:

Deprecated - use the list of IP permissions to specify this information instead.

Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

setFromPort

public void setFromPort(Integer fromPort)

Deprecated - use the list of IP permissions to specify this information instead.

Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

Parameters:

fromPort - Deprecated - use the list of IP permissions to specify this information instead.

Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

withFromPort

public AuthorizeSecurityGroupIngressRequest withFromPort(Integer fromPort)

Deprecated - use the list of IP permissions to specify this information instead.

Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

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

Parameters:

fromPort - Deprecated - use the list of IP permissions to specify this information instead.

Start of port range for the TCP and UDP protocols, or an ICMP type number. An ICMP type number of -1 indicates a wildcard (i.e., any ICMP type number).

Returns:

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

getToPort

public Integer getToPort()

Deprecated - use the list of IP permissions to specify this information instead.

End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

Returns:

Deprecated - use the list of IP permissions to specify this information instead.

End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

setToPort

public void setToPort(Integer toPort)

Deprecated - use the list of IP permissions to specify this information instead.

End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

Parameters:

toPort - Deprecated - use the list of IP permissions to specify this information instead.

End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

withToPort

public AuthorizeSecurityGroupIngressRequest withToPort(Integer toPort)

Deprecated - use the list of IP permissions to specify this information instead.

End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

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

Parameters:

toPort - Deprecated - use the list of IP permissions to specify this information instead.

End of port range for the TCP and UDP protocols, or an ICMP code. An ICMP code of -1 indicates a wildcard (i.e., any ICMP code).

Returns:

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

getCidrIp

public String getCidrIp()

Deprecated - use the list of IP permissions to specify this information instead.

CIDR range.

Returns:

Deprecated - use the list of IP permissions to specify this information instead.

CIDR range.

setCidrIp

public void setCidrIp(String cidrIp)

Deprecated - use the list of IP permissions to specify this information instead.

CIDR range.

Parameters:

cidrIp - Deprecated - use the list of IP permissions to specify this information instead.

CIDR range.

withCidrIp

public AuthorizeSecurityGroupIngressRequest withCidrIp(String cidrIp)

Deprecated - use the list of IP permissions to specify this information instead.

CIDR range.

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

Parameters:

cidrIp - Deprecated - use the list of IP permissions to specify this information instead.

CIDR range.

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 authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

Returns:

List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

setIpPermissions

public void setIpPermissions(Collection<IpPermission> ipPermissions)

List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

Parameters:

ipPermissions - List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing permissions since it offers more flexibility and control.

withIpPermissions

public AuthorizeSecurityGroupIngressRequest withIpPermissions(IpPermission... ipPermissions)

List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing 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 authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing 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 AuthorizeSecurityGroupIngressRequest withIpPermissions(Collection<IpPermission> ipPermissions)

List of IP permissions to authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing 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 authorize on the specified security group. Specifying permissions through IP permissions is the preferred way of authorizing 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()