amazonka-directconnect-2.0: Amazon Direct Connect SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DirectConnect.AssociateVirtualInterface

Description

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.

Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.

To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.

Synopsis

Creating a Request

data AssociateVirtualInterface Source #

See: newAssociateVirtualInterface smart constructor.

Constructors

AssociateVirtualInterface' 

Fields

Instances

Instances details
ToJSON AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

ToHeaders AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

ToPath AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

ToQuery AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

AWSRequest AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

Generic AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

Associated Types

type Rep AssociateVirtualInterface :: Type -> Type #

Read AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

Show AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

NFData AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

Eq AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

Hashable AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

type AWSResponse AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

type Rep AssociateVirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.AssociateVirtualInterface

type Rep AssociateVirtualInterface = D1 ('MetaData "AssociateVirtualInterface" "Amazonka.DirectConnect.AssociateVirtualInterface" "amazonka-directconnect-2.0-L3DT8JGnMceEIS37MHoczF" 'False) (C1 ('MetaCons "AssociateVirtualInterface'" 'PrefixI 'True) (S1 ('MetaSel ('Just "virtualInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newAssociateVirtualInterface Source #

Create a value of AssociateVirtualInterface with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociateVirtualInterface, associateVirtualInterface_virtualInterfaceId - The ID of the virtual interface.

AssociateVirtualInterface, associateVirtualInterface_connectionId - The ID of the LAG or connection.

Request Lenses

Destructuring the Response

data VirtualInterface Source #

Information about a virtual interface.

See: newVirtualInterface smart constructor.

Constructors

VirtualInterface' 

Fields

  • addressFamily :: Maybe AddressFamily

    The address family for the BGP peer.

  • amazonAddress :: Maybe Text

    The IP address assigned to the Amazon interface.

  • amazonSideAsn :: Maybe Integer

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

  • asn :: Maybe Int

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

    The valid values are 1-2147483647.

  • authKey :: Maybe Text

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

  • awsDeviceV2 :: Maybe Text

    The Direct Connect endpoint that terminates the physical connection.

  • awsLogicalDeviceId :: Maybe Text

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

  • bgpPeers :: Maybe [BGPPeer]

    The BGP peers configured on this virtual interface.

  • connectionId :: Maybe Text

    The ID of the connection.

  • customerAddress :: Maybe Text

    The IP address assigned to the customer interface.

  • customerRouterConfig :: Maybe Text

    The customer router configuration.

  • directConnectGatewayId :: Maybe Text

    The ID of the Direct Connect gateway.

  • jumboFrameCapable :: Maybe Bool

    Indicates whether jumbo frames (9001 MTU) are supported.

  • location :: Maybe Text

    The location of the connection.

  • mtu :: Maybe Int

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

  • ownerAccount :: Maybe Text

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

  • region :: Maybe Text

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

  • routeFilterPrefixes :: Maybe [RouteFilterPrefix]

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

  • siteLinkEnabled :: Maybe Bool

    Indicates whether SiteLink is enabled.

  • tags :: Maybe (NonEmpty Tag)

    The tags associated with the virtual interface.

  • virtualGatewayId :: Maybe Text

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

  • virtualInterfaceId :: Maybe Text

    The ID of the virtual interface.

  • virtualInterfaceName :: Maybe Text

    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 (-).

  • virtualInterfaceState :: Maybe 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.
  • virtualInterfaceType :: Maybe Text

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

  • vlan :: Maybe Int

    The ID of the VLAN.

Instances

Instances details
FromJSON VirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Generic VirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Associated Types

type Rep VirtualInterface :: Type -> Type #

Read VirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Show VirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.VirtualInterface

NFData VirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Methods

rnf :: VirtualInterface -> () #

Eq VirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Hashable VirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.VirtualInterface

type Rep VirtualInterface Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.VirtualInterface

type Rep VirtualInterface = D1 ('MetaData "VirtualInterface" "Amazonka.DirectConnect.Types.VirtualInterface" "amazonka-directconnect-2.0-L3DT8JGnMceEIS37MHoczF" 'False) (C1 ('MetaCons "VirtualInterface'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "addressFamily") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AddressFamily)) :*: (S1 ('MetaSel ('Just "amazonAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "amazonSideAsn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :*: (S1 ('MetaSel ('Just "asn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "authKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "awsDeviceV2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "awsLogicalDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "bgpPeers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BGPPeer])) :*: S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "customerAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "customerRouterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "directConnectGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jumboFrameCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))) :*: (((S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "mtu") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "routeFilterPrefixes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RouteFilterPrefix])) :*: S1 ('MetaSel ('Just "siteLinkEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: (S1 ('MetaSel ('Just "virtualGatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "virtualInterfaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "virtualInterfaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "virtualInterfaceState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VirtualInterfaceState))) :*: (S1 ('MetaSel ('Just "virtualInterfaceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "vlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))))

newVirtualInterface :: VirtualInterface Source #

Create a value of VirtualInterface with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

VirtualInterface, virtualInterface_addressFamily - The address family for the BGP peer.

VirtualInterface, virtualInterface_amazonAddress - The IP address assigned to the Amazon interface.

$sel:amazonSideAsn:VirtualInterface', virtualInterface_amazonSideAsn - The autonomous system number (ASN) for the Amazon side of the connection.

VirtualInterface, virtualInterface_asn - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

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

VirtualInterface, virtualInterface_awsDeviceV2 - The Direct Connect endpoint that terminates the physical connection.

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

$sel:bgpPeers:VirtualInterface', virtualInterface_bgpPeers - The BGP peers configured on this virtual interface.

$sel:connectionId:VirtualInterface', virtualInterface_connectionId - The ID of the connection.

VirtualInterface, virtualInterface_customerAddress - The IP address assigned to the customer interface.

$sel:customerRouterConfig:VirtualInterface', virtualInterface_customerRouterConfig - The customer router configuration.

$sel:directConnectGatewayId:VirtualInterface', virtualInterface_directConnectGatewayId - The ID of the Direct Connect gateway.

$sel:jumboFrameCapable:VirtualInterface', virtualInterface_jumboFrameCapable - Indicates whether jumbo frames (9001 MTU) are supported.

$sel:location:VirtualInterface', virtualInterface_location - The location of the connection.

$sel:mtu:VirtualInterface', virtualInterface_mtu - The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

$sel:ownerAccount:VirtualInterface', virtualInterface_ownerAccount - The ID of the Amazon Web Services account that owns the virtual interface.

$sel:region:VirtualInterface', virtualInterface_region - The Amazon Web Services Region where the virtual interface is located.

$sel:routeFilterPrefixes:VirtualInterface', virtualInterface_routeFilterPrefixes - The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

$sel:siteLinkEnabled:VirtualInterface', virtualInterface_siteLinkEnabled - Indicates whether SiteLink is enabled.

$sel:tags:VirtualInterface', virtualInterface_tags - The tags associated with the virtual interface.

$sel:virtualGatewayId:VirtualInterface', virtualInterface_virtualGatewayId - The ID of the virtual private gateway. Applies only to private virtual interfaces.

$sel:virtualInterfaceId:VirtualInterface', virtualInterface_virtualInterfaceId - The ID of the virtual interface.

$sel:virtualInterfaceName:VirtualInterface', virtualInterface_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 (-).

$sel:virtualInterfaceState:VirtualInterface', virtualInterface_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.

$sel:virtualInterfaceType:VirtualInterface', virtualInterface_virtualInterfaceType - The type of virtual interface. The possible values are private and public.

$sel:vlan:VirtualInterface', virtualInterface_vlan - The ID of the VLAN.

Response Lenses

virtualInterface_amazonAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the Amazon interface.

virtualInterface_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer) Source #

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

virtualInterface_asn :: Lens' VirtualInterface (Maybe Int) Source #

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

The valid values are 1-2147483647.

virtualInterface_authKey :: Lens' VirtualInterface (Maybe Text) Source #

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

virtualInterface_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

virtualInterface_awsLogicalDeviceId :: Lens' VirtualInterface (Maybe Text) Source #

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

virtualInterface_bgpPeers :: Lens' VirtualInterface (Maybe [BGPPeer]) Source #

The BGP peers configured on this virtual interface.

virtualInterface_customerAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

virtualInterface_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

virtualInterface_location :: Lens' VirtualInterface (Maybe Text) Source #

The location of the connection.

virtualInterface_mtu :: Lens' VirtualInterface (Maybe Int) Source #

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

virtualInterface_ownerAccount :: Lens' VirtualInterface (Maybe Text) Source #

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

virtualInterface_region :: Lens' VirtualInterface (Maybe Text) Source #

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

virtualInterface_routeFilterPrefixes :: Lens' VirtualInterface (Maybe [RouteFilterPrefix]) Source #

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

virtualInterface_siteLinkEnabled :: Lens' VirtualInterface (Maybe Bool) Source #

Indicates whether SiteLink is enabled.

virtualInterface_tags :: Lens' VirtualInterface (Maybe (NonEmpty Tag)) Source #

The tags associated with the virtual interface.

virtualInterface_virtualGatewayId :: Lens' VirtualInterface (Maybe Text) Source #

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

virtualInterface_virtualInterfaceName :: Lens' VirtualInterface (Maybe Text) Source #

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 (-).

virtualInterface_virtualInterfaceState :: Lens' VirtualInterface (Maybe VirtualInterfaceState) Source #

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.

virtualInterface_virtualInterfaceType :: Lens' VirtualInterface (Maybe Text) Source #

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