/* * Copyright 2010-2018 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; /** * Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeSecurityGroups(DescribeSecurityGroupsRequest) DescribeSecurityGroups operation}. *
* Describes one or more of your security groups. *
** A security group is for use with instances either in the EC2-Classic * platform or in a specific VPC. For more information, see * Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC * in the Amazon Virtual Private Cloud User Guide . *
* * @see com.amazonaws.services.ec2.AmazonEC2#describeSecurityGroups(DescribeSecurityGroupsRequest) */ public class DescribeSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable, DryRunSupportedRequestgroup-name
filter to describe security groups by name.
* Default: Describes all your security groups.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag Default: Describes all your security groups.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag 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
* Default: Describes all your security groups.
*/
public java.util.List 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
* Default: Describes all your security groups.
*/
public void setGroupNames(java.util.Collection Default: Describes all your security groups.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @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
* Default: Describes all your security groups.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSecurityGroupsRequest withGroupNames(String... groupNames) {
if (getGroupNames() == null) setGroupNames(new java.util.ArrayList Default: Describes all your security groups.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @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
* Default: Describes all your security groups.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSecurityGroupsRequest withGroupNames(java.util.Collection 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 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 Default: Describes all your security groups.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param groupIds One or more security group IDs. Required for security groups in a
* nondefault VPC. Default: Describes all your security groups.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSecurityGroupsRequest withGroupIds(String... groupIds) {
if (getGroupIds() == null) setGroupIds(new java.util.ArrayList Default: Describes all your security groups.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param groupIds One or more security group IDs. Required for security groups in a
* nondefault VPC. Default: Describes all your security groups.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSecurityGroupsRequest withGroupIds(java.util.Collection
* Returns a reference to this object so that method calls can be chained together.
*
* @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.
* Returns a reference to this object so that method calls can be chained together.
*
* @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.
*/
private com.amazonaws.internal.ListWithAutoConstructFlagdescription
- 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. group-name
filter to describe security groups by name.
* group-name
filter to describe security groups by name.
* group-name
filter to describe security groups by name.
* group-name
filter to describe security groups by name.
* group-name
filter to describe security groups by name.
* group-name
filter to describe security groups by name.
* group-name
filter to describe security groups by name.
* group-name
filter to describe security groups by name.
*
*
* @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.Listdescription
- 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.Collectiondescription
- 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.
* 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 A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSecurityGroupsRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayListdescription
- 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.
* 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 A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSecurityGroupsRequest withFilters(java.util.Collectiondescription
- 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.