/* * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.ec2.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.DescribeSubnetsRequestMarshaller; /** * Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeSubnets(DescribeSubnetsRequest) DescribeSubnets operation}. *
* Describes one or more of your subnets. *
** For more information about subnets, see * Your VPC and Subnets * in the Amazon Virtual Private Cloud User Guide . *
* * @see com.amazonaws.services.ec2.AmazonEC2#describeSubnets(DescribeSubnetsRequest) */ public class DescribeSubnetsRequest extends AmazonWebServiceRequest implements Serializable, DryRunSupportedRequestDefault: Describes all your subnets.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag Default: Describes all your subnets.
*
* @return One or more subnet IDs. Default: Describes all your subnets.
*/
public java.util.List Default: Describes all your subnets.
*
* @param subnetIds One or more subnet IDs. Default: Describes all your subnets.
*/
public void setSubnetIds(java.util.Collection Default: Describes all your subnets.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param subnetIds One or more subnet IDs. Default: Describes all your subnets.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSubnetsRequest withSubnetIds(String... subnetIds) {
if (getSubnetIds() == null) setSubnetIds(new java.util.ArrayList Default: Describes all your subnets.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param subnetIds One or more subnet IDs. Default: Describes all your subnets.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSubnetsRequest withSubnetIds(java.util.Collection
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
*/
private com.amazonaws.internal.ListWithAutoConstructFlagavailabilityZone
- The
* Availability Zone for the subnet. You can also use
* availability-zone
as the filter name. available-ip-address-count
- The number of IP
* addresses in the subnet that are available. cidrBlock
- The CIDR block of the subnet. The CIDR
* block you specify must exactly match the subnet's CIDR block for
* information to be returned for the subnet. You can also use
* cidr
or cidr-block
as the filter names.
* defaultForAz
- Indicates whether this is
* the default subnet for the Availability Zone. You can also use
* default-for-az
as the filter name. state
- The state of the subnet (pending
* | available
). subnet-id
- The
* ID of the subnet. 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 for the
* subnet.
*
* @return One or more filters. availabilityZone
- The
* Availability Zone for the subnet. You can also use
* availability-zone
as the filter name. available-ip-address-count
- The number of IP
* addresses in the subnet that are available. cidrBlock
- The CIDR block of the subnet. The CIDR
* block you specify must exactly match the subnet's CIDR block for
* information to be returned for the subnet. You can also use
* cidr
or cidr-block
as the filter names.
* defaultForAz
- Indicates whether this is
* the default subnet for the Availability Zone. You can also use
* default-for-az
as the filter name. state
- The state of the subnet (pending
* | available
). subnet-id
- The
* ID of the subnet. 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 for the
* subnet.
*/
public java.util.ListavailabilityZone
- The
* Availability Zone for the subnet. You can also use
* availability-zone
as the filter name. available-ip-address-count
- The number of IP
* addresses in the subnet that are available. cidrBlock
- The CIDR block of the subnet. The CIDR
* block you specify must exactly match the subnet's CIDR block for
* information to be returned for the subnet. You can also use
* cidr
or cidr-block
as the filter names.
* defaultForAz
- Indicates whether this is
* the default subnet for the Availability Zone. You can also use
* default-for-az
as the filter name. state
- The state of the subnet (pending
* | available
). subnet-id
- The
* ID of the subnet. 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 for the
* subnet.
*
* @param filters One or more filters. availabilityZone
- The
* Availability Zone for the subnet. You can also use
* availability-zone
as the filter name. available-ip-address-count
- The number of IP
* addresses in the subnet that are available. cidrBlock
- The CIDR block of the subnet. The CIDR
* block you specify must exactly match the subnet's CIDR block for
* information to be returned for the subnet. You can also use
* cidr
or cidr-block
as the filter names.
* defaultForAz
- Indicates whether this is
* the default subnet for the Availability Zone. You can also use
* default-for-az
as the filter name. state
- The state of the subnet (pending
* | available
). subnet-id
- The
* ID of the subnet. 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 for the
* subnet.
*/
public void setFilters(java.util.CollectionavailabilityZone
- The
* Availability Zone for the subnet. You can also use
* availability-zone
as the filter name. available-ip-address-count
- The number of IP
* addresses in the subnet that are available. cidrBlock
- The CIDR block of the subnet. The CIDR
* block you specify must exactly match the subnet's CIDR block for
* information to be returned for the subnet. You can also use
* cidr
or cidr-block
as the filter names.
* defaultForAz
- Indicates whether this is
* the default subnet for the Availability Zone. You can also use
* default-for-az
as the filter name. state
- The state of the subnet (pending
* | available
). subnet-id
- The
* ID of the subnet. 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 for the
* subnet.
* availabilityZone
- The
* Availability Zone for the subnet. You can also use
* availability-zone
as the filter name. available-ip-address-count
- The number of IP
* addresses in the subnet that are available. cidrBlock
- The CIDR block of the subnet. The CIDR
* block you specify must exactly match the subnet's CIDR block for
* information to be returned for the subnet. You can also use
* cidr
or cidr-block
as the filter names.
* defaultForAz
- Indicates whether this is
* the default subnet for the Availability Zone. You can also use
* default-for-az
as the filter name. state
- The state of the subnet (pending
* | available
). subnet-id
- The
* ID of the subnet. 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 for the
* subnet.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSubnetsRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayListavailabilityZone
- The
* Availability Zone for the subnet. You can also use
* availability-zone
as the filter name. available-ip-address-count
- The number of IP
* addresses in the subnet that are available. cidrBlock
- The CIDR block of the subnet. The CIDR
* block you specify must exactly match the subnet's CIDR block for
* information to be returned for the subnet. You can also use
* cidr
or cidr-block
as the filter names.
* defaultForAz
- Indicates whether this is
* the default subnet for the Availability Zone. You can also use
* default-for-az
as the filter name. state
- The state of the subnet (pending
* | available
). subnet-id
- The
* ID of the subnet. 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 for the
* subnet.
* availabilityZone
- The
* Availability Zone for the subnet. You can also use
* availability-zone
as the filter name. available-ip-address-count
- The number of IP
* addresses in the subnet that are available. cidrBlock
- The CIDR block of the subnet. The CIDR
* block you specify must exactly match the subnet's CIDR block for
* information to be returned for the subnet. You can also use
* cidr
or cidr-block
as the filter names.
* defaultForAz
- Indicates whether this is
* the default subnet for the Availability Zone. You can also use
* default-for-az
as the filter name. state
- The state of the subnet (pending
* | available
). subnet-id
- The
* ID of the subnet. 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 for the
* subnet.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSubnetsRequest withFilters(java.util.CollectionavailabilityZone
- The
* Availability Zone for the subnet. You can also use
* availability-zone
as the filter name. available-ip-address-count
- The number of IP
* addresses in the subnet that are available. cidrBlock
- The CIDR block of the subnet. The CIDR
* block you specify must exactly match the subnet's CIDR block for
* information to be returned for the subnet. You can also use
* cidr
or cidr-block
as the filter names.
* defaultForAz
- Indicates whether this is
* the default subnet for the Availability Zone. You can also use
* default-for-az
as the filter name. state
- The state of the subnet (pending
* | available
). subnet-id
- The
* ID of the subnet. 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 for the
* subnet.