com.amazonaws.services.ec2.model

Class DescribeSecurityGroupsRequest

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.

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 Also:

AmazonEC2.describeSecurityGroups(DescribeSecurityGroupsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

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() One or more filters.
List<String>	getGroupIds() One or more security group IDs.
List<String>	getGroupNames() [EC2-Classic, default VPC] One or more security group names.
int	hashCode()
void	setFilters(Collection<Filter> filters) One or more filters.
void	setGroupIds(Collection<String> groupIds) One or more security group IDs.
void	setGroupNames(Collection<String> groupNames) [EC2-Classic, default VPC] One or more security group names.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeSecurityGroupsRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeSecurityGroupsRequest	withFilters(Filter... filters) One or more filters.
DescribeSecurityGroupsRequest	withGroupIds(Collection<String> groupIds) One or more security group IDs.
DescribeSecurityGroupsRequest	withGroupIds(String... groupIds) One or more security group IDs.
DescribeSecurityGroupsRequest	withGroupNames(Collection<String> groupNames) [EC2-Classic, default VPC] One or more security group names.
DescribeSecurityGroupsRequest	withGroupNames(String... groupNames) [EC2-Classic, default VPC] One or more security group names.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSecurityGroupsRequest

public DescribeSecurityGroupsRequest()

Method Detail

getGroupNames

public List<String> getGroupNames()

[EC2-Classic, default VPC] One or more security group names.

Default: Describes all your security groups.

Returns:

[EC2-Classic, default VPC] One or more security group names.

Default: Describes all your security groups.

setGroupNames

public void setGroupNames(Collection<String> groupNames)

[EC2-Classic, default VPC] One or more security group names.

Default: Describes all your security groups.

Parameters:

groupNames - [EC2-Classic, default VPC] One or more security group names.

Default: Describes all your security groups.

withGroupNames

public DescribeSecurityGroupsRequest withGroupNames(String... groupNames)

[EC2-Classic, default VPC] One or more security group names.

Default: Describes all your security groups.

Returns a reference to this object so that method calls can be chained together.

Parameters:

groupNames - [EC2-Classic, default VPC] One or more security group names.

Default: Describes all your security groups.

Returns:

A reference to this updated object so that method calls can be chained together.

withGroupNames

public DescribeSecurityGroupsRequest withGroupNames(Collection<String> groupNames)

[EC2-Classic, default VPC] One or more security group names.

Default: Describes all your security groups.

Returns a reference to this object so that method calls can be chained together.

Parameters:

groupNames - [EC2-Classic, default VPC] One or more security group names.

Default: Describes all your security groups.

Returns:

A reference to this updated object so that method calls can be chained together.

getGroupIds

public List<String> getGroupIds()

One or more security group IDs.

Default: Describes all your security groups.

Returns:

One or more security group IDs.

Default: Describes all your security groups.

setGroupIds

public void setGroupIds(Collection<String> groupIds)

One or more security group IDs.

Default: Describes all your security groups.

Parameters:

groupIds - One or more security group IDs.

Default: Describes all your security groups.

withGroupIds

public DescribeSecurityGroupsRequest withGroupIds(String... groupIds)

One or more security group IDs.

Default: Describes all your security groups.

Returns a reference to this object so that method calls can be chained together.

Parameters:

groupIds - One or more security group IDs.

Default: Describes all your security groups.

Returns:

A reference to this updated object so that method calls can be chained together.

withGroupIds

public DescribeSecurityGroupsRequest withGroupIds(Collection<String> groupIds)

One or more security group IDs.

Default: Describes all your security groups.

Returns a reference to this object so that method calls can be chained together.

Parameters:

groupIds - One or more security group IDs.

Default: Describes all your security groups.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

One or more filters.

• description - The description of the security group.

• 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.

Returns:

One or more filters.

• description - The description of the security group.

• 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.

setFilters

public void setFilters(Collection<Filter> filters)

One or more filters.

• description - The description of the security group.

• 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.

Parameters:

filters - One or more filters.

• description - The description of the security group.

• 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.

withFilters

public DescribeSecurityGroupsRequest withFilters(Filter... filters)

One or more filters.

• description - The description of the security group.

• 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - One or more filters.

• description - The description of the security group.

• 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.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeSecurityGroupsRequest withFilters(Collection<Filter> filters)

One or more filters.

• description - The description of the security group.

• 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - One or more filters.

• description - The description of the security group.

• 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.

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