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 Description DescribeVpcsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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(Filter... filters)
One or more filters.DescribeVpcsRequest
withFilters(Collection<Filter> filters)
One or more filters.DescribeVpcsRequest
withVpcIds(String... vpcIds)
One or more VPC IDs.DescribeVpcsRequest
withVpcIds(Collection<String> vpcIds)
One or more VPC IDs.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
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)
orwithVpcIds(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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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)
orwithFilters(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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 interfaceDryRunSupportedRequest<DescribeVpcsRequest>
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-