com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-2016 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 java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeSecurityGroupsRequestMarshaller;
/**
*
* Contains the parameters for DescribeSecurityGroups.
*
*/
public class DescribeSecurityGroupsRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* [EC2-Classic and default VPC only] One or more security group names. You
* can specify either the security group name or the security group ID. For
* security groups in a nondefault VPC, use the group-name
* filter to describe security groups by name.
*
*
* Default: Describes all your security groups.
*
*/
private com.amazonaws.internal.SdkInternalList groupNames;
/**
*
* One or more security group IDs. Required for security groups in a
* nondefault VPC.
*
*
* Default: Describes all your security groups.
*
*/
private com.amazonaws.internal.SdkInternalList groupIds;
/**
*
* One or more filters. If using multiple filters for rules, the results
* include security groups for which any combination of rules - not
* necessarily a single rule - match all filters.
*
*
* -
*
* description - The description of the security group.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID (prefix) of the
* AWS service to which the security group allows access.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - A CIDR range that has been granted
* permission.
*
*
* -
*
* ip-permission.from-port - The start of port range for the
* TCP and UDP protocols, or an ICMP type number.
*
*
* -
*
* ip-permission.group-id - The ID of a security group that has
* been granted permission.
*
*
* -
*
* ip-permission.group-name - The name of a security group that
* has been granted permission.
*
*
* -
*
* ip-permission.protocol - The IP protocol for the permission
* (tcp | udp | icmp or a protocol
* number).
*
*
* -
*
* ip-permission.to-port - The end of port range for the TCP
* and UDP protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an AWS account that has
* been granted permission.
*
*
* -
*
* owner-id - The AWS account ID of the owner of the security
* group.
*
*
* -
*
* tag-key - The key of a tag assigned to the security group.
*
*
* -
*
* tag-value - The value of a tag assigned to the security
* group.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the security group
* was created.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* [EC2-Classic and default VPC only] One or more security group names. You
* can specify either the security group name or the security group ID. For
* security groups in a nondefault VPC, use the group-name
* filter to describe security groups by name.
*
*
* Default: Describes all your security groups.
*
*
* @return [EC2-Classic and default VPC only] One or more security group
* names. You can specify either the security group name or the
* security group ID. For security groups in a nondefault VPC, use
* the group-name filter to describe security groups by
* name.
*
* Default: Describes all your security groups.
*/
public java.util.List getGroupNames() {
if (groupNames == null) {
groupNames = new com.amazonaws.internal.SdkInternalList();
}
return groupNames;
}
/**
*
* [EC2-Classic and default VPC only] One or more security group names. You
* can specify either the security group name or the security group ID. For
* security groups in a nondefault VPC, use the group-name
* filter to describe security groups by name.
*
*
* Default: Describes all your security groups.
*
*
* @param groupNames
* [EC2-Classic and default VPC only] One or more security group
* names. You can specify either the security group name or the
* security group ID. For security groups in a nondefault VPC, use
* the group-name filter to describe security groups by
* name.
*
* Default: Describes all your security groups.
*/
public void setGroupNames(java.util.Collection groupNames) {
if (groupNames == null) {
this.groupNames = null;
return;
}
this.groupNames = new com.amazonaws.internal.SdkInternalList(
groupNames);
}
/**
*
* [EC2-Classic and default VPC only] One or more security group names. You
* can specify either the security group name or the security group ID. For
* security groups in a nondefault VPC, use the group-name
* filter to describe security groups by name.
*
*
* Default: Describes all your security groups.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setGroupNames(java.util.Collection)} or
* {@link #withGroupNames(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param groupNames
* [EC2-Classic and default VPC only] One or more security group
* names. You can specify either the security group name or the
* security group ID. For security groups in a nondefault VPC, use
* the group-name filter to describe security groups by
* name.
*
* Default: Describes all your security groups.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSecurityGroupsRequest withGroupNames(String... groupNames) {
if (this.groupNames == null) {
setGroupNames(new com.amazonaws.internal.SdkInternalList(
groupNames.length));
}
for (String ele : groupNames) {
this.groupNames.add(ele);
}
return this;
}
/**
*
* [EC2-Classic and default VPC only] One or more security group names. You
* can specify either the security group name or the security group ID. For
* security groups in a nondefault VPC, use the group-name
* filter to describe security groups by name.
*
*
* Default: Describes all your security groups.
*
*
* @param groupNames
* [EC2-Classic and default VPC only] One or more security group
* names. You can specify either the security group name or the
* security group ID. For security groups in a nondefault VPC, use
* the group-name filter to describe security groups by
* name.
*
* Default: Describes all your security groups.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSecurityGroupsRequest withGroupNames(
java.util.Collection groupNames) {
setGroupNames(groupNames);
return this;
}
/**
*
* One or more security group IDs. Required for security groups in a
* nondefault VPC.
*
*
* Default: Describes all your security groups.
*
*
* @return One or more security group IDs. Required for security groups in a
* nondefault VPC.
*
* Default: Describes all your security groups.
*/
public java.util.List getGroupIds() {
if (groupIds == null) {
groupIds = new com.amazonaws.internal.SdkInternalList();
}
return groupIds;
}
/**
*
* One or more security group IDs. Required for security groups in a
* nondefault VPC.
*
*
* Default: Describes all your security groups.
*
*
* @param groupIds
* One or more security group IDs. Required for security groups in a
* nondefault VPC.
*
* Default: Describes all your security groups.
*/
public void setGroupIds(java.util.Collection groupIds) {
if (groupIds == null) {
this.groupIds = null;
return;
}
this.groupIds = new com.amazonaws.internal.SdkInternalList(
groupIds);
}
/**
*
* One or more security group IDs. Required for security groups in a
* nondefault VPC.
*
*
* Default: Describes all your security groups.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setGroupIds(java.util.Collection)} or
* {@link #withGroupIds(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param groupIds
* One or more security group IDs. Required for security groups in a
* nondefault VPC.
*
* Default: Describes all your security groups.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSecurityGroupsRequest withGroupIds(String... groupIds) {
if (this.groupIds == null) {
setGroupIds(new com.amazonaws.internal.SdkInternalList(
groupIds.length));
}
for (String ele : groupIds) {
this.groupIds.add(ele);
}
return this;
}
/**
*
* One or more security group IDs. Required for security groups in a
* nondefault VPC.
*
*
* Default: Describes all your security groups.
*
*
* @param groupIds
* One or more security group IDs. Required for security groups in a
* nondefault VPC.
*
* Default: Describes all your security groups.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSecurityGroupsRequest withGroupIds(
java.util.Collection groupIds) {
setGroupIds(groupIds);
return this;
}
/**
*
* One or more filters. If using multiple filters for rules, the results
* include security groups for which any combination of rules - not
* necessarily a single rule - match all filters.
*
*
* -
*
* description - The description of the security group.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID (prefix) of the
* AWS service to which the security group allows access.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - A CIDR range that has been granted
* permission.
*
*
* -
*
* ip-permission.from-port - The start of port range for the
* TCP and UDP protocols, or an ICMP type number.
*
*
* -
*
* ip-permission.group-id - The ID of a security group that has
* been granted permission.
*
*
* -
*
* ip-permission.group-name - The name of a security group that
* has been granted permission.
*
*
* -
*
* ip-permission.protocol - The IP protocol for the permission
* (tcp | udp | icmp or a protocol
* number).
*
*
* -
*
* ip-permission.to-port - The end of port range for the TCP
* and UDP protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an AWS account that has
* been granted permission.
*
*
* -
*
* owner-id - The AWS account ID of the owner of the security
* group.
*
*
* -
*
* tag-key - The key of a tag assigned to the security group.
*
*
* -
*
* tag-value - The value of a tag assigned to the security
* group.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the security group
* was created.
*
*
*
*
* @return One or more filters. If using multiple filters for rules, the
* results include security groups for which any combination of
* rules - not necessarily a single rule - match all filters.
*
* -
*
* description - The description of the security group.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID
* (prefix) of the AWS service to which the security group allows
* access.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - A CIDR range that has been
* granted permission.
*
*
* -
*
* ip-permission.from-port - The start of port range
* for the TCP and UDP protocols, or an ICMP type number.
*
*
* -
*
* ip-permission.group-id - The ID of a security group
* that has been granted permission.
*
*
* -
*
* ip-permission.group-name - The name of a security
* group that has been granted permission.
*
*
* -
*
* ip-permission.protocol - The IP protocol for the
* permission (tcp | udp |
* icmp or a protocol number).
*
*
* -
*
* ip-permission.to-port - The end of port range for
* the TCP and UDP protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an AWS account
* that has been granted permission.
*
*
* -
*
* owner-id - The AWS account ID of the owner of the
* security group.
*
*
* -
*
* tag-key - The key of a tag assigned to the security
* group.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* security group.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the
* security group was created.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters. If using multiple filters for rules, the results
* include security groups for which any combination of rules - not
* necessarily a single rule - match all filters.
*
*
* -
*
* description - The description of the security group.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID (prefix) of the
* AWS service to which the security group allows access.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - A CIDR range that has been granted
* permission.
*
*
* -
*
* ip-permission.from-port - The start of port range for the
* TCP and UDP protocols, or an ICMP type number.
*
*
* -
*
* ip-permission.group-id - The ID of a security group that has
* been granted permission.
*
*
* -
*
* ip-permission.group-name - The name of a security group that
* has been granted permission.
*
*
* -
*
* ip-permission.protocol - The IP protocol for the permission
* (tcp | udp | icmp or a protocol
* number).
*
*
* -
*
* ip-permission.to-port - The end of port range for the TCP
* and UDP protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an AWS account that has
* been granted permission.
*
*
* -
*
* owner-id - The AWS account ID of the owner of the security
* group.
*
*
* -
*
* tag-key - The key of a tag assigned to the security group.
*
*
* -
*
* tag-value - The value of a tag assigned to the security
* group.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the security group
* was created.
*
*
*
*
* @param filters
* One or more filters. If using multiple filters for rules, the
* results include security groups for which any combination of rules
* - not necessarily a single rule - match all filters.
*
* -
*
* description - The description of the security group.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID (prefix)
* of the AWS service to which the security group allows access.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - A CIDR range that has been
* granted permission.
*
*
* -
*
* ip-permission.from-port - The start of port range for
* the TCP and UDP protocols, or an ICMP type number.
*
*
* -
*
* ip-permission.group-id - The ID of a security group
* that has been granted permission.
*
*
* -
*
* ip-permission.group-name - The name of a security
* group that has been granted permission.
*
*
* -
*
* ip-permission.protocol - The IP protocol for the
* permission (tcp | udp |
* icmp or a protocol number).
*
*
* -
*
* ip-permission.to-port - The end of port range for the
* TCP and UDP protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an AWS account that
* has been granted permission.
*
*
* -
*
* owner-id - The AWS account ID of the owner of the
* security group.
*
*
* -
*
* tag-key - The key of a tag assigned to the security
* group.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* security group.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the
* security group was created.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(
filters);
}
/**
*
* One or more filters. If using multiple filters for rules, the results
* include security groups for which any combination of rules - not
* necessarily a single rule - match all filters.
*
*
* -
*
* description - The description of the security group.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID (prefix) of the
* AWS service to which the security group allows access.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - A CIDR range that has been granted
* permission.
*
*
* -
*
* ip-permission.from-port - The start of port range for the
* TCP and UDP protocols, or an ICMP type number.
*
*
* -
*
* ip-permission.group-id - The ID of a security group that has
* been granted permission.
*
*
* -
*
* ip-permission.group-name - The name of a security group that
* has been granted permission.
*
*
* -
*
* ip-permission.protocol - The IP protocol for the permission
* (tcp | udp | icmp or a protocol
* number).
*
*
* -
*
* ip-permission.to-port - The end of port range for the TCP
* and UDP protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an AWS account that has
* been granted permission.
*
*
* -
*
* owner-id - The AWS account ID of the owner of the security
* group.
*
*
* -
*
* tag-key - The key of a tag assigned to the security group.
*
*
* -
*
* tag-value - The value of a tag assigned to the security
* group.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the security group
* was created.
*
*
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setFilters(java.util.Collection)} or
* {@link #withFilters(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param filters
* One or more filters. If using multiple filters for rules, the
* results include security groups for which any combination of rules
* - not necessarily a single rule - match all filters.
*
* -
*
* description - The description of the security group.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID (prefix)
* of the AWS service to which the security group allows access.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - A CIDR range that has been
* granted permission.
*
*
* -
*
* ip-permission.from-port - The start of port range for
* the TCP and UDP protocols, or an ICMP type number.
*
*
* -
*
* ip-permission.group-id - The ID of a security group
* that has been granted permission.
*
*
* -
*
* ip-permission.group-name - The name of a security
* group that has been granted permission.
*
*
* -
*
* ip-permission.protocol - The IP protocol for the
* permission (tcp | udp |
* icmp or a protocol number).
*
*
* -
*
* ip-permission.to-port - The end of port range for the
* TCP and UDP protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an AWS account that
* has been granted permission.
*
*
* -
*
* owner-id - The AWS account ID of the owner of the
* security group.
*
*
* -
*
* tag-key - The key of a tag assigned to the security
* group.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* security group.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the
* security group was created.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSecurityGroupsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(
filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* One or more filters. If using multiple filters for rules, the results
* include security groups for which any combination of rules - not
* necessarily a single rule - match all filters.
*
*
* -
*
* description - The description of the security group.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID (prefix) of the
* AWS service to which the security group allows access.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - A CIDR range that has been granted
* permission.
*
*
* -
*
* ip-permission.from-port - The start of port range for the
* TCP and UDP protocols, or an ICMP type number.
*
*
* -
*
* ip-permission.group-id - The ID of a security group that has
* been granted permission.
*
*
* -
*
* ip-permission.group-name - The name of a security group that
* has been granted permission.
*
*
* -
*
* ip-permission.protocol - The IP protocol for the permission
* (tcp | udp | icmp or a protocol
* number).
*
*
* -
*
* ip-permission.to-port - The end of port range for the TCP
* and UDP protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an AWS account that has
* been granted permission.
*
*
* -
*
* owner-id - The AWS account ID of the owner of the security
* group.
*
*
* -
*
* tag-key - The key of a tag assigned to the security group.
*
*
* -
*
* tag-value - The value of a tag assigned to the security
* group.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the security group
* was created.
*
*
*
*
* @param filters
* One or more filters. If using multiple filters for rules, the
* results include security groups for which any combination of rules
* - not necessarily a single rule - match all filters.
*
* -
*
* description - The description of the security group.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID (prefix)
* of the AWS service to which the security group allows access.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - A CIDR range that has been
* granted permission.
*
*
* -
*
* ip-permission.from-port - The start of port range for
* the TCP and UDP protocols, or an ICMP type number.
*
*
* -
*
* ip-permission.group-id - The ID of a security group
* that has been granted permission.
*
*
* -
*
* ip-permission.group-name - The name of a security
* group that has been granted permission.
*
*
* -
*
* ip-permission.protocol - The IP protocol for the
* permission (tcp | udp |
* icmp or a protocol number).
*
*
* -
*
* ip-permission.to-port - The end of port range for the
* TCP and UDP protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an AWS account that
* has been granted permission.
*
*
* -
*
* owner-id - The AWS account ID of the owner of the
* security group.
*
*
* -
*
* tag-key - The key of a tag assigned to the security
* group.
*
*
* -
*
* tag-value - The value of a tag assigned to the
* security group.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the
* security group was created.
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeSecurityGroupsRequest withFilters(
java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled
* request configured with additional parameters to enable operation
* dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribeSecurityGroupsRequestMarshaller()
.marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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("{");
if (getGroupNames() != null)
sb.append("GroupNames: " + getGroupNames() + ",");
if (getGroupIds() != null)
sb.append("GroupIds: " + getGroupIds() + ",");
if (getFilters() != null)
sb.append("Filters: " + getFilters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeSecurityGroupsRequest == false)
return false;
DescribeSecurityGroupsRequest other = (DescribeSecurityGroupsRequest) obj;
if (other.getGroupNames() == null ^ this.getGroupNames() == null)
return false;
if (other.getGroupNames() != null
&& other.getGroupNames().equals(this.getGroupNames()) == false)
return false;
if (other.getGroupIds() == null ^ this.getGroupIds() == null)
return false;
if (other.getGroupIds() != null
&& other.getGroupIds().equals(this.getGroupIds()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null
&& other.getFilters().equals(this.getFilters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getGroupNames() == null) ? 0 : getGroupNames().hashCode());
hashCode = prime * hashCode
+ ((getGroupIds() == null) ? 0 : getGroupIds().hashCode());
hashCode = prime * hashCode
+ ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public DescribeSecurityGroupsRequest clone() {
return (DescribeSecurityGroupsRequest) super.clone();
}
}