Package software.amazon.awssdk.services.ec2.model

Class DescribeSecurityGroupsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ec2.model.DescribeSecurityGroupsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<DescribeSecurityGroupsRequest.Builder,DescribeSecurityGroupsRequest>

@Generated("software.amazon.awssdk:codegen")
public class DescribeSecurityGroupsRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<DescribeSecurityGroupsRequest.Builder,DescribeSecurityGroupsRequest>

Contains the parameters for DescribeSecurityGroups.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeSecurityGroupsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static DescribeSecurityGroupsRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters()	One or more filters.
List<String>	groupIds()	One or more security group IDs.
List<String>	groupNames()	[EC2-Classic and default VPC only] One or more security group names.
int	hashCode()
static Class<? extends DescribeSecurityGroupsRequest.Builder>	serializableBuilderClass()
DescribeSecurityGroupsRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

filters

public List<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 - An IPv4 CIDR range that has been granted permission in a security group rule.

• 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.ipv6-cidr - An IPv6 CIDR range that has been granted permission in a security group rule.

• 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 - An IPv4 CIDR range that has been granted permission in a security group rule.

• 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.ipv6-cidr - An IPv6 CIDR range that has been granted permission in a security group rule.

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

groupIds

public List<String> groupIds()

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.

groupNames

public List<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.

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.

toBuilder

public DescribeSecurityGroupsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeSecurityGroupsRequest.Builder,DescribeSecurityGroupsRequest>

Returns:

a builder for type T

builder

public static DescribeSecurityGroupsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeSecurityGroupsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object