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

Interface VpnConnectionOptionsSpecification.Builder

All Superinterfaces:

Buildable, CopyableBuilder<VpnConnectionOptionsSpecification.Builder,VpnConnectionOptionsSpecification>, SdkBuilder<VpnConnectionOptionsSpecification.Builder,VpnConnectionOptionsSpecification>, SdkPojo

Enclosing class:

VpnConnectionOptionsSpecification

@Mutable
@NotThreadSafe
public static interface VpnConnectionOptionsSpecification.Builder
extends SdkPojo, CopyableBuilder<VpnConnectionOptionsSpecification.Builder,VpnConnectionOptionsSpecification>

Method Summary

Modifier and Type	Method	Description
VpnConnectionOptionsSpecification.Builder	enableAcceleration(Boolean enableAcceleration)	Indicate whether to enable acceleration for the VPN connection.
VpnConnectionOptionsSpecification.Builder	localIpv4NetworkCidr(String localIpv4NetworkCidr)	The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
VpnConnectionOptionsSpecification.Builder	localIpv6NetworkCidr(String localIpv6NetworkCidr)	The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
VpnConnectionOptionsSpecification.Builder	outsideIpAddressType(String outsideIpAddressType)	The type of IP address assigned to the outside interface of the customer gateway device.
VpnConnectionOptionsSpecification.Builder	remoteIpv4NetworkCidr(String remoteIpv4NetworkCidr)	The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
VpnConnectionOptionsSpecification.Builder	remoteIpv6NetworkCidr(String remoteIpv6NetworkCidr)	The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
VpnConnectionOptionsSpecification.Builder	staticRoutesOnly(Boolean staticRoutesOnly)	Indicate whether the VPN connection uses static routes only.
VpnConnectionOptionsSpecification.Builder	transportTransitGatewayAttachmentId(String transportTransitGatewayAttachmentId)	The transit gateway attachment ID to use for the VPN tunnel.
VpnConnectionOptionsSpecification.Builder	tunnelBandwidth(String tunnelBandwidth)	The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity.
VpnConnectionOptionsSpecification.Builder	tunnelBandwidth(VpnTunnelBandwidth tunnelBandwidth)	The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity.
VpnConnectionOptionsSpecification.Builder	tunnelInsideIpVersion(String tunnelInsideIpVersion)	Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
VpnConnectionOptionsSpecification.Builder	tunnelInsideIpVersion(TunnelInsideIpVersion tunnelInsideIpVersion)	Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
VpnConnectionOptionsSpecification.Builder	tunnelOptions(Collection<VpnTunnelOptionsSpecification> tunnelOptions)	The tunnel options for the VPN connection.
VpnConnectionOptionsSpecification.Builder	tunnelOptions(Consumer<VpnTunnelOptionsSpecification.Builder>... tunnelOptions)	The tunnel options for the VPN connection.
VpnConnectionOptionsSpecification.Builder	tunnelOptions(VpnTunnelOptionsSpecification... tunnelOptions)	The tunnel options for the VPN connection.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

enableAcceleration

VpnConnectionOptionsSpecification.Builder enableAcceleration(Boolean enableAcceleration)

Indicate whether to enable acceleration for the VPN connection.

Default: false

Parameters:

enableAcceleration - Indicate whether to enable acceleration for the VPN connection.

Default: false

Returns:

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

tunnelInsideIpVersion

VpnConnectionOptionsSpecification.Builder tunnelInsideIpVersion(String tunnelInsideIpVersion)

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

Default: ipv4

Parameters:

tunnelInsideIpVersion - Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

Default: ipv4

Returns:

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

See Also:

TunnelInsideIpVersion, TunnelInsideIpVersion

tunnelInsideIpVersion

VpnConnectionOptionsSpecification.Builder tunnelInsideIpVersion(TunnelInsideIpVersion tunnelInsideIpVersion)

Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

Default: ipv4

Parameters:

tunnelInsideIpVersion - Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.

Default: ipv4

Returns:

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

See Also:

TunnelInsideIpVersion, TunnelInsideIpVersion

tunnelOptions

VpnConnectionOptionsSpecification.Builder tunnelOptions(Collection<VpnTunnelOptionsSpecification> tunnelOptions)

The tunnel options for the VPN connection.

Parameters:

tunnelOptions - The tunnel options for the VPN connection.

Returns:

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

tunnelOptions

VpnConnectionOptionsSpecification.Builder tunnelOptions(VpnTunnelOptionsSpecification... tunnelOptions)

The tunnel options for the VPN connection.

Parameters:

tunnelOptions - The tunnel options for the VPN connection.

Returns:

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

tunnelOptions

VpnConnectionOptionsSpecification.Builder tunnelOptions(Consumer<VpnTunnelOptionsSpecification.Builder>... tunnelOptions)

The tunnel options for the VPN connection.

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

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

Parameters:

tunnelOptions - a consumer that will call methods on VpnTunnelOptionsSpecification.Builder

Returns:

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

See Also:

#tunnelOptions(java.util.Collection)

localIpv4NetworkCidr

VpnConnectionOptionsSpecification.Builder localIpv4NetworkCidr(String localIpv4NetworkCidr)

The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: 0.0.0.0/0

Parameters:

localIpv4NetworkCidr - The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: 0.0.0.0/0

Returns:

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

remoteIpv4NetworkCidr

VpnConnectionOptionsSpecification.Builder remoteIpv4NetworkCidr(String remoteIpv4NetworkCidr)

The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

Default: 0.0.0.0/0

Parameters:

remoteIpv4NetworkCidr - The IPv4 CIDR on the Amazon Web Services side of the VPN connection.

Default: 0.0.0.0/0

Returns:

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

localIpv6NetworkCidr

VpnConnectionOptionsSpecification.Builder localIpv6NetworkCidr(String localIpv6NetworkCidr)

The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: ::/0

Parameters:

localIpv6NetworkCidr - The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.

Default: ::/0

Returns:

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

remoteIpv6NetworkCidr

VpnConnectionOptionsSpecification.Builder remoteIpv6NetworkCidr(String remoteIpv6NetworkCidr)

The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

Default: ::/0

Parameters:

remoteIpv6NetworkCidr - The IPv6 CIDR on the Amazon Web Services side of the VPN connection.

Default: ::/0

Returns:

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

outsideIpAddressType

VpnConnectionOptionsSpecification.Builder outsideIpAddressType(String outsideIpAddressType)

The type of IP address assigned to the outside interface of the customer gateway device.

Valid values: PrivateIpv4 | PublicIpv4 | Ipv6

Default: PublicIpv4

Parameters:

outsideIpAddressType - The type of IP address assigned to the outside interface of the customer gateway device.

Valid values: PrivateIpv4 | PublicIpv4 | Ipv6

Default: PublicIpv4

Returns:

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

transportTransitGatewayAttachmentId

VpnConnectionOptionsSpecification.Builder transportTransitGatewayAttachmentId(String transportTransitGatewayAttachmentId)

The transit gateway attachment ID to use for the VPN tunnel.

Required if OutsideIpAddressType is set to PrivateIpv4.

Parameters:

transportTransitGatewayAttachmentId - The transit gateway attachment ID to use for the VPN tunnel.

Required if OutsideIpAddressType is set to PrivateIpv4.

Returns:

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

tunnelBandwidth

VpnConnectionOptionsSpecification.Builder tunnelBandwidth(String tunnelBandwidth)

The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. standard supports up to 1.25 Gbps per tunnel, while large supports up to 5 Gbps per tunnel. The default value is standard. Existing VPN connections without a bandwidth setting will automatically default to standard.

Parameters:

tunnelBandwidth - The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. standard supports up to 1.25 Gbps per tunnel, while large supports up to 5 Gbps per tunnel. The default value is standard. Existing VPN connections without a bandwidth setting will automatically default to standard.

Returns:

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

See Also:

VpnTunnelBandwidth, VpnTunnelBandwidth

tunnelBandwidth

VpnConnectionOptionsSpecification.Builder tunnelBandwidth(VpnTunnelBandwidth tunnelBandwidth)

The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. standard supports up to 1.25 Gbps per tunnel, while large supports up to 5 Gbps per tunnel. The default value is standard. Existing VPN connections without a bandwidth setting will automatically default to standard.

Parameters:

tunnelBandwidth - The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. standard supports up to 1.25 Gbps per tunnel, while large supports up to 5 Gbps per tunnel. The default value is standard. Existing VPN connections without a bandwidth setting will automatically default to standard.

Returns:

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

See Also:

VpnTunnelBandwidth, VpnTunnelBandwidth

staticRoutesOnly

VpnConnectionOptionsSpecification.Builder staticRoutesOnly(Boolean staticRoutesOnly)

Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.

Default: false

Parameters:

staticRoutesOnly - Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.

Default: false

Returns:

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