Package software.amazon.awssdk.services.ec2.model

Interface DescribeVpcsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeVpcsRequest.Builder,DescribeVpcsRequest>, Ec2Request.Builder, SdkBuilder<DescribeVpcsRequest.Builder,DescribeVpcsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeVpcsRequest

public static interface DescribeVpcsRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeVpcsRequest.Builder,DescribeVpcsRequest>

Method Summary

Modifier and Type	Method	Description
DescribeVpcsRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
DescribeVpcsRequest.Builder	filters(Collection<Filter> filters)	The filters.
DescribeVpcsRequest.Builder	filters(Consumer<Filter.Builder>... filters)	The filters.
DescribeVpcsRequest.Builder	filters(Filter... filters)	The filters.
DescribeVpcsRequest.Builder	maxResults(Integer maxResults)	The maximum number of items to return for this request.
DescribeVpcsRequest.Builder	nextToken(String nextToken)	The token returned from a previous paginated request.
DescribeVpcsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeVpcsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeVpcsRequest.Builder	vpcIds(String... vpcIds)	The IDs of the VPCs.
DescribeVpcsRequest.Builder	vpcIds(Collection<String> vpcIds)	The IDs of the VPCs.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

filters

DescribeVpcsRequest.Builder filters(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.

filters

DescribeVpcsRequest.Builder filters(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.

filters

DescribeVpcsRequest.Builder filters(Consumer<Filter.Builder>... 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.

This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).

Parameters:

filters - a consumer that will call methods on Filter.Builder

Returns:

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

See Also:

#filters(java.util.Collection)

vpcIds

DescribeVpcsRequest.Builder vpcIds(Collection<String> vpcIds)

The IDs of the VPCs.

Default: Describes all your VPCs.

Parameters:

vpcIds - The IDs of the VPCs.

Default: Describes all your VPCs.

Returns:

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

vpcIds

DescribeVpcsRequest.Builder vpcIds(String... vpcIds)

The IDs of the VPCs.

Default: Describes all your VPCs.

Parameters:

vpcIds - The IDs of the VPCs.

Default: Describes all your VPCs.

Returns:

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

dryRun

DescribeVpcsRequest.Builder dryRun(Boolean dryRun)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Parameters:

dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

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

nextToken

DescribeVpcsRequest.Builder nextToken(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.

maxResults

DescribeVpcsRequest.Builder maxResults(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.

overrideConfiguration

DescribeVpcsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

DescribeVpcsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder