com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2011 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest) 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 com.amazonaws.services.ec2.AmazonEC2#authorizeSecurityGroupIngress(AuthorizeSecurityGroupIngressRequest)
*/
public class AuthorizeSecurityGroupIngressRequest extends AmazonWebServiceRequest {
/**
* Name of the group to modify. The name must be valid and belong to the
* account.
*/
private String groupName;
/**
* 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.
*/
private String sourceSecurityGroupName;
/**
* 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.
*/
private String sourceSecurityGroupOwnerId;
/**
* Deprecated - use the list of IP permissions to specify this
* information instead.
IP protocol.
*/
private String ipProtocol;
/**
* 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).
*/
private Integer fromPort;
/**
* 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).
*/
private Integer toPort;
/**
* Deprecated - use the list of IP permissions to specify this
* information instead.
CIDR range.
*/
private String cidrIp;
/**
* 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.
*/
private java.util.List ipPermissions;
/**
* Default constructor for a new AuthorizeSecurityGroupIngressRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public AuthorizeSecurityGroupIngressRequest() {}
/**
* Constructs a new AuthorizeSecurityGroupIngressRequest object.
* Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param groupName Name of the group to modify. The name must be valid
* and belong to the account.
* @param 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.
*/
public AuthorizeSecurityGroupIngressRequest(String groupName, java.util.List ipPermissions) {
this.groupName = groupName;
this.ipPermissions = ipPermissions;
}
/**
* Name of the group to modify. The name must be valid and belong to the
* account.
*
* @return Name of the group to modify. The name must be valid and belong to the
* account.
*/
public String getGroupName() {
return groupName;
}
/**
* Name of the group to modify. The name must be valid and belong to the
* account.
*
* @param groupName Name of the group to modify. The name must be valid and belong to the
* account.
*/
public void setGroupName(String groupName) {
this.groupName = 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.
*
* @param groupName Name of the group to modify. The name must be valid and belong to the
* account.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AuthorizeSecurityGroupIngressRequest withGroupName(String groupName) {
this.groupName = groupName;
return this;
}
/**
* 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.
*
* @return 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.
*/
public String getSourceSecurityGroupName() {
return 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.
*
* @param 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.
*/
public void setSourceSecurityGroupName(String sourceSecurityGroupName) {
this.sourceSecurityGroupName = 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AuthorizeSecurityGroupIngressRequest withSourceSecurityGroupName(String sourceSecurityGroupName) {
this.sourceSecurityGroupName = sourceSecurityGroupName;
return this;
}
/**
* 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.
*
* @return 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.
*/
public String getSourceSecurityGroupOwnerId() {
return 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.
*
* @param 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.
*/
public void setSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId) {
this.sourceSecurityGroupOwnerId = 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AuthorizeSecurityGroupIngressRequest withSourceSecurityGroupOwnerId(String sourceSecurityGroupOwnerId) {
this.sourceSecurityGroupOwnerId = sourceSecurityGroupOwnerId;
return this;
}
/**
* Deprecated - use the list of IP permissions to specify this
* information instead.
IP protocol.
*
* @return Deprecated - use the list of IP permissions to specify this
* information instead.
IP protocol.
*/
public String getIpProtocol() {
return ipProtocol;
}
/**
* Deprecated - use the list of IP permissions to specify this
* information instead.
IP protocol.
*
* @param ipProtocol Deprecated - use the list of IP permissions to specify this
* information instead.
IP protocol.
*/
public void setIpProtocol(String ipProtocol) {
this.ipProtocol = 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.
*
* @param ipProtocol Deprecated - use the list of IP permissions to specify this
* information instead.
IP protocol.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AuthorizeSecurityGroupIngressRequest withIpProtocol(String ipProtocol) {
this.ipProtocol = ipProtocol;
return this;
}
/**
* 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).
*
* @return 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).
*/
public Integer getFromPort() {
return 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).
*
* @param 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).
*/
public void setFromPort(Integer fromPort) {
this.fromPort = 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.
*
* @param 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).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AuthorizeSecurityGroupIngressRequest withFromPort(Integer fromPort) {
this.fromPort = fromPort;
return this;
}
/**
* 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).
*
* @return 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).
*/
public Integer getToPort() {
return 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).
*
* @param 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).
*/
public void setToPort(Integer toPort) {
this.toPort = 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.
*
* @param 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).
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AuthorizeSecurityGroupIngressRequest withToPort(Integer toPort) {
this.toPort = toPort;
return this;
}
/**
* Deprecated - use the list of IP permissions to specify this
* information instead.
CIDR range.
*
* @return Deprecated - use the list of IP permissions to specify this
* information instead.
CIDR range.
*/
public String getCidrIp() {
return cidrIp;
}
/**
* Deprecated - use the list of IP permissions to specify this
* information instead.
CIDR range.
*
* @param cidrIp Deprecated - use the list of IP permissions to specify this
* information instead.
CIDR range.
*/
public void setCidrIp(String cidrIp) {
this.cidrIp = 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.
*
* @param cidrIp Deprecated - use the list of IP permissions to specify this
* information instead.
CIDR range.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AuthorizeSecurityGroupIngressRequest withCidrIp(String cidrIp) {
this.cidrIp = cidrIp;
return this;
}
/**
* 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.
*
* @return 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.
*/
public java.util.List getIpPermissions() {
if (ipPermissions == null) {
ipPermissions = new java.util.ArrayList();
}
return 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.
*
* @param 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.
*/
public void setIpPermissions(java.util.Collection ipPermissions) {
java.util.List ipPermissionsCopy = new java.util.ArrayList();
if (ipPermissions != null) {
ipPermissionsCopy.addAll(ipPermissions);
}
this.ipPermissions = ipPermissionsCopy;
}
/**
* 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AuthorizeSecurityGroupIngressRequest withIpPermissions(IpPermission... ipPermissions) {
for (IpPermission value : ipPermissions) {
getIpPermissions().add(value);
}
return this;
}
/**
* 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.
*
* @param 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public AuthorizeSecurityGroupIngressRequest withIpPermissions(java.util.Collection ipPermissions) {
java.util.List ipPermissionsCopy = new java.util.ArrayList();
if (ipPermissions != null) {
ipPermissionsCopy.addAll(ipPermissions);
}
this.ipPermissions = ipPermissionsCopy;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
sb.append("GroupName: " + groupName + ", ");
sb.append("SourceSecurityGroupName: " + sourceSecurityGroupName + ", ");
sb.append("SourceSecurityGroupOwnerId: " + sourceSecurityGroupOwnerId + ", ");
sb.append("IpProtocol: " + ipProtocol + ", ");
sb.append("FromPort: " + fromPort + ", ");
sb.append("ToPort: " + toPort + ", ");
sb.append("CidrIp: " + cidrIp + ", ");
sb.append("IpPermissions: " + ipPermissions + ", ");
sb.append("}");
return sb.toString();
}
}