com.amazonaws.services.ec2.model

Class DescribeVpcsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeVpcsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeVpcsRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeVpcsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeVpcsRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeVpcsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeVpcsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<DescribeVpcsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() The filters.
Integer	getMaxResults() The maximum number of items to return for this request.
String	getNextToken() The token returned from a previous paginated request.
List<String>	getVpcIds() The IDs of the VPCs.
int	hashCode()
void	setFilters(Collection<Filter> filters) The filters.
void	setMaxResults(Integer maxResults) The maximum number of items to return for this request.
void	setNextToken(String nextToken) The token returned from a previous paginated request.
void	setVpcIds(Collection<String> vpcIds) The IDs of the VPCs.
String	toString() Returns a string representation of this object.
DescribeVpcsRequest	withFilters(Collection<Filter> filters) The filters.
DescribeVpcsRequest	withFilters(Filter... filters) The filters.
DescribeVpcsRequest	withMaxResults(Integer maxResults) The maximum number of items to return for this request.
DescribeVpcsRequest	withNextToken(String nextToken) The token returned from a previous paginated request.
DescribeVpcsRequest	withVpcIds(Collection<String> vpcIds) The IDs of the VPCs.
DescribeVpcsRequest	withVpcIds(String... vpcIds) The IDs of the VPCs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeVpcsRequest

public DescribeVpcsRequest()

Method Detail

getFilters

public List<Filter> getFilters()

The filters.

• cidr - The primary 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).

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

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

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

• 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.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

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

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

• owner-id - The ID of the Amazon Web Services account that owns the VPC.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC.

Returns:

The filters.

• cidr - The primary 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).

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

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

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

• 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.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

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

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

• owner-id - The ID of the Amazon Web Services account that owns the VPC.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC.

setFilters

public void setFilters(Collection<Filter> filters)

The filters.

• cidr - The primary 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).

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

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

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

• 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.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

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

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

• owner-id - The ID of the Amazon Web Services account that owns the VPC.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC.

Parameters:

filters - The filters.

• cidr - The primary 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).

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

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

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

• 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.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

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

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

• owner-id - The ID of the Amazon Web Services account that owns the VPC.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC.

withFilters

public DescribeVpcsRequest withFilters(Filter... filters)

The filters.

• cidr - The primary 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).

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

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

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

• 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.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

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

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

• owner-id - The ID of the Amazon Web Services account that owns the VPC.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - The filters.

• cidr - The primary 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).

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

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

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

• 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.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

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

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

• owner-id - The ID of the Amazon Web Services account that owns the VPC.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC.

Returns:

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

withFilters

public DescribeVpcsRequest withFilters(Collection<Filter> filters)

The filters.

• cidr - The primary 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).

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

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

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

• 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.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

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

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

• owner-id - The ID of the Amazon Web Services account that owns the VPC.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC.

Parameters:

filters - The filters.

• cidr - The primary 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).

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

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

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

• 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.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.

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

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

• owner-id - The ID of the Amazon Web Services account that owns the VPC.

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

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• vpc-id - The ID of the VPC.

Returns:

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

getVpcIds

public List<String> getVpcIds()

The IDs of the VPCs.

Returns:

The IDs of the VPCs.

setVpcIds

public void setVpcIds(Collection<String> vpcIds)

The IDs of the VPCs.

Parameters:

vpcIds - The IDs of the VPCs.

withVpcIds

public DescribeVpcsRequest withVpcIds(String... vpcIds)

The IDs of the VPCs.

NOTE: This method appends the values to the existing list (if any). Use setVpcIds(java.util.Collection) or withVpcIds(java.util.Collection) if you want to override the existing values.

Parameters:

vpcIds - The IDs of the VPCs.

Returns:

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

withVpcIds

public DescribeVpcsRequest withVpcIds(Collection<String> vpcIds)

The IDs of the VPCs.

Parameters:

vpcIds - The IDs of the VPCs.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Parameters:

nextToken - The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

getNextToken

public String getNextToken()

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

withNextToken

public DescribeVpcsRequest withNextToken(String nextToken)

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Parameters:

nextToken - The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

Returns:

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

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Parameters:

maxResults - The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

getMaxResults

public Integer getMaxResults()

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Returns:

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

withMaxResults

public DescribeVpcsRequest withMaxResults(Integer maxResults)

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Parameters:

maxResults - The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

Returns:

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

getDryRunRequest

public Request<DescribeVpcsRequest> 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<DescribeVpcsRequest>

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeVpcsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()