Package software.amazon.awssdk.services.directconnect.model

Interface AllocatePublicVirtualInterfaceResponse.Builder

    • Method Detail

      • ownerAccount

        AllocatePublicVirtualInterfaceResponse.Builder ownerAccount​(String ownerAccount)

        The ID of the Amazon Web Services account that owns the virtual interface.

        Parameters:
        ownerAccount - The ID of the Amazon Web Services account that owns the virtual interface.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • virtualInterfaceId

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

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

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

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

        AllocatePublicVirtualInterfaceResponse.Builder virtualInterfaceName​(String virtualInterfaceName)

        The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

        Parameters:
        virtualInterfaceName - The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • asn

        AllocatePublicVirtualInterfaceResponse.Builder asn​(Integer asn)

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

        The valid values are 1-2147483647.

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

        The valid values are 1-2147483647.

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

      • amazonSideAsn

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

        AllocatePublicVirtualInterfaceResponse.Builder authKey​(String authKey)

        The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

        Parameters:
        authKey - The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • amazonAddress

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

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

      • virtualInterfaceState

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

        • unknown: The state of the virtual interface is not available.

        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.

        • unknown: The state of the virtual interface is not available.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        VirtualInterfaceState, VirtualInterfaceState

      • virtualInterfaceState

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

        • unknown: The state of the virtual interface is not available.

        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.

        • unknown: The state of the virtual interface is not available.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        VirtualInterfaceState, VirtualInterfaceState

      • customerRouterConfig

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

        AllocatePublicVirtualInterfaceResponse.Builder mtu​(Integer mtu)

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

        Parameters:
        mtu - The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jumboFrameCapable

        AllocatePublicVirtualInterfaceResponse.Builder jumboFrameCapable​(Boolean jumboFrameCapable)

        Indicates whether jumbo frames are supported.

        Parameters:
        jumboFrameCapable - Indicates whether jumbo frames are supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • virtualGatewayId

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

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

        AllocatePublicVirtualInterfaceResponse.Builder routeFilterPrefixes​(Collection<RouteFilterPrefix> routeFilterPrefixes)

        The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

        Parameters:
        routeFilterPrefixes - The routes to be advertised to the Amazon Web Services 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

        AllocatePublicVirtualInterfaceResponse.Builder routeFilterPrefixes​(RouteFilterPrefix... routeFilterPrefixes)

        The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

        Parameters:
        routeFilterPrefixes - The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • bgpPeers

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

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

      • region

        AllocatePublicVirtualInterfaceResponse.Builder region​(String region)

        The Amazon Web Services Region where the virtual interface is located.

        Parameters:
        region - The Amazon Web Services Region where the virtual interface is located.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • awsDeviceV2

        AllocatePublicVirtualInterfaceResponse.Builder awsDeviceV2​(String awsDeviceV2)

        The Direct Connect endpoint that terminates the physical connection.

        Parameters:
        awsDeviceV2 - The Direct Connect endpoint that terminates the physical connection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • awsLogicalDeviceId

        AllocatePublicVirtualInterfaceResponse.Builder awsLogicalDeviceId​(String awsLogicalDeviceId)

        The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

        Parameters:
        awsLogicalDeviceId - The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        AllocatePublicVirtualInterfaceResponse.Builder tags​(Tag... tags)

        The tags associated with the virtual interface.

        Parameters:
        tags - The tags associated with the virtual interface.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • siteLinkEnabled

        AllocatePublicVirtualInterfaceResponse.Builder siteLinkEnabled​(Boolean siteLinkEnabled)

        Indicates whether SiteLink is enabled.

        Parameters:
        siteLinkEnabled - Indicates whether SiteLink is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.