libZSservicesZSamazonka-directconnectZSamazonka-directconnect
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DirectConnect.Lens

Contents

Description

 
Synopsis

Operations

DescribeDirectConnectGatewayAssociations

describeDirectConnectGatewayAssociations_nextToken :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Text) Source #

The token provided in the previous call to retrieve the next page.

describeDirectConnectGatewayAssociations_maxResults :: Lens' DescribeDirectConnectGatewayAssociations (Maybe Int) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

DescribeInterconnects

DescribeTags

describeTags_resourceArns :: Lens' DescribeTags [Text] Source #

The Amazon Resource Names (ARNs) of the resources.

CreateTransitVirtualInterface

DescribeLoa

describeLoa_loaContentType :: Lens' DescribeLoa (Maybe LoaContentType) Source #

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

describeLoa_providerName :: Lens' DescribeLoa (Maybe Text) Source #

The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

describeLoa_connectionId :: Lens' DescribeLoa Text Source #

The ID of a connection, LAG, or interconnect.

describeLoaResponse_loaContent :: Lens' DescribeLoaResponse (Maybe ByteString) Source #

The binary contents of the LOA-CFA document.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

describeLoaResponse_loaContentType :: Lens' DescribeLoaResponse (Maybe LoaContentType) Source #

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

DisassociateMacSecKey

disassociateMacSecKey_connectionId :: Lens' DisassociateMacSecKey Text Source #

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

disassociateMacSecKey_secretARN :: Lens' DisassociateMacSecKey Text Source #

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.

disassociateMacSecKeyResponse_connectionId :: Lens' DisassociateMacSecKeyResponse (Maybe Text) Source #

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

disassociateMacSecKeyResponse_macSecKeys :: Lens' DisassociateMacSecKeyResponse (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys no longer associated with the dedicated connection.

DeleteConnection

connection_macSecCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether the connection supports MAC Security (MACsec).

connection_portEncryptionStatus :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

connection_vlan :: Lens' Connection (Maybe Int) Source #

The ID of the VLAN.

connection_location :: Lens' Connection (Maybe Text) Source #

The location of the connection.

connection_awsDevice :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

connection_hasLogicalRedundancy :: Lens' Connection (Maybe HasLogicalRedundancy) Source #

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

connection_connectionId :: Lens' Connection (Maybe Text) Source #

The ID of the connection.

connection_awsLogicalDeviceId :: Lens' Connection (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.

connection_loaIssueTime :: Lens' Connection (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

connection_partnerName :: Lens' Connection (Maybe Text) Source #

The name of the Direct Connect service provider associated with the connection.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The name of the connection.

connection_encryptionMode :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

connection_bandwidth :: Lens' Connection (Maybe Text) Source #

The bandwidth of the connection.

connection_jumboFrameCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

connection_ownerAccount :: Lens' Connection (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the connection.

connection_region :: Lens' Connection (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

connection_macSecKeys :: Lens' Connection (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the connection.

connection_providerName :: Lens' Connection (Maybe Text) Source #

The name of the service provider associated with the connection.

connection_awsDeviceV2 :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

connection_connectionState :: Lens' Connection (Maybe ConnectionState) Source #

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The connection has been approved and is being initialized.
  • available: The network link is up and the connection is ready for use.
  • down: The network link is down.
  • deleting: The connection is being deleted.
  • deleted: The connection has been deleted.
  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  • unknown: The state of the connection is not available.

connection_tags :: Lens' Connection (Maybe (NonEmpty Tag)) Source #

The tags associated with the connection.

UpdateConnection

updateConnection_encryptionMode :: Lens' UpdateConnection (Maybe Text) Source #

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

updateConnection_connectionId :: Lens' UpdateConnection Text Source #

The ID of the dedicated connection.

You can use DescribeConnections to retrieve the connection ID.

connection_macSecCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether the connection supports MAC Security (MACsec).

connection_portEncryptionStatus :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

connection_vlan :: Lens' Connection (Maybe Int) Source #

The ID of the VLAN.

connection_location :: Lens' Connection (Maybe Text) Source #

The location of the connection.

connection_awsDevice :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

connection_hasLogicalRedundancy :: Lens' Connection (Maybe HasLogicalRedundancy) Source #

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

connection_connectionId :: Lens' Connection (Maybe Text) Source #

The ID of the connection.

connection_awsLogicalDeviceId :: Lens' Connection (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.

connection_loaIssueTime :: Lens' Connection (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

connection_partnerName :: Lens' Connection (Maybe Text) Source #

The name of the Direct Connect service provider associated with the connection.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The name of the connection.

connection_encryptionMode :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

connection_bandwidth :: Lens' Connection (Maybe Text) Source #

The bandwidth of the connection.

connection_jumboFrameCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

connection_ownerAccount :: Lens' Connection (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the connection.

connection_region :: Lens' Connection (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

connection_macSecKeys :: Lens' Connection (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the connection.

connection_providerName :: Lens' Connection (Maybe Text) Source #

The name of the service provider associated with the connection.

connection_awsDeviceV2 :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

connection_connectionState :: Lens' Connection (Maybe ConnectionState) Source #

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The connection has been approved and is being initialized.
  • available: The network link is up and the connection is ready for use.
  • down: The network link is down.
  • deleting: The connection is being deleted.
  • deleted: The connection has been deleted.
  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  • unknown: The state of the connection is not available.

connection_tags :: Lens' Connection (Maybe (NonEmpty Tag)) Source #

The tags associated with the connection.

StartBgpFailoverTest

startBgpFailoverTest_bgpPeers :: Lens' StartBgpFailoverTest (Maybe [Text]) Source #

The BGP peers to place in the DOWN state.

startBgpFailoverTest_testDurationInMinutes :: Lens' StartBgpFailoverTest (Maybe Int) Source #

The time in minutes that the virtual interface failover test will last.

Maximum value: 180 minutes (3 hours).

Default: 180 minutes (3 hours).

startBgpFailoverTest_virtualInterfaceId :: Lens' StartBgpFailoverTest Text Source #

The ID of the virtual interface you want to test.

UpdateVirtualInterfaceAttributes

updateVirtualInterfaceAttributes_mtu :: Lens' UpdateVirtualInterfaceAttributes (Maybe Int) Source #

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

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

The BGP peers configured on this virtual interface.

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

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

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_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_customerAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

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

The location of the connection.

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

The IP address assigned to the Amazon interface.

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_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_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer) Source #

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

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

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

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_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

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_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_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

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

The tags associated with the virtual interface.

AssociateConnectionWithLag

associateConnectionWithLag_lagId :: Lens' AssociateConnectionWithLag Text Source #

The ID of the LAG with which to associate the connection.

connection_macSecCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether the connection supports MAC Security (MACsec).

connection_portEncryptionStatus :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

connection_vlan :: Lens' Connection (Maybe Int) Source #

The ID of the VLAN.

connection_location :: Lens' Connection (Maybe Text) Source #

The location of the connection.

connection_awsDevice :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

connection_hasLogicalRedundancy :: Lens' Connection (Maybe HasLogicalRedundancy) Source #

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

connection_connectionId :: Lens' Connection (Maybe Text) Source #

The ID of the connection.

connection_awsLogicalDeviceId :: Lens' Connection (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.

connection_loaIssueTime :: Lens' Connection (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

connection_partnerName :: Lens' Connection (Maybe Text) Source #

The name of the Direct Connect service provider associated with the connection.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The name of the connection.

connection_encryptionMode :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

connection_bandwidth :: Lens' Connection (Maybe Text) Source #

The bandwidth of the connection.

connection_jumboFrameCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

connection_ownerAccount :: Lens' Connection (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the connection.

connection_region :: Lens' Connection (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

connection_macSecKeys :: Lens' Connection (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the connection.

connection_providerName :: Lens' Connection (Maybe Text) Source #

The name of the service provider associated with the connection.

connection_awsDeviceV2 :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

connection_connectionState :: Lens' Connection (Maybe ConnectionState) Source #

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The connection has been approved and is being initialized.
  • available: The network link is up and the connection is ready for use.
  • down: The network link is down.
  • deleting: The connection is being deleted.
  • deleted: The connection has been deleted.
  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  • unknown: The state of the connection is not available.

connection_tags :: Lens' Connection (Maybe (NonEmpty Tag)) Source #

The tags associated with the connection.

CreateDirectConnectGatewayAssociationProposal

CreateConnection

createConnection_requestMACSec :: Lens' CreateConnection (Maybe Bool) Source #

Indicates whether you want the connection to support MAC Security (MACsec).

MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

createConnection_providerName :: Lens' CreateConnection (Maybe Text) Source #

The name of the service provider associated with the requested connection.

createConnection_tags :: Lens' CreateConnection (Maybe (NonEmpty Tag)) Source #

The tags to associate with the lag.

createConnection_location :: Lens' CreateConnection Text Source #

The location of the connection.

createConnection_bandwidth :: Lens' CreateConnection Text Source #

The bandwidth of the connection.

connection_macSecCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether the connection supports MAC Security (MACsec).

connection_portEncryptionStatus :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

connection_vlan :: Lens' Connection (Maybe Int) Source #

The ID of the VLAN.

connection_location :: Lens' Connection (Maybe Text) Source #

The location of the connection.

connection_awsDevice :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

connection_hasLogicalRedundancy :: Lens' Connection (Maybe HasLogicalRedundancy) Source #

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

connection_connectionId :: Lens' Connection (Maybe Text) Source #

The ID of the connection.

connection_awsLogicalDeviceId :: Lens' Connection (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.

connection_loaIssueTime :: Lens' Connection (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

connection_partnerName :: Lens' Connection (Maybe Text) Source #

The name of the Direct Connect service provider associated with the connection.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The name of the connection.

connection_encryptionMode :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

connection_bandwidth :: Lens' Connection (Maybe Text) Source #

The bandwidth of the connection.

connection_jumboFrameCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

connection_ownerAccount :: Lens' Connection (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the connection.

connection_region :: Lens' Connection (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

connection_macSecKeys :: Lens' Connection (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the connection.

connection_providerName :: Lens' Connection (Maybe Text) Source #

The name of the service provider associated with the connection.

connection_awsDeviceV2 :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

connection_connectionState :: Lens' Connection (Maybe ConnectionState) Source #

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The connection has been approved and is being initialized.
  • available: The network link is up and the connection is ready for use.
  • down: The network link is down.
  • deleting: The connection is being deleted.
  • deleted: The connection has been deleted.
  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  • unknown: The state of the connection is not available.

connection_tags :: Lens' Connection (Maybe (NonEmpty Tag)) Source #

The tags associated with the connection.

DescribeDirectConnectGateways

describeDirectConnectGateways_nextToken :: Lens' DescribeDirectConnectGateways (Maybe Text) Source #

The token provided in the previous call to retrieve the next page.

describeDirectConnectGateways_maxResults :: Lens' DescribeDirectConnectGateways (Maybe Int) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

AssociateVirtualInterface

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

The BGP peers configured on this virtual interface.

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

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

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_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_customerAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

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

The location of the connection.

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

The IP address assigned to the Amazon interface.

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_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_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer) Source #

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

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

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

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_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

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_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_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

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

The tags associated with the virtual interface.

DescribeConnections

ConfirmCustomerAgreement

confirmCustomerAgreementResponse_status :: Lens' ConfirmCustomerAgreementResponse (Maybe Text) Source #

The status of the customer agreement when the connection was created. This will be either signed or unsigned.

DeleteInterconnect

deleteInterconnectResponse_interconnectState :: Lens' DeleteInterconnectResponse (Maybe InterconnectState) Source #

The state of the interconnect. The following are the possible values:

  • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The interconnect is approved, and is being initialized.
  • available: The network link is up, and the interconnect is ready for use.
  • down: The network link is down.
  • deleting: The interconnect is being deleted.
  • deleted: The interconnect is deleted.
  • unknown: The state of the interconnect is not available.

ConfirmPrivateVirtualInterface

confirmPrivateVirtualInterfaceResponse_virtualInterfaceState :: Lens' ConfirmPrivateVirtualInterfaceResponse (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.

UpdateDirectConnectGatewayAssociation

DeleteDirectConnectGatewayAssociation

DescribeLocations

CreateDirectConnectGatewayAssociation

createDirectConnectGatewayAssociation_addAllowedPrefixesToDirectConnectGateway :: Lens' CreateDirectConnectGatewayAssociation (Maybe [RouteFilterPrefix]) Source #

The Amazon VPC prefixes to advertise to the Direct Connect gateway

This parameter is required when you create an association to a transit gateway.

For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

AcceptDirectConnectGatewayAssociationProposal

acceptDirectConnectGatewayAssociationProposal_overrideAllowedPrefixesToDirectConnectGateway :: Lens' AcceptDirectConnectGatewayAssociationProposal (Maybe [RouteFilterPrefix]) Source #

Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

acceptDirectConnectGatewayAssociationProposal_associatedGatewayOwnerAccount :: Lens' AcceptDirectConnectGatewayAssociationProposal Text Source #

The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway.

CreatePublicVirtualInterface

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

The BGP peers configured on this virtual interface.

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

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

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_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_customerAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

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

The location of the connection.

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

The IP address assigned to the Amazon interface.

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_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_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer) Source #

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

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

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

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_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

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_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_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

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

The tags associated with the virtual interface.

AssociateMacSecKey

associateMacSecKey_ckn :: Lens' AssociateMacSecKey (Maybe Text) Source #

The MAC Security (MACsec) CKN to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

associateMacSecKey_cak :: Lens' AssociateMacSecKey (Maybe Text) Source #

The MAC Security (MACsec) CAK to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

associateMacSecKey_secretARN :: Lens' AssociateMacSecKey (Maybe Text) Source #

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

If you use this request parameter, you do not use the ckn and cak request parameters.

associateMacSecKey_connectionId :: Lens' AssociateMacSecKey Text Source #

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

associateMacSecKeyResponse_connectionId :: Lens' AssociateMacSecKeyResponse (Maybe Text) Source #

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

associateMacSecKeyResponse_macSecKeys :: Lens' AssociateMacSecKeyResponse (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the dedicated connection.

AllocatePrivateVirtualInterface

allocatePrivateVirtualInterface_connectionId :: Lens' AllocatePrivateVirtualInterface Text Source #

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

allocatePrivateVirtualInterface_ownerAccount :: Lens' AllocatePrivateVirtualInterface Text Source #

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

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

The BGP peers configured on this virtual interface.

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

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

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_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_customerAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

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

The location of the connection.

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

The IP address assigned to the Amazon interface.

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_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_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer) Source #

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

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

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

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_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

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_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_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

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

The tags associated with the virtual interface.

DescribeLags

ConfirmConnection

confirmConnectionResponse_connectionState :: Lens' ConfirmConnectionResponse (Maybe ConnectionState) Source #

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The connection has been approved and is being initialized.
  • available: The network link is up and the connection is ready for use.
  • down: The network link is down.
  • deleting: The connection is being deleted.
  • deleted: The connection has been deleted.
  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  • unknown: The state of the connection is not available.

DescribeDirectConnectGatewayAttachments

describeDirectConnectGatewayAttachments_nextToken :: Lens' DescribeDirectConnectGatewayAttachments (Maybe Text) Source #

The token provided in the previous call to retrieve the next page.

describeDirectConnectGatewayAttachments_maxResults :: Lens' DescribeDirectConnectGatewayAttachments (Maybe Int) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

DescribeCustomerMetadata

describeCustomerMetadataResponse_nniPartnerType :: Lens' DescribeCustomerMetadataResponse (Maybe NniPartnerType) Source #

The type of network-to-network interface (NNI) partner. The partner type will be one of the following:

  • V1: This partner can only allocate 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps subgigabit connections.
  • V2: This partner can only allocate 1GB, 2GB, 5GB, or 10GB hosted connections.
  • nonPartner: The customer is not a partner.

ConfirmPublicVirtualInterface

confirmPublicVirtualInterfaceResponse_virtualInterfaceState :: Lens' ConfirmPublicVirtualInterfaceResponse (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.

DescribeVirtualGateways

DeleteDirectConnectGatewayAssociationProposal

StopBgpFailoverTest

stopBgpFailoverTest_virtualInterfaceId :: Lens' StopBgpFailoverTest Text Source #

The ID of the virtual interface you no longer want to test.

CreateDirectConnectGateway

createDirectConnectGateway_amazonSideAsn :: Lens' CreateDirectConnectGateway (Maybe Integer) Source #

The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

DeleteDirectConnectGateway

UpdateDirectConnectGateway

DescribeVirtualInterfaces

ListVirtualInterfaceTestHistory

listVirtualInterfaceTestHistory_bgpPeers :: Lens' ListVirtualInterfaceTestHistory (Maybe [Text]) Source #

The BGP peers that were placed in the DOWN state during the virtual interface failover test.

listVirtualInterfaceTestHistory_status :: Lens' ListVirtualInterfaceTestHistory (Maybe Text) Source #

The status of the virtual interface failover test.

listVirtualInterfaceTestHistory_maxResults :: Lens' ListVirtualInterfaceTestHistory (Maybe Int) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

listVirtualInterfaceTestHistoryResponse_nextToken :: Lens' ListVirtualInterfaceTestHistoryResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

AllocateHostedConnection

allocateHostedConnection_tags :: Lens' AllocateHostedConnection (Maybe (NonEmpty Tag)) Source #

The tags associated with the connection.

allocateHostedConnection_ownerAccount :: Lens' AllocateHostedConnection Text Source #

The ID of the Amazon Web Services account ID of the customer for the connection.

allocateHostedConnection_bandwidth :: Lens' AllocateHostedConnection Text Source #

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

allocateHostedConnection_vlan :: Lens' AllocateHostedConnection Int Source #

The dedicated VLAN provisioned to the hosted connection.

connection_macSecCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether the connection supports MAC Security (MACsec).

connection_portEncryptionStatus :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

connection_vlan :: Lens' Connection (Maybe Int) Source #

The ID of the VLAN.

connection_location :: Lens' Connection (Maybe Text) Source #

The location of the connection.

connection_awsDevice :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

connection_hasLogicalRedundancy :: Lens' Connection (Maybe HasLogicalRedundancy) Source #

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

connection_connectionId :: Lens' Connection (Maybe Text) Source #

The ID of the connection.

connection_awsLogicalDeviceId :: Lens' Connection (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.

connection_loaIssueTime :: Lens' Connection (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

connection_partnerName :: Lens' Connection (Maybe Text) Source #

The name of the Direct Connect service provider associated with the connection.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The name of the connection.

connection_encryptionMode :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

connection_bandwidth :: Lens' Connection (Maybe Text) Source #

The bandwidth of the connection.

connection_jumboFrameCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

connection_ownerAccount :: Lens' Connection (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the connection.

connection_region :: Lens' Connection (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

connection_macSecKeys :: Lens' Connection (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the connection.

connection_providerName :: Lens' Connection (Maybe Text) Source #

The name of the service provider associated with the connection.

connection_awsDeviceV2 :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

connection_connectionState :: Lens' Connection (Maybe ConnectionState) Source #

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The connection has been approved and is being initialized.
  • available: The network link is up and the connection is ready for use.
  • down: The network link is down.
  • deleting: The connection is being deleted.
  • deleted: The connection has been deleted.
  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  • unknown: The state of the connection is not available.

connection_tags :: Lens' Connection (Maybe (NonEmpty Tag)) Source #

The tags associated with the connection.

DeleteVirtualInterface

deleteVirtualInterfaceResponse_virtualInterfaceState :: Lens' DeleteVirtualInterfaceResponse (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.

CreatePrivateVirtualInterface

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

The BGP peers configured on this virtual interface.

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

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

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_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_customerAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

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

The location of the connection.

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

The IP address assigned to the Amazon interface.

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_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_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer) Source #

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

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

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

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_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

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_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_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

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

The tags associated with the virtual interface.

AllocatePublicVirtualInterface

allocatePublicVirtualInterface_connectionId :: Lens' AllocatePublicVirtualInterface Text Source #

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

allocatePublicVirtualInterface_ownerAccount :: Lens' AllocatePublicVirtualInterface Text Source #

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

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

The BGP peers configured on this virtual interface.

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

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

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_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_customerAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

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

The location of the connection.

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

The IP address assigned to the Amazon interface.

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_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_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer) Source #

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

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

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

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_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

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_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_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

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

The tags associated with the virtual interface.

DescribeDirectConnectGatewayAssociationProposals

describeDirectConnectGatewayAssociationProposals_maxResults :: Lens' DescribeDirectConnectGatewayAssociationProposals (Maybe Int) Source #

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

describeDirectConnectGatewayAssociationProposalsResponse_nextToken :: Lens' DescribeDirectConnectGatewayAssociationProposalsResponse (Maybe Text) Source #

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

DisassociateConnectionFromLag

connection_macSecCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether the connection supports MAC Security (MACsec).

connection_portEncryptionStatus :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

connection_vlan :: Lens' Connection (Maybe Int) Source #

The ID of the VLAN.

connection_location :: Lens' Connection (Maybe Text) Source #

The location of the connection.

connection_awsDevice :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

connection_hasLogicalRedundancy :: Lens' Connection (Maybe HasLogicalRedundancy) Source #

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

connection_connectionId :: Lens' Connection (Maybe Text) Source #

The ID of the connection.

connection_awsLogicalDeviceId :: Lens' Connection (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.

connection_loaIssueTime :: Lens' Connection (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

connection_partnerName :: Lens' Connection (Maybe Text) Source #

The name of the Direct Connect service provider associated with the connection.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The name of the connection.

connection_encryptionMode :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

connection_bandwidth :: Lens' Connection (Maybe Text) Source #

The bandwidth of the connection.

connection_jumboFrameCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

connection_ownerAccount :: Lens' Connection (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the connection.

connection_region :: Lens' Connection (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

connection_macSecKeys :: Lens' Connection (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the connection.

connection_providerName :: Lens' Connection (Maybe Text) Source #

The name of the service provider associated with the connection.

connection_awsDeviceV2 :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

connection_connectionState :: Lens' Connection (Maybe ConnectionState) Source #

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The connection has been approved and is being initialized.
  • available: The network link is up and the connection is ready for use.
  • down: The network link is down.
  • deleting: The connection is being deleted.
  • deleted: The connection has been deleted.
  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  • unknown: The state of the connection is not available.

connection_tags :: Lens' Connection (Maybe (NonEmpty Tag)) Source #

The tags associated with the connection.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

DeleteLag

lag_lagId :: Lens' Lag (Maybe Text) Source #

The ID of the LAG.

lag_macSecCapable :: Lens' Lag (Maybe Bool) Source #

Indicates whether the LAG supports MAC Security (MACsec).

lag_connectionsBandwidth :: Lens' Lag (Maybe Text) Source #

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

lag_minimumLinks :: Lens' Lag (Maybe Int) Source #

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

lag_lagName :: Lens' Lag (Maybe Text) Source #

The name of the LAG.

lag_location :: Lens' Lag (Maybe Text) Source #

The location of the LAG.

lag_connections :: Lens' Lag (Maybe [Connection]) Source #

The connections bundled by the LAG.

lag_awsDevice :: Lens' Lag (Maybe Text) Source #

The Direct Connect endpoint that hosts the LAG.

lag_hasLogicalRedundancy :: Lens' Lag (Maybe HasLogicalRedundancy) Source #

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

lag_awsLogicalDeviceId :: Lens' Lag (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.

lag_allowsHostedConnections :: Lens' Lag (Maybe Bool) Source #

Indicates whether the LAG can host other connections.

lag_encryptionMode :: Lens' Lag (Maybe Text) Source #

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

lag_numberOfConnections :: Lens' Lag (Maybe Int) Source #

The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.

lag_jumboFrameCapable :: Lens' Lag (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

lag_lagState :: Lens' Lag (Maybe LagState) Source #

The state of the LAG. The following are the possible values:

  • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
  • pending: The LAG has been approved and is being initialized.
  • available: The network link is established and the LAG is ready for use.
  • down: The network link is down.
  • deleting: The LAG is being deleted.
  • deleted: The LAG is deleted.
  • unknown: The state of the LAG is not available.

lag_ownerAccount :: Lens' Lag (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the LAG.

lag_region :: Lens' Lag (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

lag_macSecKeys :: Lens' Lag (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the LAG.

lag_providerName :: Lens' Lag (Maybe Text) Source #

The name of the service provider associated with the LAG.

lag_awsDeviceV2 :: Lens' Lag (Maybe Text) Source #

The Direct Connect endpoint that hosts the LAG.

lag_tags :: Lens' Lag (Maybe (NonEmpty Tag)) Source #

The tags associated with the LAG.

UpdateLag

updateLag_minimumLinks :: Lens' UpdateLag (Maybe Int) Source #

The minimum number of physical connections that must be operational for the LAG itself to be operational.

updateLag_encryptionMode :: Lens' UpdateLag (Maybe Text) Source #

The LAG MAC Security (MACsec) encryption mode.

Amazon Web Services applies the value to all connections which are part of the LAG.

lag_lagId :: Lens' Lag (Maybe Text) Source #

The ID of the LAG.

lag_macSecCapable :: Lens' Lag (Maybe Bool) Source #

Indicates whether the LAG supports MAC Security (MACsec).

lag_connectionsBandwidth :: Lens' Lag (Maybe Text) Source #

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

lag_minimumLinks :: Lens' Lag (Maybe Int) Source #

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

lag_lagName :: Lens' Lag (Maybe Text) Source #

The name of the LAG.

lag_location :: Lens' Lag (Maybe Text) Source #

The location of the LAG.

lag_connections :: Lens' Lag (Maybe [Connection]) Source #

The connections bundled by the LAG.

lag_awsDevice :: Lens' Lag (Maybe Text) Source #

The Direct Connect endpoint that hosts the LAG.

lag_hasLogicalRedundancy :: Lens' Lag (Maybe HasLogicalRedundancy) Source #

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

lag_awsLogicalDeviceId :: Lens' Lag (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.

lag_allowsHostedConnections :: Lens' Lag (Maybe Bool) Source #

Indicates whether the LAG can host other connections.

lag_encryptionMode :: Lens' Lag (Maybe Text) Source #

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

lag_numberOfConnections :: Lens' Lag (Maybe Int) Source #

The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.

lag_jumboFrameCapable :: Lens' Lag (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

lag_lagState :: Lens' Lag (Maybe LagState) Source #

The state of the LAG. The following are the possible values:

  • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
  • pending: The LAG has been approved and is being initialized.
  • available: The network link is established and the LAG is ready for use.
  • down: The network link is down.
  • deleting: The LAG is being deleted.
  • deleted: The LAG is deleted.
  • unknown: The state of the LAG is not available.

lag_ownerAccount :: Lens' Lag (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the LAG.

lag_region :: Lens' Lag (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

lag_macSecKeys :: Lens' Lag (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the LAG.

lag_providerName :: Lens' Lag (Maybe Text) Source #

The name of the service provider associated with the LAG.

lag_awsDeviceV2 :: Lens' Lag (Maybe Text) Source #

The Direct Connect endpoint that hosts the LAG.

lag_tags :: Lens' Lag (Maybe (NonEmpty Tag)) Source #

The tags associated with the LAG.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The tag keys of the tags to remove.

CreateBGPPeer

AssociateHostedConnection

connection_macSecCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether the connection supports MAC Security (MACsec).

connection_portEncryptionStatus :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

connection_vlan :: Lens' Connection (Maybe Int) Source #

The ID of the VLAN.

connection_location :: Lens' Connection (Maybe Text) Source #

The location of the connection.

connection_awsDevice :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

connection_hasLogicalRedundancy :: Lens' Connection (Maybe HasLogicalRedundancy) Source #

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

connection_connectionId :: Lens' Connection (Maybe Text) Source #

The ID of the connection.

connection_awsLogicalDeviceId :: Lens' Connection (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.

connection_loaIssueTime :: Lens' Connection (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

connection_partnerName :: Lens' Connection (Maybe Text) Source #

The name of the Direct Connect service provider associated with the connection.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The name of the connection.

connection_encryptionMode :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

connection_bandwidth :: Lens' Connection (Maybe Text) Source #

The bandwidth of the connection.

connection_jumboFrameCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

connection_ownerAccount :: Lens' Connection (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the connection.

connection_region :: Lens' Connection (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

connection_macSecKeys :: Lens' Connection (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the connection.

connection_providerName :: Lens' Connection (Maybe Text) Source #

The name of the service provider associated with the connection.

connection_awsDeviceV2 :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

connection_connectionState :: Lens' Connection (Maybe ConnectionState) Source #

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The connection has been approved and is being initialized.
  • available: The network link is up and the connection is ready for use.
  • down: The network link is down.
  • deleting: The connection is being deleted.
  • deleted: The connection has been deleted.
  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  • unknown: The state of the connection is not available.

connection_tags :: Lens' Connection (Maybe (NonEmpty Tag)) Source #

The tags associated with the connection.

CreateInterconnect

createInterconnect_providerName :: Lens' CreateInterconnect (Maybe Text) Source #

The name of the service provider associated with the interconnect.

createInterconnect_tags :: Lens' CreateInterconnect (Maybe (NonEmpty Tag)) Source #

The tags to associate with the interconnect.

createInterconnect_bandwidth :: Lens' CreateInterconnect Text Source #

The port bandwidth, in Gbps. The possible values are 1 and 10.

createInterconnect_location :: Lens' CreateInterconnect Text Source #

The location of the interconnect.

interconnect_location :: Lens' Interconnect (Maybe Text) Source #

The location of the connection.

interconnect_awsDevice :: Lens' Interconnect (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

interconnect_hasLogicalRedundancy :: Lens' Interconnect (Maybe HasLogicalRedundancy) Source #

Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

interconnect_awsLogicalDeviceId :: Lens' Interconnect (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.

interconnect_loaIssueTime :: Lens' Interconnect (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

interconnect_bandwidth :: Lens' Interconnect (Maybe Text) Source #

The bandwidth of the connection.

interconnect_jumboFrameCapable :: Lens' Interconnect (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

interconnect_interconnectState :: Lens' Interconnect (Maybe InterconnectState) Source #

The state of the interconnect. The following are the possible values:

  • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The interconnect is approved, and is being initialized.
  • available: The network link is up, and the interconnect is ready for use.
  • down: The network link is down.
  • deleting: The interconnect is being deleted.
  • deleted: The interconnect is deleted.
  • unknown: The state of the interconnect is not available.

interconnect_region :: Lens' Interconnect (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

interconnect_providerName :: Lens' Interconnect (Maybe Text) Source #

The name of the service provider associated with the interconnect.

interconnect_awsDeviceV2 :: Lens' Interconnect (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

interconnect_tags :: Lens' Interconnect (Maybe (NonEmpty Tag)) Source #

The tags associated with the interconnect.

DescribeRouterConfiguration

describeRouterConfiguration_routerTypeIdentifier :: Lens' DescribeRouterConfiguration (Maybe Text) Source #

Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

describeRouterConfigurationResponse_virtualInterfaceName :: Lens' DescribeRouterConfigurationResponse (Maybe Text) Source #

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

DeleteBGPPeer

deleteBGPPeer_customerAddress :: Lens' DeleteBGPPeer (Maybe Text) Source #

The IP address assigned to the customer interface.

deleteBGPPeer_asn :: Lens' DeleteBGPPeer (Maybe Int) Source #

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

AllocateTransitVirtualInterface

allocateTransitVirtualInterface_connectionId :: Lens' AllocateTransitVirtualInterface Text Source #

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

allocateTransitVirtualInterface_ownerAccount :: Lens' AllocateTransitVirtualInterface Text Source #

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

CreateLag

createLag_childConnectionTags :: Lens' CreateLag (Maybe (NonEmpty Tag)) Source #

The tags to associate with the automtically created LAGs.

createLag_connectionId :: Lens' CreateLag (Maybe Text) Source #

The ID of an existing dedicated connection to migrate to the LAG.

createLag_requestMACSec :: Lens' CreateLag (Maybe Bool) Source #

Indicates whether the connection will support MAC Security (MACsec).

All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

createLag_providerName :: Lens' CreateLag (Maybe Text) Source #

The name of the service provider associated with the LAG.

createLag_tags :: Lens' CreateLag (Maybe (NonEmpty Tag)) Source #

The tags to associate with the LAG.

createLag_numberOfConnections :: Lens' CreateLag Int Source #

The number of physical dedicated connections initially provisioned and bundled by the LAG.

createLag_location :: Lens' CreateLag Text Source #

The location for the LAG.

createLag_connectionsBandwidth :: Lens' CreateLag Text Source #

The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

createLag_lagName :: Lens' CreateLag Text Source #

The name of the LAG.

lag_lagId :: Lens' Lag (Maybe Text) Source #

The ID of the LAG.

lag_macSecCapable :: Lens' Lag (Maybe Bool) Source #

Indicates whether the LAG supports MAC Security (MACsec).

lag_connectionsBandwidth :: Lens' Lag (Maybe Text) Source #

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

lag_minimumLinks :: Lens' Lag (Maybe Int) Source #

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

lag_lagName :: Lens' Lag (Maybe Text) Source #

The name of the LAG.

lag_location :: Lens' Lag (Maybe Text) Source #

The location of the LAG.

lag_connections :: Lens' Lag (Maybe [Connection]) Source #

The connections bundled by the LAG.

lag_awsDevice :: Lens' Lag (Maybe Text) Source #

The Direct Connect endpoint that hosts the LAG.

lag_hasLogicalRedundancy :: Lens' Lag (Maybe HasLogicalRedundancy) Source #

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

lag_awsLogicalDeviceId :: Lens' Lag (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.

lag_allowsHostedConnections :: Lens' Lag (Maybe Bool) Source #

Indicates whether the LAG can host other connections.

lag_encryptionMode :: Lens' Lag (Maybe Text) Source #

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

lag_numberOfConnections :: Lens' Lag (Maybe Int) Source #

The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.

lag_jumboFrameCapable :: Lens' Lag (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

lag_lagState :: Lens' Lag (Maybe LagState) Source #

The state of the LAG. The following are the possible values:

  • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
  • pending: The LAG has been approved and is being initialized.
  • available: The network link is established and the LAG is ready for use.
  • down: The network link is down.
  • deleting: The LAG is being deleted.
  • deleted: The LAG is deleted.
  • unknown: The state of the LAG is not available.

lag_ownerAccount :: Lens' Lag (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the LAG.

lag_region :: Lens' Lag (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

lag_macSecKeys :: Lens' Lag (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the LAG.

lag_providerName :: Lens' Lag (Maybe Text) Source #

The name of the service provider associated with the LAG.

lag_awsDeviceV2 :: Lens' Lag (Maybe Text) Source #

The Direct Connect endpoint that hosts the LAG.

lag_tags :: Lens' Lag (Maybe (NonEmpty Tag)) Source #

The tags associated with the LAG.

ConfirmTransitVirtualInterface

confirmTransitVirtualInterfaceResponse_virtualInterfaceState :: Lens' ConfirmTransitVirtualInterfaceResponse (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.

DescribeHostedConnections

Types

AssociatedGateway

associatedGateway_id :: Lens' AssociatedGateway (Maybe Text) Source #

The ID of the associated gateway.

associatedGateway_ownerAccount :: Lens' AssociatedGateway (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.

associatedGateway_region :: Lens' AssociatedGateway (Maybe Text) Source #

The Region where the associated gateway is located.

BGPPeer

bGPPeer_customerAddress :: Lens' BGPPeer (Maybe Text) Source #

The IP address assigned to the customer interface.

bGPPeer_amazonAddress :: Lens' BGPPeer (Maybe Text) Source #

The IP address assigned to the Amazon interface.

bGPPeer_addressFamily :: Lens' BGPPeer (Maybe AddressFamily) Source #

The address family for the BGP peer.

bGPPeer_awsLogicalDeviceId :: Lens' BGPPeer (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.

bGPPeer_bgpStatus :: Lens' BGPPeer (Maybe BGPStatus) Source #

The status of the BGP peer. The following are the possible values:

  • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
  • down: The BGP peer is down.
  • unknown: The BGP peer status is not available.

bGPPeer_asn :: Lens' BGPPeer (Maybe Int) Source #

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

bGPPeer_authKey :: Lens' BGPPeer (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.

bGPPeer_bgpPeerId :: Lens' BGPPeer (Maybe Text) Source #

The ID of the BGP peer.

bGPPeer_bgpPeerState :: Lens' BGPPeer (Maybe BGPPeerState) Source #

The state of the BGP peer. The following are the possible values:

  • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
  • pending: The BGP peer is created, and remains in this state until it is ready to be established.
  • available: The BGP peer is ready to be established.
  • deleting: The BGP peer is being deleted.
  • deleted: The BGP peer is deleted and cannot be established.

bGPPeer_awsDeviceV2 :: Lens' BGPPeer (Maybe Text) Source #

The Direct Connect endpoint that terminates the BGP peer.

Connection

connection_macSecCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether the connection supports MAC Security (MACsec).

connection_portEncryptionStatus :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

connection_vlan :: Lens' Connection (Maybe Int) Source #

The ID of the VLAN.

connection_location :: Lens' Connection (Maybe Text) Source #

The location of the connection.

connection_awsDevice :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

connection_hasLogicalRedundancy :: Lens' Connection (Maybe HasLogicalRedundancy) Source #

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

connection_connectionId :: Lens' Connection (Maybe Text) Source #

The ID of the connection.

connection_awsLogicalDeviceId :: Lens' Connection (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.

connection_loaIssueTime :: Lens' Connection (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

connection_partnerName :: Lens' Connection (Maybe Text) Source #

The name of the Direct Connect service provider associated with the connection.

connection_connectionName :: Lens' Connection (Maybe Text) Source #

The name of the connection.

connection_encryptionMode :: Lens' Connection (Maybe Text) Source #

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

connection_bandwidth :: Lens' Connection (Maybe Text) Source #

The bandwidth of the connection.

connection_jumboFrameCapable :: Lens' Connection (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

connection_ownerAccount :: Lens' Connection (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the connection.

connection_region :: Lens' Connection (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

connection_macSecKeys :: Lens' Connection (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the connection.

connection_providerName :: Lens' Connection (Maybe Text) Source #

The name of the service provider associated with the connection.

connection_awsDeviceV2 :: Lens' Connection (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

connection_connectionState :: Lens' Connection (Maybe ConnectionState) Source #

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.
  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The connection has been approved and is being initialized.
  • available: The network link is up and the connection is ready for use.
  • down: The network link is down.
  • deleting: The connection is being deleted.
  • deleted: The connection has been deleted.
  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.
  • unknown: The state of the connection is not available.

connection_tags :: Lens' Connection (Maybe (NonEmpty Tag)) Source #

The tags associated with the connection.

Connections

CustomerAgreement

customerAgreement_status :: Lens' CustomerAgreement (Maybe Text) Source #

The status of the customer agreement. This will be either signed or unsigned

DirectConnectGateway

directConnectGateway_stateChangeError :: Lens' DirectConnectGateway (Maybe Text) Source #

The error message if the state of an object failed to advance.

directConnectGateway_amazonSideAsn :: Lens' DirectConnectGateway (Maybe Integer) Source #

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

directConnectGateway_directConnectGatewayState :: Lens' DirectConnectGateway (Maybe DirectConnectGatewayState) Source #

The state of the Direct Connect gateway. The following are the possible values:

  • pending: The initial state after calling CreateDirectConnectGateway.
  • available: The Direct Connect gateway is ready for use.
  • deleting: The initial state after calling DeleteDirectConnectGateway.
  • deleted: The Direct Connect gateway is deleted and cannot pass traffic.

directConnectGateway_ownerAccount :: Lens' DirectConnectGateway (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

DirectConnectGatewayAssociation

directConnectGatewayAssociation_virtualGatewayId :: Lens' DirectConnectGatewayAssociation (Maybe Text) Source #

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

directConnectGatewayAssociation_virtualGatewayOwnerAccount :: Lens' DirectConnectGatewayAssociation (Maybe Text) Source #

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

directConnectGatewayAssociation_stateChangeError :: Lens' DirectConnectGatewayAssociation (Maybe Text) Source #

The error message if the state of an object failed to advance.

directConnectGatewayAssociation_virtualGatewayRegion :: Lens' DirectConnectGatewayAssociation (Maybe Text) Source #

The Amazon Web Services Region where the virtual private gateway is located.

directConnectGatewayAssociation_directConnectGatewayOwnerAccount :: Lens' DirectConnectGatewayAssociation (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the associated gateway.

directConnectGatewayAssociation_associationState :: Lens' DirectConnectGatewayAssociation (Maybe DirectConnectGatewayAssociationState) Source #

The state of the association. The following are the possible values:

  • associating: The initial state after calling CreateDirectConnectGatewayAssociation.
  • associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.
  • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.
  • disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

DirectConnectGatewayAssociationProposal

directConnectGatewayAssociationProposal_proposalState :: Lens' DirectConnectGatewayAssociationProposal (Maybe DirectConnectGatewayAssociationProposalState) Source #

The state of the proposal. The following are possible values:

  • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.
  • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.
  • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

directConnectGatewayAssociationProposal_directConnectGatewayOwnerAccount :: Lens' DirectConnectGatewayAssociationProposal (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

DirectConnectGatewayAttachment

directConnectGatewayAttachment_attachmentState :: Lens' DirectConnectGatewayAttachment (Maybe DirectConnectGatewayAttachmentState) Source #

The state of the attachment. The following are the possible values:

  • attaching: The initial state after a virtual interface is created using the Direct Connect gateway.
  • attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.
  • detaching: The initial state after calling DeleteVirtualInterface.
  • detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

directConnectGatewayAttachment_stateChangeError :: Lens' DirectConnectGatewayAttachment (Maybe Text) Source #

The error message if the state of an object failed to advance.

directConnectGatewayAttachment_virtualInterfaceRegion :: Lens' DirectConnectGatewayAttachment (Maybe Text) Source #

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

directConnectGatewayAttachment_virtualInterfaceOwnerAccount :: Lens' DirectConnectGatewayAttachment (Maybe Text) Source #

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

Interconnect

interconnect_location :: Lens' Interconnect (Maybe Text) Source #

The location of the connection.

interconnect_awsDevice :: Lens' Interconnect (Maybe Text) Source #

The Direct Connect endpoint on which the physical connection terminates.

interconnect_hasLogicalRedundancy :: Lens' Interconnect (Maybe HasLogicalRedundancy) Source #

Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

interconnect_awsLogicalDeviceId :: Lens' Interconnect (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.

interconnect_loaIssueTime :: Lens' Interconnect (Maybe UTCTime) Source #

The time of the most recent call to DescribeLoa for this connection.

interconnect_bandwidth :: Lens' Interconnect (Maybe Text) Source #

The bandwidth of the connection.

interconnect_jumboFrameCapable :: Lens' Interconnect (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

interconnect_interconnectState :: Lens' Interconnect (Maybe InterconnectState) Source #

The state of the interconnect. The following are the possible values:

  • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.
  • pending: The interconnect is approved, and is being initialized.
  • available: The network link is up, and the interconnect is ready for use.
  • down: The network link is down.
  • deleting: The interconnect is being deleted.
  • deleted: The interconnect is deleted.
  • unknown: The state of the interconnect is not available.

interconnect_region :: Lens' Interconnect (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

interconnect_providerName :: Lens' Interconnect (Maybe Text) Source #

The name of the service provider associated with the interconnect.

interconnect_awsDeviceV2 :: Lens' Interconnect (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

interconnect_tags :: Lens' Interconnect (Maybe (NonEmpty Tag)) Source #

The tags associated with the interconnect.

Lag

lag_lagId :: Lens' Lag (Maybe Text) Source #

The ID of the LAG.

lag_macSecCapable :: Lens' Lag (Maybe Bool) Source #

Indicates whether the LAG supports MAC Security (MACsec).

lag_connectionsBandwidth :: Lens' Lag (Maybe Text) Source #

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

lag_minimumLinks :: Lens' Lag (Maybe Int) Source #

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

lag_lagName :: Lens' Lag (Maybe Text) Source #

The name of the LAG.

lag_location :: Lens' Lag (Maybe Text) Source #

The location of the LAG.

lag_connections :: Lens' Lag (Maybe [Connection]) Source #

The connections bundled by the LAG.

lag_awsDevice :: Lens' Lag (Maybe Text) Source #

The Direct Connect endpoint that hosts the LAG.

lag_hasLogicalRedundancy :: Lens' Lag (Maybe HasLogicalRedundancy) Source #

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

lag_awsLogicalDeviceId :: Lens' Lag (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.

lag_allowsHostedConnections :: Lens' Lag (Maybe Bool) Source #

Indicates whether the LAG can host other connections.

lag_encryptionMode :: Lens' Lag (Maybe Text) Source #

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

lag_numberOfConnections :: Lens' Lag (Maybe Int) Source #

The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.

lag_jumboFrameCapable :: Lens' Lag (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

lag_lagState :: Lens' Lag (Maybe LagState) Source #

The state of the LAG. The following are the possible values:

  • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.
  • pending: The LAG has been approved and is being initialized.
  • available: The network link is established and the LAG is ready for use.
  • down: The network link is down.
  • deleting: The LAG is being deleted.
  • deleted: The LAG is deleted.
  • unknown: The state of the LAG is not available.

lag_ownerAccount :: Lens' Lag (Maybe Text) Source #

The ID of the Amazon Web Services account that owns the LAG.

lag_region :: Lens' Lag (Maybe Text) Source #

The Amazon Web Services Region where the connection is located.

lag_macSecKeys :: Lens' Lag (Maybe [MacSecKey]) Source #

The MAC Security (MACsec) security keys associated with the LAG.

lag_providerName :: Lens' Lag (Maybe Text) Source #

The name of the service provider associated with the LAG.

lag_awsDeviceV2 :: Lens' Lag (Maybe Text) Source #

The Direct Connect endpoint that hosts the LAG.

lag_tags :: Lens' Lag (Maybe (NonEmpty Tag)) Source #

The tags associated with the LAG.

Location

location_availablePortSpeeds :: Lens' Location (Maybe [Text]) Source #

The available port speeds for the location.

location_locationName :: Lens' Location (Maybe Text) Source #

The name of the location. This includes the name of the colocation partner and the physical site of the building.

location_locationCode :: Lens' Location (Maybe Text) Source #

The code for the location.

location_region :: Lens' Location (Maybe Text) Source #

The Amazon Web Services Region for the location.

location_availableProviders :: Lens' Location (Maybe [Text]) Source #

The name of the service provider for the location.

location_availableMacSecPortSpeeds :: Lens' Location (Maybe [Text]) Source #

The available MAC Security (MACsec) port speeds for the location.

MacSecKey

macSecKey_state :: Lens' MacSecKey (Maybe Text) Source #

The state of the MAC Security (MACsec) secret key.

The possible values are:

  • associating: The MAC Security (MACsec) secret key is being validated and not yet associated with the connection or LAG.
  • associated: The MAC Security (MACsec) secret key is validated and associated with the connection or LAG.
  • disassociating: The MAC Security (MACsec) secret key is being disassociated from the connection or LAG
  • disassociated: The MAC Security (MACsec) secret key is no longer associated with the connection or LAG.

macSecKey_ckn :: Lens' MacSecKey (Maybe Text) Source #

The Connection Key Name (CKN) for the MAC Security secret key.

macSecKey_secretARN :: Lens' MacSecKey (Maybe Text) Source #

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

macSecKey_startOn :: Lens' MacSecKey (Maybe Text) Source #

The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

NewBGPPeer

newBGPPeer_customerAddress :: Lens' NewBGPPeer (Maybe Text) Source #

The IP address assigned to the customer interface.

newBGPPeer_amazonAddress :: Lens' NewBGPPeer (Maybe Text) Source #

The IP address assigned to the Amazon interface.

newBGPPeer_addressFamily :: Lens' NewBGPPeer (Maybe AddressFamily) Source #

The address family for the BGP peer.

newBGPPeer_asn :: Lens' NewBGPPeer (Maybe Int) Source #

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

newBGPPeer_authKey :: Lens' NewBGPPeer (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.

NewPrivateVirtualInterface

newPrivateVirtualInterface_mtu :: Lens' NewPrivateVirtualInterface (Maybe Int) Source #

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

newPrivateVirtualInterface_customerAddress :: Lens' NewPrivateVirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

newPrivateVirtualInterface_amazonAddress :: Lens' NewPrivateVirtualInterface (Maybe Text) Source #

The IP address assigned to the Amazon interface.

newPrivateVirtualInterface_authKey :: Lens' NewPrivateVirtualInterface (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.

newPrivateVirtualInterface_tags :: Lens' NewPrivateVirtualInterface (Maybe (NonEmpty Tag)) Source #

The tags associated with the private virtual interface.

newPrivateVirtualInterface_virtualInterfaceName :: Lens' NewPrivateVirtualInterface 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 (-).

newPrivateVirtualInterface_asn :: Lens' NewPrivateVirtualInterface Int Source #

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

The valid values are 1-2147483647.

NewPrivateVirtualInterfaceAllocation

newPrivateVirtualInterfaceAllocation_mtu :: Lens' NewPrivateVirtualInterfaceAllocation (Maybe Int) Source #

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

newPrivateVirtualInterfaceAllocation_authKey :: Lens' NewPrivateVirtualInterfaceAllocation (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.

newPrivateVirtualInterfaceAllocation_virtualInterfaceName :: Lens' NewPrivateVirtualInterfaceAllocation 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 (-).

newPrivateVirtualInterfaceAllocation_asn :: Lens' NewPrivateVirtualInterfaceAllocation Int Source #

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

The valid values are 1-2147483647.

NewPublicVirtualInterface

newPublicVirtualInterface_routeFilterPrefixes :: Lens' NewPublicVirtualInterface (Maybe [RouteFilterPrefix]) Source #

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

newPublicVirtualInterface_customerAddress :: Lens' NewPublicVirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

newPublicVirtualInterface_amazonAddress :: Lens' NewPublicVirtualInterface (Maybe Text) Source #

The IP address assigned to the Amazon interface.

newPublicVirtualInterface_authKey :: Lens' NewPublicVirtualInterface (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.

newPublicVirtualInterface_tags :: Lens' NewPublicVirtualInterface (Maybe (NonEmpty Tag)) Source #

The tags associated with the public virtual interface.

newPublicVirtualInterface_virtualInterfaceName :: Lens' NewPublicVirtualInterface 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 (-).

newPublicVirtualInterface_asn :: Lens' NewPublicVirtualInterface Int Source #

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

The valid values are 1-2147483647.

NewPublicVirtualInterfaceAllocation

newPublicVirtualInterfaceAllocation_routeFilterPrefixes :: Lens' NewPublicVirtualInterfaceAllocation (Maybe [RouteFilterPrefix]) Source #

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

newPublicVirtualInterfaceAllocation_authKey :: Lens' NewPublicVirtualInterfaceAllocation (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.

newPublicVirtualInterfaceAllocation_virtualInterfaceName :: Lens' NewPublicVirtualInterfaceAllocation 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 (-).

newPublicVirtualInterfaceAllocation_asn :: Lens' NewPublicVirtualInterfaceAllocation Int Source #

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

The valid values are 1-2147483647.

NewTransitVirtualInterface

newTransitVirtualInterface_mtu :: Lens' NewTransitVirtualInterface (Maybe Int) Source #

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

newTransitVirtualInterface_customerAddress :: Lens' NewTransitVirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

newTransitVirtualInterface_amazonAddress :: Lens' NewTransitVirtualInterface (Maybe Text) Source #

The IP address assigned to the Amazon interface.

newTransitVirtualInterface_asn :: Lens' NewTransitVirtualInterface (Maybe Int) Source #

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

The valid values are 1-2147483647.

newTransitVirtualInterface_authKey :: Lens' NewTransitVirtualInterface (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.

newTransitVirtualInterface_virtualInterfaceName :: Lens' NewTransitVirtualInterface (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 (-).

newTransitVirtualInterface_tags :: Lens' NewTransitVirtualInterface (Maybe (NonEmpty Tag)) Source #

The tags associated with the transitive virtual interface.

NewTransitVirtualInterfaceAllocation

newTransitVirtualInterfaceAllocation_mtu :: Lens' NewTransitVirtualInterfaceAllocation (Maybe Int) Source #

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

newTransitVirtualInterfaceAllocation_asn :: Lens' NewTransitVirtualInterfaceAllocation (Maybe Int) Source #

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

The valid values are 1-2147483647.

newTransitVirtualInterfaceAllocation_authKey :: Lens' NewTransitVirtualInterfaceAllocation (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.

newTransitVirtualInterfaceAllocation_virtualInterfaceName :: Lens' NewTransitVirtualInterfaceAllocation (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 (-).

newTransitVirtualInterfaceAllocation_tags :: Lens' NewTransitVirtualInterfaceAllocation (Maybe (NonEmpty Tag)) Source #

The tags associated with the transitive virtual interface.

ResourceTag

resourceTag_resourceArn :: Lens' ResourceTag (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

RouteFilterPrefix

routeFilterPrefix_cidr :: Lens' RouteFilterPrefix (Maybe Text) Source #

The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

RouterType

routerType_vendor :: Lens' RouterType (Maybe Text) Source #

The vendor for the virtual interface's router.

routerType_platform :: Lens' RouterType (Maybe Text) Source #

The virtual interface router platform.

routerType_xsltTemplateName :: Lens' RouterType (Maybe Text) Source #

The template for the virtual interface's router.

routerType_xsltTemplateNameForMacSec :: Lens' RouterType (Maybe Text) Source #

The MAC Security (MACsec) template for the virtual interface's router.

routerType_routerTypeIdentifier :: Lens' RouterType (Maybe Text) Source #

Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

Tag

VirtualGateway

virtualGateway_virtualGatewayId :: Lens' VirtualGateway (Maybe Text) Source #

The ID of the virtual private gateway.

virtualGateway_virtualGatewayState :: Lens' VirtualGateway (Maybe Text) Source #

The state of the virtual private gateway. The following are the possible values:

  • pending: Initial state after creating the virtual private gateway.
  • available: Ready for use by a private virtual interface.
  • deleting: Initial state after deleting the virtual private gateway.
  • deleted: The virtual private gateway is deleted. The private virtual interface is unable to send traffic over this gateway.

VirtualInterface

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

The BGP peers configured on this virtual interface.

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

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

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_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_customerAddress :: Lens' VirtualInterface (Maybe Text) Source #

The IP address assigned to the customer interface.

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

The location of the connection.

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

The IP address assigned to the Amazon interface.

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_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_amazonSideAsn :: Lens' VirtualInterface (Maybe Integer) Source #

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

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

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

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_jumboFrameCapable :: Lens' VirtualInterface (Maybe Bool) Source #

Indicates whether jumbo frames (9001 MTU) are supported.

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_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_awsDeviceV2 :: Lens' VirtualInterface (Maybe Text) Source #

The Direct Connect endpoint that terminates the physical connection.

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

The tags associated with the virtual interface.

VirtualInterfaceTestHistory

virtualInterfaceTestHistory_bgpPeers :: Lens' VirtualInterfaceTestHistory (Maybe [Text]) Source #

The BGP peers that were put in the DOWN state as part of the virtual interface failover test.

virtualInterfaceTestHistory_status :: Lens' VirtualInterfaceTestHistory (Maybe Text) Source #

The status of the virtual interface failover test.

virtualInterfaceTestHistory_testDurationInMinutes :: Lens' VirtualInterfaceTestHistory (Maybe Int) Source #

The time that the virtual interface failover test ran in minutes.

virtualInterfaceTestHistory_startTime :: Lens' VirtualInterfaceTestHistory (Maybe UTCTime) Source #

The time that the virtual interface moves to the DOWN state.

virtualInterfaceTestHistory_testId :: Lens' VirtualInterfaceTestHistory (Maybe Text) Source #

The ID of the virtual interface failover test.

virtualInterfaceTestHistory_endTime :: Lens' VirtualInterfaceTestHistory (Maybe UTCTime) Source #

The time that the virtual interface moves out of the DOWN state.