software.amazon.awssdk.services.ec2.model

Class DescribeSecurityGroupsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ec2.model.EC2Request

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

All Implemented Interfaces:

ToCopyableBuilder<DescribeSecurityGroupsRequest.Builder,DescribeSecurityGroupsRequest>

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

Contains the parameters for DescribeSecurityGroups.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeSecurityGroupsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeSecurityGroupsRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters() One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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()
Integer	maxResults() The maximum number of results to return in a single call.
String	nextToken() The token to request the next page of results.
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.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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.cidr - An IPv4 CIDR block for an outbound security group rule.

• egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

• egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

• egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

• egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

• egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which a security group rule allows outbound access.

• egress.ip-permission.protocol - The IP protocol for an outbound security group rule ( tcp | udp | icmp or a protocol number).

• egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

• egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

• group-id - The ID of the security group.

• group-name - The name of the security group.

• ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

• ip-permission.from-port - For an inbound rule, 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 referenced in an inbound security group rule.

• ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

• ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

• ip-permission.prefix-list-id - The ID (prefix) of the AWS service from which a security group rule allows inbound access.

• ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

• ip-permission.to-port - For an inbound rule, 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 referenced in an inbound security group rule.

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.cidr - An IPv4 CIDR block for an outbound security group rule.

• egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

• egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

• egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

• egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

• egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which a security group rule allows outbound access.

• egress.ip-permission.protocol - The IP protocol for an outbound security group rule ( tcp | udp | icmp or a protocol number).

• egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

• egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

• group-id - The ID of the security group.

• group-name - The name of the security group.

• ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

• ip-permission.from-port - For an inbound rule, 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 referenced in an inbound security group rule.

• ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

• ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

• ip-permission.prefix-list-id - The ID (prefix) of the AWS service from which a security group rule allows inbound access.

• ip-permission.protocol - The IP protocol for an inbound security group rule ( tcp | udp | icmp or a protocol number).

• ip-permission.to-port - For an inbound rule, 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 referenced in an inbound security group rule.

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

nextToken

public String nextToken()

The token to request the next page of results.

Returns:

The token to request the next page of results.

maxResults

public Integer maxResults()

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000.

Returns:

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000.

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>

Specified by:

toBuilder in class EC2Request

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value