com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeSecurityGroupsRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The 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.cidr - An IPv4 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP
* protocols, or an ICMP type number.
*
*
* -
*
* egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound
* security group rule.
*
*
* -
*
* egress.ip-permission.group-name - The name of a security group that is referenced in an outbound
* security group rule.
*
*
* -
*
* egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows
* outbound access.
*
*
* -
*
* egress.ip-permission.protocol - The IP protocol for an outbound security group rule (
* tcp | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP
* protocols, or an ICMP code.
*
*
* -
*
* egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in
* an outbound security group rule.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.from-port - For an inbound rule, 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 referenced in an inbound security
* group rule.
*
*
* -
*
* ip-permission.group-name - The name of a security group that is referenced in an inbound security
* group rule.
*
*
* -
*
* ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows
* inbound access.
*
*
* -
*
* ip-permission.protocol - The IP protocol for an inbound security group rule (tcp |
* udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or
* an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an
* inbound security group rule.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner of the security group.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the security group was created.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The IDs of the security groups. Required for security groups in a nondefault VPC.
*
*
* Default: Describes all of your security groups.
*
*/
private com.amazonaws.internal.SdkInternalList groupIds;
/**
*
* [Default VPC] The names of the security groups. You can specify either the security group name or the security
* group ID.
*
*
* Default: Describes all of your security groups.
*
*/
private com.amazonaws.internal.SdkInternalList groupNames;
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*/
private String nextToken;
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then
* all items are returned. For more information, see Pagination.
*
*/
private Integer maxResults;
/**
*
* The 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.cidr - An IPv4 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP
* protocols, or an ICMP type number.
*
*
* -
*
* egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound
* security group rule.
*
*
* -
*
* egress.ip-permission.group-name - The name of a security group that is referenced in an outbound
* security group rule.
*
*
* -
*
* egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows
* outbound access.
*
*
* -
*
* egress.ip-permission.protocol - The IP protocol for an outbound security group rule (
* tcp | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP
* protocols, or an ICMP code.
*
*
* -
*
* egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in
* an outbound security group rule.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.from-port - For an inbound rule, 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 referenced in an inbound security
* group rule.
*
*
* -
*
* ip-permission.group-name - The name of a security group that is referenced in an inbound security
* group rule.
*
*
* -
*
* ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows
* inbound access.
*
*
* -
*
* ip-permission.protocol - The IP protocol for an inbound security group rule (tcp |
* udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or
* an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an
* inbound security group rule.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner of the security group.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the security group was created.
*
*
*
*
* @return The 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.cidr - An IPv4 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP
* and UDP protocols, or an ICMP type number.
*
*
* -
*
* egress.ip-permission.group-id - The ID of a security group that has been referenced in an
* outbound security group rule.
*
*
* -
*
* egress.ip-permission.group-name - The name of a security group that is referenced in an
* outbound security group rule.
*
*
* -
*
* egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule
* allows outbound access.
*
*
* -
*
* egress.ip-permission.protocol - The IP protocol for an outbound security group rule (
* tcp | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and
* UDP protocols, or an ICMP code.
*
*
* -
*
* egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been
* referenced in an outbound security group rule.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.from-port - For an inbound rule, 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 referenced in an inbound
* security group rule.
*
*
* -
*
* ip-permission.group-name - The name of a security group that is referenced in an inbound
* security group rule.
*
*
* -
*
* ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule
* allows inbound access.
*
*
* -
*
* ip-permission.protocol - The IP protocol for an inbound security group rule (
* tcp | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP
* protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in
* an inbound security group rule.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner of the security group.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that
* have a tag with the key Owner and the value TeamA, specify
* tag:Owner for the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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;
}
/**
*
* The 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.cidr - An IPv4 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP
* protocols, or an ICMP type number.
*
*
* -
*
* egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound
* security group rule.
*
*
* -
*
* egress.ip-permission.group-name - The name of a security group that is referenced in an outbound
* security group rule.
*
*
* -
*
* egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows
* outbound access.
*
*
* -
*
* egress.ip-permission.protocol - The IP protocol for an outbound security group rule (
* tcp | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP
* protocols, or an ICMP code.
*
*
* -
*
* egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in
* an outbound security group rule.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.from-port - For an inbound rule, 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 referenced in an inbound security
* group rule.
*
*
* -
*
* ip-permission.group-name - The name of a security group that is referenced in an inbound security
* group rule.
*
*
* -
*
* ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows
* inbound access.
*
*
* -
*
* ip-permission.protocol - The IP protocol for an inbound security group rule (tcp |
* udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or
* an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an
* inbound security group rule.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner of the security group.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the security group was created.
*
*
*
*
* @param filters
* The 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.cidr - An IPv4 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP
* and UDP protocols, or an ICMP type number.
*
*
* -
*
* egress.ip-permission.group-id - The ID of a security group that has been referenced in an
* outbound security group rule.
*
*
* -
*
* egress.ip-permission.group-name - The name of a security group that is referenced in an
* outbound security group rule.
*
*
* -
*
* egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule
* allows outbound access.
*
*
* -
*
* egress.ip-permission.protocol - The IP protocol for an outbound security group rule (
* tcp | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and
* UDP protocols, or an ICMP code.
*
*
* -
*
* egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been
* referenced in an outbound security group rule.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.from-port - For an inbound rule, 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 referenced in an inbound
* security group rule.
*
*
* -
*
* ip-permission.group-name - The name of a security group that is referenced in an inbound
* security group rule.
*
*
* -
*
* ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule
* allows inbound access.
*
*
* -
*
* ip-permission.protocol - The IP protocol for an inbound security group rule (tcp
* | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP
* protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in
* an inbound security group rule.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner of the security group.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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);
}
/**
*
* The 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.cidr - An IPv4 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP
* protocols, or an ICMP type number.
*
*
* -
*
* egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound
* security group rule.
*
*
* -
*
* egress.ip-permission.group-name - The name of a security group that is referenced in an outbound
* security group rule.
*
*
* -
*
* egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows
* outbound access.
*
*
* -
*
* egress.ip-permission.protocol - The IP protocol for an outbound security group rule (
* tcp | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP
* protocols, or an ICMP code.
*
*
* -
*
* egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in
* an outbound security group rule.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.from-port - For an inbound rule, 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 referenced in an inbound security
* group rule.
*
*
* -
*
* ip-permission.group-name - The name of a security group that is referenced in an inbound security
* group rule.
*
*
* -
*
* ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows
* inbound access.
*
*
* -
*
* ip-permission.protocol - The IP protocol for an inbound security group rule (tcp |
* udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or
* an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an
* inbound security group rule.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner of the security group.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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
* The 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.cidr - An IPv4 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP
* and UDP protocols, or an ICMP type number.
*
*
* -
*
* egress.ip-permission.group-id - The ID of a security group that has been referenced in an
* outbound security group rule.
*
*
* -
*
* egress.ip-permission.group-name - The name of a security group that is referenced in an
* outbound security group rule.
*
*
* -
*
* egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule
* allows outbound access.
*
*
* -
*
* egress.ip-permission.protocol - The IP protocol for an outbound security group rule (
* tcp | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and
* UDP protocols, or an ICMP code.
*
*
* -
*
* egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been
* referenced in an outbound security group rule.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.from-port - For an inbound rule, 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 referenced in an inbound
* security group rule.
*
*
* -
*
* ip-permission.group-name - The name of a security group that is referenced in an inbound
* security group rule.
*
*
* -
*
* ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule
* allows inbound access.
*
*
* -
*
* ip-permission.protocol - The IP protocol for an inbound security group rule (tcp
* | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP
* protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in
* an inbound security group rule.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner of the security group.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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;
}
/**
*
* The 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.cidr - An IPv4 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP
* protocols, or an ICMP type number.
*
*
* -
*
* egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound
* security group rule.
*
*
* -
*
* egress.ip-permission.group-name - The name of a security group that is referenced in an outbound
* security group rule.
*
*
* -
*
* egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows
* outbound access.
*
*
* -
*
* egress.ip-permission.protocol - The IP protocol for an outbound security group rule (
* tcp | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP
* protocols, or an ICMP code.
*
*
* -
*
* egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in
* an outbound security group rule.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.from-port - For an inbound rule, 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 referenced in an inbound security
* group rule.
*
*
* -
*
* ip-permission.group-name - The name of a security group that is referenced in an inbound security
* group rule.
*
*
* -
*
* ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows
* inbound access.
*
*
* -
*
* ip-permission.protocol - The IP protocol for an inbound security group rule (tcp |
* udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or
* an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an
* inbound security group rule.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner of the security group.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in
* the filter name and the tag value as the filter value. For example, to find all resources that have a tag with
* the key Owner and the value TeamA, specify tag:Owner for the filter name
* and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned
* a tag with a specific key, regardless of the tag value.
*
*
* -
*
* vpc-id - The ID of the VPC specified when the security group was created.
*
*
*
*
* @param filters
* The 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.cidr - An IPv4 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP
* and UDP protocols, or an ICMP type number.
*
*
* -
*
* egress.ip-permission.group-id - The ID of a security group that has been referenced in an
* outbound security group rule.
*
*
* -
*
* egress.ip-permission.group-name - The name of a security group that is referenced in an
* outbound security group rule.
*
*
* -
*
* egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
*
*
* -
*
* egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule
* allows outbound access.
*
*
* -
*
* egress.ip-permission.protocol - The IP protocol for an outbound security group rule (
* tcp | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and
* UDP protocols, or an ICMP code.
*
*
* -
*
* egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been
* referenced in an outbound security group rule.
*
*
* -
*
* group-id - The ID of the security group.
*
*
* -
*
* group-name - The name of the security group.
*
*
* -
*
* ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.from-port - For an inbound rule, 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 referenced in an inbound
* security group rule.
*
*
* -
*
* ip-permission.group-name - The name of a security group that is referenced in an inbound
* security group rule.
*
*
* -
*
* ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
*
*
* -
*
* ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule
* allows inbound access.
*
*
* -
*
* ip-permission.protocol - The IP protocol for an inbound security group rule (tcp
* | udp | icmp, a protocol number, or -1 for all protocols).
*
*
* -
*
* ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP
* protocols, or an ICMP code.
*
*
* -
*
* ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in
* an inbound security group rule.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the owner of the security group.
*
*
* -
*
* tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag
* key in the filter name and the tag value as the filter value. For example, to find all resources that have
* a tag with the key Owner and the value TeamA, specify tag:Owner for
* the filter name and TeamA for the filter value.
*
*
* -
*
* tag-key - The key of a tag assigned to the resource. Use this filter to find all resources
* assigned a tag with a specific key, regardless of the tag value.
*
*
* -
*
* 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;
}
/**
*
* The IDs of the security groups. Required for security groups in a nondefault VPC.
*
*
* Default: Describes all of your security groups.
*
*
* @return The IDs of the security groups. Required for security groups in a nondefault VPC.
*
* Default: Describes all of your security groups.
*/
public java.util.List getGroupIds() {
if (groupIds == null) {
groupIds = new com.amazonaws.internal.SdkInternalList();
}
return groupIds;
}
/**
*
* The IDs of the security groups. Required for security groups in a nondefault VPC.
*
*
* Default: Describes all of your security groups.
*
*
* @param groupIds
* The IDs of the security groups. Required for security groups in a nondefault VPC.
*
* Default: Describes all of 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);
}
/**
*
* The IDs of the security groups. Required for security groups in a nondefault VPC.
*
*
* Default: Describes all of 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
* The IDs of the security groups. Required for security groups in a nondefault VPC.
*
* Default: Describes all of 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;
}
/**
*
* The IDs of the security groups. Required for security groups in a nondefault VPC.
*
*
* Default: Describes all of your security groups.
*
*
* @param groupIds
* The IDs of the security groups. Required for security groups in a nondefault VPC.
*
* Default: Describes all of 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;
}
/**
*
* [Default VPC] The names of the security groups. You can specify either the security group name or the security
* group ID.
*
*
* Default: Describes all of your security groups.
*
*
* @return [Default VPC] The names of the security groups. You can specify either the security group name or the
* security group ID.
*
* Default: Describes all of your security groups.
*/
public java.util.List getGroupNames() {
if (groupNames == null) {
groupNames = new com.amazonaws.internal.SdkInternalList();
}
return groupNames;
}
/**
*
* [Default VPC] The names of the security groups. You can specify either the security group name or the security
* group ID.
*
*
* Default: Describes all of your security groups.
*
*
* @param groupNames
* [Default VPC] The names of the security groups. You can specify either the security group name or the
* security group ID.
*
* Default: Describes all of 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);
}
/**
*
* [Default VPC] The names of the security groups. You can specify either the security group name or the security
* group ID.
*
*
* Default: Describes all of 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
* [Default VPC] The names of the security groups. You can specify either the security group name or the
* security group ID.
*
* Default: Describes all of 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;
}
/**
*
* [Default VPC] The names of the security groups. You can specify either the security group name or the security
* group ID.
*
*
* Default: Describes all of your security groups.
*
*
* @param groupNames
* [Default VPC] The names of the security groups. You can specify either the security group name or the
* security group ID.
*
* Default: Describes all of 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;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @return The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSecurityGroupsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then
* all items are returned. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. This value can be between 5 and 1000. If this parameter is
* not specified, then all items are returned. For more information, see Pagination.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then
* all items are returned. For more information, see Pagination.
*
*
* @return The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. This value can be between 5 and 1000. If this parameter is
* not specified, then all items are returned. For more information, see Pagination.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then
* all items are returned. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. This value can be between 5 and 1000. If this parameter is
* not specified, then all items are returned. For more information, see Pagination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeSecurityGroupsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getGroupIds() != null)
sb.append("GroupIds: ").append(getGroupIds()).append(",");
if (getGroupNames() != null)
sb.append("GroupNames: ").append(getGroupNames()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
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.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == 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.getGroupNames() == null ^ this.getGroupNames() == null)
return false;
if (other.getGroupNames() != null && other.getGroupNames().equals(this.getGroupNames()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getGroupIds() == null) ? 0 : getGroupIds().hashCode());
hashCode = prime * hashCode + ((getGroupNames() == null) ? 0 : getGroupNames().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public DescribeSecurityGroupsRequest clone() {
return (DescribeSecurityGroupsRequest) super.clone();
}
}