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

Description

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.

Intended for use by Direct Connect Partners only.

Synopsis

Creating a Request

data AllocateHostedConnection Source #

See: newAllocateHostedConnection smart constructor.

Constructors

AllocateHostedConnection' 

Fields

  • tags :: Maybe (NonEmpty Tag)

    The tags associated with the connection.

  • connectionId :: Text

    The ID of the interconnect or LAG.

  • ownerAccount :: Text

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

  • bandwidth :: Text

    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.

  • connectionName :: Text

    The name of the hosted connection.

  • vlan :: Int

    The dedicated VLAN provisioned to the hosted connection.

Instances

Instances details
Eq AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

Read AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

Show AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

Generic AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

Associated Types

type Rep AllocateHostedConnection :: Type -> Type #

NFData AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

Hashable AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

ToJSON AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

AWSRequest AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

ToHeaders AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

ToPath AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

ToQuery AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

type Rep AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

type Rep AllocateHostedConnection = D1 ('MetaData "AllocateHostedConnection" "Amazonka.DirectConnect.AllocateHostedConnection" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "AllocateHostedConnection'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :*: (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "bandwidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "connectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "vlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))
type AWSResponse AllocateHostedConnection Source # 
Instance details

Defined in Amazonka.DirectConnect.AllocateHostedConnection

newAllocateHostedConnection Source #

Create a value of AllocateHostedConnection with all optional fields omitted.

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

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

$sel:tags:AllocateHostedConnection', allocateHostedConnection_tags - The tags associated with the connection.

$sel:connectionId:AllocateHostedConnection', allocateHostedConnection_connectionId - The ID of the interconnect or LAG.

$sel:ownerAccount:AllocateHostedConnection', allocateHostedConnection_ownerAccount - The ID of the Amazon Web Services account ID of the customer for the connection.

$sel:bandwidth:AllocateHostedConnection', allocateHostedConnection_bandwidth - 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.

$sel:connectionName:AllocateHostedConnection', allocateHostedConnection_connectionName - The name of the hosted connection.

$sel:vlan:AllocateHostedConnection', allocateHostedConnection_vlan - The dedicated VLAN provisioned to the hosted connection.

Request Lenses

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.

Destructuring the Response

data Connection Source #

Information about an Direct Connect connection.

See: newConnection smart constructor.

Constructors

Connection' 

Fields

  • lagId :: Maybe Text

    The ID of the LAG.

  • macSecCapable :: Maybe Bool

    Indicates whether the connection supports MAC Security (MACsec).

  • portEncryptionStatus :: Maybe Text

    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.

  • vlan :: Maybe Int

    The ID of the VLAN.

  • location :: Maybe Text

    The location of the connection.

  • awsDevice :: Maybe Text

    The Direct Connect endpoint on which the physical connection terminates.

  • hasLogicalRedundancy :: Maybe HasLogicalRedundancy

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

  • connectionId :: Maybe Text

    The ID of the connection.

  • awsLogicalDeviceId :: Maybe Text

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

  • loaIssueTime :: Maybe POSIX

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

  • partnerName :: Maybe Text

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

  • connectionName :: Maybe Text

    The name of the connection.

  • encryptionMode :: Maybe Text

    The MAC Security (MACsec) connection encryption mode.

    The valid values are no_encrypt, should_encrypt, and must_encrypt.

  • bandwidth :: Maybe Text

    The bandwidth of the connection.

  • jumboFrameCapable :: Maybe Bool

    Indicates whether jumbo frames (9001 MTU) are supported.

  • ownerAccount :: Maybe Text

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

  • region :: Maybe Text

    The Amazon Web Services Region where the connection is located.

  • macSecKeys :: Maybe [MacSecKey]

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

  • providerName :: Maybe Text

    The name of the service provider associated with the connection.

  • awsDeviceV2 :: Maybe Text

    The Direct Connect endpoint that terminates the physical connection.

  • connectionState :: Maybe ConnectionState

    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.
  • tags :: Maybe (NonEmpty Tag)

    The tags associated with the connection.

Instances

Instances details
Eq Connection Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.Connection

Read Connection Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.Connection

Show Connection Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.Connection

Generic Connection Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.Connection

Associated Types

type Rep Connection :: Type -> Type #

NFData Connection Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.Connection

Methods

rnf :: Connection -> () #

Hashable Connection Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.Connection

FromJSON Connection Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.Connection

type Rep Connection Source # 
Instance details

Defined in Amazonka.DirectConnect.Types.Connection

type Rep Connection = D1 ('MetaData "Connection" "Amazonka.DirectConnect.Types.Connection" "libZSservicesZSamazonka-directconnectZSamazonka-directconnect" 'False) (C1 ('MetaCons "Connection'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "lagId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "macSecCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "portEncryptionStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "vlan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "awsDevice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hasLogicalRedundancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HasLogicalRedundancy)) :*: S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "awsLogicalDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "loaIssueTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "partnerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "connectionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "encryptionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "bandwidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "jumboFrameCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "ownerAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "macSecKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MacSecKey])) :*: S1 ('MetaSel ('Just "providerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "awsDeviceV2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "connectionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionState)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))))))))

newConnection :: Connection Source #

Create a value of Connection with all optional fields omitted.

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

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

$sel:lagId:Connection', connection_lagId - The ID of the LAG.

$sel:macSecCapable:Connection', connection_macSecCapable - Indicates whether the connection supports MAC Security (MACsec).

$sel:portEncryptionStatus:Connection', connection_portEncryptionStatus - 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.

$sel:vlan:Connection', connection_vlan - The ID of the VLAN.

$sel:location:Connection', connection_location - The location of the connection.

$sel:awsDevice:Connection', connection_awsDevice - The Direct Connect endpoint on which the physical connection terminates.

$sel:hasLogicalRedundancy:Connection', connection_hasLogicalRedundancy - Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

$sel:connectionId:Connection', connection_connectionId - The ID of the connection.

$sel:awsLogicalDeviceId:Connection', connection_awsLogicalDeviceId - The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

$sel:loaIssueTime:Connection', connection_loaIssueTime - The time of the most recent call to DescribeLoa for this connection.

$sel:partnerName:Connection', connection_partnerName - The name of the Direct Connect service provider associated with the connection.

$sel:connectionName:Connection', connection_connectionName - The name of the connection.

$sel:encryptionMode:Connection', connection_encryptionMode - The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

$sel:bandwidth:Connection', connection_bandwidth - The bandwidth of the connection.

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

$sel:ownerAccount:Connection', connection_ownerAccount - The ID of the Amazon Web Services account that owns the connection.

$sel:region:Connection', connection_region - The Amazon Web Services Region where the connection is located.

$sel:macSecKeys:Connection', connection_macSecKeys - The MAC Security (MACsec) security keys associated with the connection.

$sel:providerName:Connection', connection_providerName - The name of the service provider associated with the connection.

$sel:awsDeviceV2:Connection', connection_awsDeviceV2 - The Direct Connect endpoint that terminates the physical connection.

$sel:connectionState:Connection', connection_connectionState - 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.

$sel:tags:Connection', connection_tags - The tags associated with the connection.

Response Lenses

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.