software.amazon.awssdk.services.directconnect.model

Interface AllocatePrivateVirtualInterfaceResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<AllocatePrivateVirtualInterfaceResponse.Builder,AllocatePrivateVirtualInterfaceResponse>, DirectConnectResponse.Builder, SdkBuilder<AllocatePrivateVirtualInterfaceResponse.Builder,AllocatePrivateVirtualInterfaceResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

AllocatePrivateVirtualInterfaceResponse

public static interface AllocatePrivateVirtualInterfaceResponse.Builder
extends DirectConnectResponse.Builder, SdkPojo, CopyableBuilder<AllocatePrivateVirtualInterfaceResponse.Builder,AllocatePrivateVirtualInterfaceResponse>

Method Summary

Modifier and Type	Method and Description
AllocatePrivateVirtualInterfaceResponse.Builder	addressFamily(AddressFamily addressFamily) The address family for the BGP peer.
AllocatePrivateVirtualInterfaceResponse.Builder	addressFamily(String addressFamily) The address family for the BGP peer.
AllocatePrivateVirtualInterfaceResponse.Builder	amazonAddress(String amazonAddress) The IP address assigned to the Amazon interface.
AllocatePrivateVirtualInterfaceResponse.Builder	amazonSideAsn(Long amazonSideAsn) The autonomous system number (ASN) for the Amazon side of the connection.
AllocatePrivateVirtualInterfaceResponse.Builder	asn(Integer asn) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
AllocatePrivateVirtualInterfaceResponse.Builder	authKey(String authKey) The authentication key for BGP configuration.
AllocatePrivateVirtualInterfaceResponse.Builder	awsDeviceV2(String awsDeviceV2) The Direct Connect endpoint on which the virtual interface terminates.
AllocatePrivateVirtualInterfaceResponse.Builder	bgpPeers(BGPPeer... bgpPeers) The BGP peers configured on this virtual interface.
AllocatePrivateVirtualInterfaceResponse.Builder	bgpPeers(Collection<BGPPeer> bgpPeers) The BGP peers configured on this virtual interface.
AllocatePrivateVirtualInterfaceResponse.Builder	bgpPeers(Consumer<BGPPeer.Builder>... bgpPeers) The BGP peers configured on this virtual interface.
AllocatePrivateVirtualInterfaceResponse.Builder	connectionId(String connectionId) The ID of the connection.
AllocatePrivateVirtualInterfaceResponse.Builder	customerAddress(String customerAddress) The IP address assigned to the customer interface.
AllocatePrivateVirtualInterfaceResponse.Builder	customerRouterConfig(String customerRouterConfig) The customer router configuration.
AllocatePrivateVirtualInterfaceResponse.Builder	directConnectGatewayId(String directConnectGatewayId) The ID of the Direct Connect gateway.
AllocatePrivateVirtualInterfaceResponse.Builder	jumboFrameCapable(Boolean jumboFrameCapable) Indicates whether jumbo frames (9001 MTU) are supported.
AllocatePrivateVirtualInterfaceResponse.Builder	location(String location) The location of the connection.
AllocatePrivateVirtualInterfaceResponse.Builder	mtu(Integer mtu) The maximum transmission unit (MTU), in bytes.
AllocatePrivateVirtualInterfaceResponse.Builder	ownerAccount(String ownerAccount) The ID of the AWS account that owns the virtual interface.
AllocatePrivateVirtualInterfaceResponse.Builder	region(String region) The AWS Region where the virtual interface is located.
AllocatePrivateVirtualInterfaceResponse.Builder	routeFilterPrefixes(Collection<RouteFilterPrefix> routeFilterPrefixes) The routes to be advertised to the AWS network in this Region.
AllocatePrivateVirtualInterfaceResponse.Builder	routeFilterPrefixes(Consumer<RouteFilterPrefix.Builder>... routeFilterPrefixes) The routes to be advertised to the AWS network in this Region.
AllocatePrivateVirtualInterfaceResponse.Builder	routeFilterPrefixes(RouteFilterPrefix... routeFilterPrefixes) The routes to be advertised to the AWS network in this Region.
AllocatePrivateVirtualInterfaceResponse.Builder	virtualGatewayId(String virtualGatewayId) The ID of the virtual private gateway.
AllocatePrivateVirtualInterfaceResponse.Builder	virtualInterfaceId(String virtualInterfaceId) The ID of the virtual interface.
AllocatePrivateVirtualInterfaceResponse.Builder	virtualInterfaceName(String virtualInterfaceName) The name of the virtual interface assigned by the customer network.
AllocatePrivateVirtualInterfaceResponse.Builder	virtualInterfaceState(String virtualInterfaceState) The state of the virtual interface.
AllocatePrivateVirtualInterfaceResponse.Builder	virtualInterfaceState(VirtualInterfaceState virtualInterfaceState) The state of the virtual interface.
AllocatePrivateVirtualInterfaceResponse.Builder	virtualInterfaceType(String virtualInterfaceType) The type of virtual interface.
AllocatePrivateVirtualInterfaceResponse.Builder	vlan(Integer vlan) The ID of the VLAN.

Methods inherited from interface software.amazon.awssdk.services.directconnect.model.DirectConnectResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

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

ownerAccount

AllocatePrivateVirtualInterfaceResponse.Builder ownerAccount(String ownerAccount)

The ID of the AWS account that owns the virtual interface.

Parameters:

ownerAccount - The ID of the AWS account that owns the virtual interface.

Returns:

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

virtualInterfaceId

AllocatePrivateVirtualInterfaceResponse.Builder virtualInterfaceId(String virtualInterfaceId)

The ID of the virtual interface.

Parameters:

virtualInterfaceId - The ID of the virtual interface.

Returns:

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

location

AllocatePrivateVirtualInterfaceResponse.Builder location(String location)

The location of the connection.

Parameters:

location - The location of the connection.

Returns:

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

connectionId

AllocatePrivateVirtualInterfaceResponse.Builder connectionId(String connectionId)

The ID of the connection.

Parameters:

connectionId - The ID of the connection.

Returns:

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

virtualInterfaceType

AllocatePrivateVirtualInterfaceResponse.Builder virtualInterfaceType(String virtualInterfaceType)

The type of virtual interface. The possible values are private and public.

Parameters:

virtualInterfaceType - The type of virtual interface. The possible values are private and public.

Returns:

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

virtualInterfaceName

AllocatePrivateVirtualInterfaceResponse.Builder virtualInterfaceName(String virtualInterfaceName)

The name of the virtual interface assigned by the customer network.

Parameters:

virtualInterfaceName - The name of the virtual interface assigned by the customer network.

Returns:

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

vlan

AllocatePrivateVirtualInterfaceResponse.Builder vlan(Integer vlan)

The ID of the VLAN.

Parameters:

vlan - The ID of the VLAN.

Returns:

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

asn

AllocatePrivateVirtualInterfaceResponse.Builder asn(Integer asn)

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Parameters:

asn - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Returns:

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

amazonSideAsn

AllocatePrivateVirtualInterfaceResponse.Builder amazonSideAsn(Long amazonSideAsn)

The autonomous system number (ASN) for the Amazon side of the connection.

Parameters:

amazonSideAsn - The autonomous system number (ASN) for the Amazon side of the connection.

Returns:

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

authKey

AllocatePrivateVirtualInterfaceResponse.Builder authKey(String authKey)

The authentication key for BGP configuration.

Parameters:

authKey - The authentication key for BGP configuration.

Returns:

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

amazonAddress

AllocatePrivateVirtualInterfaceResponse.Builder amazonAddress(String amazonAddress)

The IP address assigned to the Amazon interface.

Parameters:

amazonAddress - The IP address assigned to the Amazon interface.

Returns:

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

customerAddress

AllocatePrivateVirtualInterfaceResponse.Builder customerAddress(String customerAddress)

The IP address assigned to the customer interface.

Parameters:

customerAddress - The IP address assigned to the customer interface.

Returns:

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

addressFamily

AllocatePrivateVirtualInterfaceResponse.Builder addressFamily(String addressFamily)

The address family for the BGP peer.

Parameters:

addressFamily - The address family for the BGP peer.

Returns:

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

See Also:

AddressFamily, AddressFamily

addressFamily

AllocatePrivateVirtualInterfaceResponse.Builder addressFamily(AddressFamily addressFamily)

The address family for the BGP peer.

Parameters:

addressFamily - The address family for the BGP peer.

Returns:

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

See Also:

AddressFamily, AddressFamily

virtualInterfaceState

AllocatePrivateVirtualInterfaceResponse.Builder virtualInterfaceState(String virtualInterfaceState)

The state of the virtual interface. The following are the possible values:

• confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

• verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

• pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

• available: A virtual interface that is able to forward traffic.

• down: A virtual interface that is BGP down.

• deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

• deleted: A virtual interface that cannot forward traffic.

• rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

Parameters:

virtualInterfaceState - The state of the virtual interface. The following are the possible values:

• confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

• verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

• pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

• available: A virtual interface that is able to forward traffic.

• down: A virtual interface that is BGP down.

• deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

• deleted: A virtual interface that cannot forward traffic.

• rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

Returns:

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

See Also:

VirtualInterfaceState, VirtualInterfaceState

virtualInterfaceState

AllocatePrivateVirtualInterfaceResponse.Builder virtualInterfaceState(VirtualInterfaceState virtualInterfaceState)

The state of the virtual interface. The following are the possible values:

• confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

• verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

• pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

• available: A virtual interface that is able to forward traffic.

• down: A virtual interface that is BGP down.

• deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

• deleted: A virtual interface that cannot forward traffic.

• rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

Parameters:

virtualInterfaceState - The state of the virtual interface. The following are the possible values:

• confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

• verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

• pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

• available: A virtual interface that is able to forward traffic.

• down: A virtual interface that is BGP down.

• deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

• deleted: A virtual interface that cannot forward traffic.

• rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

Returns:

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

See Also:

VirtualInterfaceState, VirtualInterfaceState

customerRouterConfig

AllocatePrivateVirtualInterfaceResponse.Builder customerRouterConfig(String customerRouterConfig)

The customer router configuration.

Parameters:

customerRouterConfig - The customer router configuration.

Returns:

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

mtu

AllocatePrivateVirtualInterfaceResponse.Builder mtu(Integer mtu)

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

Parameters:

mtu - The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

Returns:

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

jumboFrameCapable

AllocatePrivateVirtualInterfaceResponse.Builder jumboFrameCapable(Boolean jumboFrameCapable)

Indicates whether jumbo frames (9001 MTU) are supported.

Parameters:

jumboFrameCapable - Indicates whether jumbo frames (9001 MTU) are supported.

Returns:

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

virtualGatewayId

AllocatePrivateVirtualInterfaceResponse.Builder virtualGatewayId(String virtualGatewayId)

The ID of the virtual private gateway. Applies only to private virtual interfaces.

Parameters:

virtualGatewayId - The ID of the virtual private gateway. Applies only to private virtual interfaces.

Returns:

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

directConnectGatewayId

AllocatePrivateVirtualInterfaceResponse.Builder directConnectGatewayId(String directConnectGatewayId)

The ID of the Direct Connect gateway.

Parameters:

directConnectGatewayId - The ID of the Direct Connect gateway.

Returns:

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

routeFilterPrefixes

AllocatePrivateVirtualInterfaceResponse.Builder routeFilterPrefixes(Collection<RouteFilterPrefix> routeFilterPrefixes)

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

Parameters:

routeFilterPrefixes - The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

Returns:

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

routeFilterPrefixes

AllocatePrivateVirtualInterfaceResponse.Builder routeFilterPrefixes(RouteFilterPrefix... routeFilterPrefixes)

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

Parameters:

routeFilterPrefixes - The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

Returns:

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

routeFilterPrefixes

AllocatePrivateVirtualInterfaceResponse.Builder routeFilterPrefixes(Consumer<RouteFilterPrefix.Builder>... routeFilterPrefixes)

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #routeFilterPrefixes(List).

Parameters:

routeFilterPrefixes - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#routeFilterPrefixes(List)

bgpPeers

AllocatePrivateVirtualInterfaceResponse.Builder bgpPeers(Collection<BGPPeer> bgpPeers)

The BGP peers configured on this virtual interface.

Parameters:

bgpPeers - The BGP peers configured on this virtual interface.

Returns:

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

bgpPeers

AllocatePrivateVirtualInterfaceResponse.Builder bgpPeers(BGPPeer... bgpPeers)

The BGP peers configured on this virtual interface.

Parameters:

bgpPeers - The BGP peers configured on this virtual interface.

Returns:

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

bgpPeers

AllocatePrivateVirtualInterfaceResponse.Builder bgpPeers(Consumer<BGPPeer.Builder>... bgpPeers)

The BGP peers configured on this virtual interface.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #bgpPeers(List).

Parameters:

bgpPeers - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#bgpPeers(List)

region

AllocatePrivateVirtualInterfaceResponse.Builder region(String region)

The AWS Region where the virtual interface is located.

Parameters:

region - The AWS Region where the virtual interface is located.

Returns:

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

awsDeviceV2

AllocatePrivateVirtualInterfaceResponse.Builder awsDeviceV2(String awsDeviceV2)

The Direct Connect endpoint on which the virtual interface terminates.

Parameters:

awsDeviceV2 - The Direct Connect endpoint on which the virtual interface terminates.

Returns:

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