software.amazon.awssdk.services.ec2.model

Class DescribeVpcsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.core.AmazonWebServiceRequest

software.amazon.awssdk.services.ec2.model.DescribeVpcsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<DescribeVpcsRequest.Builder,DescribeVpcsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class DescribeVpcsRequest
extends AmazonWebServiceRequest
implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<DescribeVpcsRequest.Builder,DescribeVpcsRequest>

Contains the parameters for DescribeVpcs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeVpcsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.core.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method and Description
static DescribeVpcsRequest.Builder	builder()
boolean	equals(Object obj)
List<Filter>	filters() One or more filters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
static Class<? extends DescribeVpcsRequest.Builder>	serializableBuilderClass()
DescribeVpcsRequest.Builder	toBuilder()
String	toString()
List<String>	vpcIds() One or more VPC IDs.

Methods inherited from class software.amazon.awssdk.core.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

finalize, 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.

• cidr - The IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

• dhcp-options-id - The ID of a set of DHCP options.

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

• ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

• isDefault - Indicates whether the VPC is the default VPC.

• state - The state of the VPC (pending | available).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC.

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

Returns:

One or more filters.

• cidr - The IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

• dhcp-options-id - The ID of a set of DHCP options.

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

• ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

• isDefault - Indicates whether the VPC is the default VPC.

• state - The state of the VPC (pending | available).

• tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• vpc-id - The ID of the VPC.

vpcIds

public List<String> vpcIds()

One or more VPC IDs.

Default: Describes all your VPCs.

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

Returns:

One or more VPC IDs.

Default: Describes all your VPCs.

toBuilder

public DescribeVpcsRequest.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<DescribeVpcsRequest.Builder,DescribeVpcsRequest>

builder

public static DescribeVpcsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeVpcsRequest.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)

Overrides:

getValueForField in class SdkRequest