Class DescribeSecurityGroupsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeSecurityGroupsRequest>
,Serializable
,Cloneable
public class DescribeSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeSecurityGroupsRequest>
Contains the parameters for DescribeSecurityGroups.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeSecurityGroupsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeSecurityGroupsRequest
clone()
Creates a shallow clone of this request.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 and default VPC only] 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 and default VPC only] One or more security group names.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeSecurityGroupsRequest
withFilters(Filter... filters)
One or more filters.DescribeSecurityGroupsRequest
withFilters(Collection<Filter> filters)
One or more filters.DescribeSecurityGroupsRequest
withGroupIds(String... groupIds)
One or more security group IDs.DescribeSecurityGroupsRequest
withGroupIds(Collection<String> groupIds)
One or more security group IDs.DescribeSecurityGroupsRequest
withGroupNames(String... groupNames)
[EC2-Classic and default VPC only] One or more security group names.DescribeSecurityGroupsRequest
withGroupNames(Collection<String> groupNames)
[EC2-Classic and default VPC only] One or more security group names.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
getGroupNames
public List<String> getGroupNames()
[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.
- Returns:
- [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.
-
setGroupNames
public void setGroupNames(Collection<String> 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.
- Parameters:
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 thegroup-name
filter to describe security groups by name.Default: Describes all your security groups.
-
withGroupNames
public DescribeSecurityGroupsRequest withGroupNames(String... 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
setGroupNames(java.util.Collection)
orwithGroupNames(java.util.Collection)
if you want to override the existing values.- Parameters:
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 thegroup-name
filter to describe security groups by name.Default: Describes all your security groups.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withGroupNames
public DescribeSecurityGroupsRequest withGroupNames(Collection<String> 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.
- Parameters:
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 thegroup-name
filter to describe security groups by name.Default: Describes all your security groups.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getGroupIds
public List<String> getGroupIds()
One or more security group IDs. Required for security groups in a nondefault VPC.
Default: Describes all your security groups.
- Returns:
- One or more security group IDs. Required for security groups in a
nondefault VPC.
Default: Describes all your security groups.
-
setGroupIds
public void setGroupIds(Collection<String> groupIds)
One or more security group IDs. Required for security groups in a nondefault VPC.
Default: Describes all your security groups.
- Parameters:
groupIds
- One or more security group IDs. Required for security groups in a nondefault VPC.Default: Describes all your security groups.
-
withGroupIds
public DescribeSecurityGroupsRequest withGroupIds(String... 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
setGroupIds(java.util.Collection)
orwithGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
groupIds
- One or more security group IDs. Required for security groups in a nondefault VPC.Default: Describes all your security groups.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withGroupIds
public DescribeSecurityGroupsRequest withGroupIds(Collection<String> groupIds)
One or more security group IDs. Required for security groups in a nondefault VPC.
Default: Describes all your security groups.
- Parameters:
groupIds
- One or more security group IDs. Required for security groups in a nondefault VPC.Default: Describes all your security groups.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getFilters
public List<Filter> getFilters()
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.
- Returns:
- 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.
-
-
-
setFilters
public void setFilters(Collection<Filter> 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.
- Parameters:
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.
-
-
-
withFilters
public DescribeSecurityGroupsRequest withFilters(Filter... 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
setFilters(java.util.Collection)
orwithFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
withFilters
public DescribeSecurityGroupsRequest withFilters(Collection<Filter> 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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this 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 interfaceDryRunSupportedRequest<DescribeSecurityGroupsRequest>
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeSecurityGroupsRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-