software.amazon.awssdk.services.ec2.model

Interface DescribeVpnGatewaysRequest.Builder

All Superinterfaces:

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

Enclosing class:

DescribeVpnGatewaysRequest

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

Method Summary

Modifier and Type	Method and Description
DescribeVpnGatewaysRequest.Builder	filters(Collection<Filter> filters) One or more filters.
DescribeVpnGatewaysRequest.Builder	filters(Consumer<Filter.Builder>... filters) One or more filters.
DescribeVpnGatewaysRequest.Builder	filters(Filter... filters) One or more filters.
DescribeVpnGatewaysRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeVpnGatewaysRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeVpnGatewaysRequest.Builder	vpnGatewayIds(Collection<String> vpnGatewayIds) One or more virtual private gateway IDs.
DescribeVpnGatewaysRequest.Builder	vpnGatewayIds(String... vpnGatewayIds) One or more virtual private gateway IDs.

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

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

filters

DescribeVpnGatewaysRequest.Builder filters(Collection<Filter> filters)

One or more filters.

• amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

• attachment.state - The current state of the attachment between the gateway and the VPC ( attaching | attached | detaching | detached).

• attachment.vpc-id - The ID of an attached VPC.

• availability-zone - The Availability Zone for the virtual private gateway (if applicable).

• state - The state of the virtual private gateway (pending | available | deleting | deleted).

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

• type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

• vpn-gateway-id - The ID of the virtual private gateway.

Parameters:

filters - One or more filters.

• amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

• attachment.state - The current state of the attachment between the gateway and the VPC ( attaching | attached | detaching | detached).

• attachment.vpc-id - The ID of an attached VPC.

• availability-zone - The Availability Zone for the virtual private gateway (if applicable).

• state - The state of the virtual private gateway (pending | available | deleting | deleted).

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

• type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

• vpn-gateway-id - The ID of the virtual private gateway.

Returns:

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

filters

DescribeVpnGatewaysRequest.Builder filters(Filter... filters)

One or more filters.

• amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

• attachment.state - The current state of the attachment between the gateway and the VPC ( attaching | attached | detaching | detached).

• attachment.vpc-id - The ID of an attached VPC.

• availability-zone - The Availability Zone for the virtual private gateway (if applicable).

• state - The state of the virtual private gateway (pending | available | deleting | deleted).

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

• type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

• vpn-gateway-id - The ID of the virtual private gateway.

Parameters:

filters - One or more filters.

• amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

• attachment.state - The current state of the attachment between the gateway and the VPC ( attaching | attached | detaching | detached).

• attachment.vpc-id - The ID of an attached VPC.

• availability-zone - The Availability Zone for the virtual private gateway (if applicable).

• state - The state of the virtual private gateway (pending | available | deleting | deleted).

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

• type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

• vpn-gateway-id - The ID of the virtual private gateway.

Returns:

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

filters

DescribeVpnGatewaysRequest.Builder filters(Consumer<Filter.Builder>... filters)

One or more filters.

• amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

• attachment.state - The current state of the attachment between the gateway and the VPC ( attaching | attached | detaching | detached).

• attachment.vpc-id - The ID of an attached VPC.

• availability-zone - The Availability Zone for the virtual private gateway (if applicable).

• state - The state of the virtual private gateway (pending | available | deleting | deleted).

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

• type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

• vpn-gateway-id - The ID of the virtual private gateway.

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)

vpnGatewayIds

DescribeVpnGatewaysRequest.Builder vpnGatewayIds(Collection<String> vpnGatewayIds)

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Parameters:

vpnGatewayIds - One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Returns:

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

vpnGatewayIds

DescribeVpnGatewaysRequest.Builder vpnGatewayIds(String... vpnGatewayIds)

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Parameters:

vpnGatewayIds - One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Returns:

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

overrideConfiguration

DescribeVpnGatewaysRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder