DescribeSecurityGroupsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeSecurityGroupsRequest>, Serializable
```
public class DescribeSecurityGroupsRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeSecurityGroupsRequest>
```
Container for the parameters to the DescribeSecurityGroups operation.
The DescribeSecurityGroups operation returns information about security groups that you own.

If you specify security group names, information about those security group is returned. Otherwise, information for all security group is returned. If you specify a group that does not exist, a fault is returned.

See Also:
AmazonEC2.describeSecurityGroups(DescribeSecurityGroupsRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeSecurityGroupsRequest()

Constructors
Constructor and Description
`DescribeSecurityGroupsRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Request<DescribeSecurityGroupsRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`List<Filter>`	`getFilters()` A list of filters used to match properties for SecurityGroups.
`List<String>`	`getGroupIds()` Returns the value of the GroupIds property for this object.
`List<String>`	`getGroupNames()` An optional list of group names that specify the Amazon EC2 security groups to describe.
`int`	`hashCode()`
`void`	`setFilters(Collection<Filter> filters)` A list of filters used to match properties for SecurityGroups.
`void`	`setGroupIds(Collection<String> groupIds)` Sets the value of the GroupIds property for this object.
`void`	`setGroupNames(Collection<String> groupNames)` An optional list of group names that specify the Amazon EC2 security groups to describe.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeSecurityGroupsRequest`	`withFilters(Collection<Filter> filters)` A list of filters used to match properties for SecurityGroups.
`DescribeSecurityGroupsRequest`	`withFilters(Filter... filters)` A list of filters used to match properties for SecurityGroups.
`DescribeSecurityGroupsRequest`	`withGroupIds(Collection<String> groupIds)` Sets the value of the GroupIds property for this object.
`DescribeSecurityGroupsRequest`	`withGroupIds(String... groupIds)` Sets the value of the GroupIds property for this object.
`DescribeSecurityGroupsRequest`	`withGroupNames(Collection<String> groupNames)` An optional list of group names that specify the Amazon EC2 security groups to describe.
`DescribeSecurityGroupsRequest`	`withGroupNames(String... groupNames)` An optional list of group names that specify the Amazon EC2 security groups to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeSecurityGroupsRequest
```
public DescribeSecurityGroupsRequest()
```
- Method Detail
  - getGroupNames
```
public List<String> getGroupNames()
```
    An optional list of group names that specify the Amazon EC2 security groups to describe.
    
    Returns:
    An optional list of group names that specify the Amazon EC2 security groups to describe.
  - setGroupNames
```
public void setGroupNames(Collection<String> groupNames)
```
    An optional list of group names that specify the Amazon EC2 security groups to describe.
    
    Parameters:
    groupNames - An optional list of group names that specify the Amazon EC2 security groups to describe.
  - withGroupNames
```
public DescribeSecurityGroupsRequest withGroupNames(String... groupNames)
```
    An optional list of group names that specify the Amazon EC2 security groups to describe.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    groupNames - An optional list of group names that specify the Amazon EC2 security groups to describe.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withGroupNames
```
public DescribeSecurityGroupsRequest withGroupNames(Collection<String> groupNames)
```
    An optional list of group names that specify the Amazon EC2 security groups to describe.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    groupNames - An optional list of group names that specify the Amazon EC2 security groups to describe.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getGroupIds
```
public List<String> getGroupIds()
```
    Returns the value of the GroupIds property for this object.
    
    Returns:
    The value of the GroupIds property for this object.
  - setGroupIds
```
public void setGroupIds(Collection<String> groupIds)
```
    Sets the value of the GroupIds property for this object.
    
    Parameters:
    groupIds - The new value for the GroupIds property for this object.
  - withGroupIds
```
public DescribeSecurityGroupsRequest withGroupIds(String... groupIds)
```
    Sets the value of the GroupIds property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    groupIds - The new value for the GroupIds property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withGroupIds
```
public DescribeSecurityGroupsRequest withGroupIds(Collection<String> groupIds)
```
    Sets the value of the GroupIds property for this object.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    groupIds - The new value for the GroupIds property for this object.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getFilters
```
public List<Filter> getFilters()
```
    A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Returns:
    A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
  - setFilters
```
public void setFilters(Collection<Filter> filters)
```
    A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Parameters:
    filters - A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
  - withFilters
```
public DescribeSecurityGroupsRequest withFilters(Filter... filters)
```
    A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    filters - A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withFilters
```
public DescribeSecurityGroupsRequest withFilters(Collection<Filter> filters)
```
    A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    filters - A list of filters used to match properties for SecurityGroups. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDryRunRequest
```
public Request<DescribeSecurityGroupsRequest> getDryRunRequest()
```
    This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.
    
    Specified by:
    
    getDryRunRequest in interface DryRunSupportedRequest<DescribeSecurityGroupsRequest>
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class DescribeSecurityGroupsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeSecurityGroupsRequest

Method Detail

getGroupNames

setGroupNames

withGroupNames

withGroupNames

getGroupIds

setGroupIds

withGroupIds

withGroupIds

getFilters

setFilters

withFilters

withFilters

getDryRunRequest

toString

hashCode

equals