Amazonka.DirectConnect.AllocatePublicVirtualInterface

Provisions a public virtual interface to be owned by the specified Amazon Web Services account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account.

Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

Creating a Request

data AllocatePublicVirtualInterface

See: newAllocatePublicVirtualInterface smart constructor.

Constructors

AllocatePublicVirtualInterface'

Fields

• connectionId :: Text

  The ID of the connection on which the public virtual interface is provisioned.

• ownerAccount :: Text

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

• newPublicVirtualInterfaceAllocation' :: NewPublicVirtualInterfaceAllocation

  Information about the public virtual interface.

Instances

ToJSON AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Methods

toJSON :: AllocatePublicVirtualInterface -> Value

toEncoding :: AllocatePublicVirtualInterface -> Encoding

toJSONList :: [AllocatePublicVirtualInterface] -> Value

toEncodingList :: [AllocatePublicVirtualInterface] -> Encoding

ToHeaders AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Methods

toHeaders :: AllocatePublicVirtualInterface -> [Header]

ToPath AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Methods

toPath :: AllocatePublicVirtualInterface -> ByteString

ToQuery AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Methods

toQuery :: AllocatePublicVirtualInterface -> QueryString

AWSRequest AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Associated Types

type AWSResponse AllocatePublicVirtualInterface

Methods

request :: (Service -> Service) -> AllocatePublicVirtualInterface -> Request AllocatePublicVirtualInterface

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AllocatePublicVirtualInterface -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AllocatePublicVirtualInterface)))

Generic AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Associated Types

type Rep AllocatePublicVirtualInterface :: Type -> Type

Methods

from :: AllocatePublicVirtualInterface -> Rep AllocatePublicVirtualInterface x

to :: Rep AllocatePublicVirtualInterface x -> AllocatePublicVirtualInterface

Read AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Methods

readsPrec :: Int -> ReadS AllocatePublicVirtualInterface

readList :: ReadS [AllocatePublicVirtualInterface]

readPrec :: ReadPrec AllocatePublicVirtualInterface

readListPrec :: ReadPrec [AllocatePublicVirtualInterface]

Show AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Methods

showsPrec :: Int -> AllocatePublicVirtualInterface -> ShowS

show :: AllocatePublicVirtualInterface -> String

showList :: [AllocatePublicVirtualInterface] -> ShowS

NFData AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Methods

rnf :: AllocatePublicVirtualInterface -> ()

Eq AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Methods

(==) :: AllocatePublicVirtualInterface -> AllocatePublicVirtualInterface -> Bool

(/=) :: AllocatePublicVirtualInterface -> AllocatePublicVirtualInterface -> Bool

Hashable AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

Methods

hashWithSalt :: Int -> AllocatePublicVirtualInterface -> Int

hash :: AllocatePublicVirtualInterface -> Int

type AWSResponse AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

type AWSResponse AllocatePublicVirtualInterface = VirtualInterface

type Rep AllocatePublicVirtualInterface

Defined in Amazonka.DirectConnect.AllocatePublicVirtualInterface

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

newAllocatePublicVirtualInterface

Arguments

:: Text

AllocatePublicVirtualInterface

-> Text

AllocatePublicVirtualInterface

-> NewPublicVirtualInterfaceAllocation

$sel:newPublicVirtualInterfaceAllocation':AllocatePublicVirtualInterface'

-> AllocatePublicVirtualInterface

Create a value of AllocatePublicVirtualInterface 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:

AllocatePublicVirtualInterface, allocatePublicVirtualInterface_connectionId - The ID of the connection on which the public virtual interface is provisioned.

AllocatePublicVirtualInterface, allocatePublicVirtualInterface_ownerAccount - The ID of the Amazon Web Services account that owns the public virtual interface.

$sel:newPublicVirtualInterfaceAllocation':AllocatePublicVirtualInterface', allocatePublicVirtualInterface_newPublicVirtualInterfaceAllocation - Information about the public virtual interface.

Request Lenses

allocatePublicVirtualInterface_connectionId :: Lens' AllocatePublicVirtualInterface Text

The ID of the connection on which the public virtual interface is provisioned.

allocatePublicVirtualInterface_ownerAccount :: Lens' AllocatePublicVirtualInterface Text

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

allocatePublicVirtualInterface_newPublicVirtualInterfaceAllocation :: Lens' AllocatePublicVirtualInterface NewPublicVirtualInterfaceAllocation

Information about the public virtual interface.

Destructuring the Response

data VirtualInterface

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

FromJSON VirtualInterface

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Methods

parseJSON :: Value -> Parser VirtualInterface

parseJSONList :: Value -> Parser [VirtualInterface]

Generic VirtualInterface

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Associated Types

type Rep VirtualInterface :: Type -> Type

Methods

from :: VirtualInterface -> Rep VirtualInterface x

to :: Rep VirtualInterface x -> VirtualInterface

Read VirtualInterface

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Methods

readsPrec :: Int -> ReadS VirtualInterface

readList :: ReadS [VirtualInterface]

readPrec :: ReadPrec VirtualInterface

readListPrec :: ReadPrec [VirtualInterface]

Show VirtualInterface

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Methods

showsPrec :: Int -> VirtualInterface -> ShowS

show :: VirtualInterface -> String

showList :: [VirtualInterface] -> ShowS

NFData VirtualInterface

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Methods

rnf :: VirtualInterface -> ()

Eq VirtualInterface

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Methods

(==) :: VirtualInterface -> VirtualInterface -> Bool

(/=) :: VirtualInterface -> VirtualInterface -> Bool

Hashable VirtualInterface

Defined in Amazonka.DirectConnect.Types.VirtualInterface

Methods

hashWithSalt :: Int -> VirtualInterface -> Int

hash :: VirtualInterface -> Int

type Rep VirtualInterface

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

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_addressFamily :: Lens' VirtualInterface (Maybe AddressFamily)

The address family for the BGP peer.

virtualInterface_amazonAddress :: Lens' VirtualInterface (Maybe Text)

The IP address assigned to the Amazon interface.

virtualInterface_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer)

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

virtualInterface_asn :: Lens' VirtualInterface (Maybe Int)

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

The valid values are 1-2147483647.

virtualInterface_authKey :: Lens' VirtualInterface (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.

virtualInterface_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text)

The Direct Connect endpoint that terminates the physical connection.

virtualInterface_awsLogicalDeviceId :: Lens' VirtualInterface (Maybe Text)

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])

The BGP peers configured on this virtual interface.

virtualInterface_connectionId :: Lens' VirtualInterface (Maybe Text)

The ID of the connection.

virtualInterface_customerAddress :: Lens' VirtualInterface (Maybe Text)

The IP address assigned to the customer interface.

virtualInterface_customerRouterConfig :: Lens' VirtualInterface (Maybe Text)

The customer router configuration.

virtualInterface_directConnectGatewayId :: Lens' VirtualInterface (Maybe Text)

The ID of the Direct Connect gateway.

virtualInterface_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool)

Indicates whether jumbo frames (9001 MTU) are supported.

virtualInterface_location :: Lens' VirtualInterface (Maybe Text)

The location of the connection.

virtualInterface_mtu :: Lens' VirtualInterface (Maybe Int)

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)

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

virtualInterface_region :: Lens' VirtualInterface (Maybe Text)

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

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

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)

Indicates whether SiteLink is enabled.

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

The tags associated with the virtual interface.

virtualInterface_virtualGatewayId :: Lens' VirtualInterface (Maybe Text)

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

virtualInterface_virtualInterfaceId :: Lens' VirtualInterface (Maybe Text)

The ID of the virtual interface.

virtualInterface_virtualInterfaceName :: Lens' VirtualInterface (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 (-).

virtualInterface_virtualInterfaceState :: Lens' VirtualInterface (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.

virtualInterface_virtualInterfaceType :: Lens' VirtualInterface (Maybe Text)

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

virtualInterface_vlan :: Lens' VirtualInterface (Maybe Int)

The ID of the VLAN.