com.amazonaws.services.ec2.model

Class DescribeVpcsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeVpcsRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<DescribeVpcsRequest>, Serializable, Cloneable

public class DescribeVpcsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeVpcsRequest>

Contains the parameters for DescribeVpcs.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeVpcsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeVpcsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Request<DescribeVpcsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
List<String>	getVpcIds() One or more VPC IDs.
int	hashCode()
void	setFilters(Collection<Filter> filters) One or more filters.
void	setVpcIds(Collection<String> vpcIds) One or more VPC IDs.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeVpcsRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeVpcsRequest	withFilters(Filter... filters) One or more filters.
DescribeVpcsRequest	withVpcIds(Collection<String> vpcIds) One or more VPC IDs.
DescribeVpcsRequest	withVpcIds(String... vpcIds) One or more VPC IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeVpcsRequest

public DescribeVpcsRequest()

Method Detail

getVpcIds

public List<String> getVpcIds()

One or more VPC IDs.

Default: Describes all your VPCs.

Returns:

One or more VPC IDs.

Default: Describes all your VPCs.

setVpcIds

public void setVpcIds(Collection<String> vpcIds)

One or more VPC IDs.

Default: Describes all your VPCs.

Parameters:

vpcIds - One or more VPC IDs.

Default: Describes all your VPCs.

withVpcIds

public DescribeVpcsRequest withVpcIds(String... vpcIds)

One or more VPC IDs.

Default: Describes all your 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 - One or more VPC IDs.

Default: Describes all your VPCs.

Returns:

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

withVpcIds

public DescribeVpcsRequest withVpcIds(Collection<String> vpcIds)

One or more VPC IDs.

Default: Describes all your VPCs.

Parameters:

vpcIds - One or more VPC IDs.

Default: Describes all your VPCs.

Returns:

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

getFilters

public List<Filter> getFilters()

One or more filters.

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

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

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

Returns:

One or more filters.

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

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

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

setFilters

public void setFilters(Collection<Filter> filters)

One or more filters.

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

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

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

Parameters:

filters - One or more filters.

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

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

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

withFilters

public DescribeVpcsRequest withFilters(Filter... filters)

One or more filters.

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

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

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

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 - One or more filters.

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

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

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

Returns:

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

withFilters

public DescribeVpcsRequest withFilters(Collection<Filter> filters)

One or more filters.

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

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

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

Parameters:

filters - One or more filters.

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

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

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

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; useful for testing and debugging.

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 request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()