com.amazonaws.services.ec2.model

Class DescribeVpcsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeVpcsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeVpcsRequest>, java.io.Serializable, java.lang.Cloneable

public class DescribeVpcsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeVpcsRequest>

Container for the parameters to the DescribeVpcs operation.

Describes one or more of your VPCs.

See Also:

AmazonEC2.describeVpcs(DescribeVpcsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeVpcsRequest()

Method Summary

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

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeVpcsRequest

public DescribeVpcsRequest()

Method Detail

getVpcIds

public java.util.List<java.lang.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(java.util.Collection<java.lang.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(java.lang.String... vpcIds)

One or more VPC IDs.

Default: Describes all your VPCs.

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

Parameters:

vpcIds - One or more VPC IDs.

Default: Describes all your VPCs.

Returns:

A reference to this updated object so that method calls can be chained together.

withVpcIds

public DescribeVpcsRequest withVpcIds(java.util.Collection<java.lang.String> vpcIds)

One or more VPC IDs.

Default: Describes all your VPCs.

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

Parameters:

vpcIds - One or more VPC IDs.

Default: Describes all your VPCs.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public java.util.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(java.util.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.

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

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:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeVpcsRequest withFilters(java.util.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.

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

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:

A reference to this updated 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 java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object