Amazonka.DirectConnect.CreateInterconnect

Creates an interconnect between an Direct Connect Partner's network and a specific Direct Connect location.

An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an Direct Connect router.

You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.

For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.

Intended for use by Direct Connect Partners only.

Creating a Request

data CreateInterconnect

See: newCreateInterconnect smart constructor.

Constructors

CreateInterconnect'

Fields

• lagId :: Maybe Text

  The ID of the LAG.

• providerName :: Maybe Text

  The name of the service provider associated with the interconnect.

• tags :: Maybe (NonEmpty Tag)

  The tags to associate with the interconnect.

• interconnectName :: Text

  The name of the interconnect.

• bandwidth :: Text

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

• location :: Text

  The location of the interconnect.

Instances

ToJSON CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Methods

toJSON :: CreateInterconnect -> Value

toEncoding :: CreateInterconnect -> Encoding

toJSONList :: [CreateInterconnect] -> Value

toEncodingList :: [CreateInterconnect] -> Encoding

ToHeaders CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Methods

toHeaders :: CreateInterconnect -> [Header]

ToPath CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Methods

toPath :: CreateInterconnect -> ByteString

ToQuery CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Methods

toQuery :: CreateInterconnect -> QueryString

AWSRequest CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Associated Types

type AWSResponse CreateInterconnect

Methods

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

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

Generic CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Associated Types

type Rep CreateInterconnect :: Type -> Type

Methods

from :: CreateInterconnect -> Rep CreateInterconnect x

to :: Rep CreateInterconnect x -> CreateInterconnect

Read CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Methods

readsPrec :: Int -> ReadS CreateInterconnect

readList :: ReadS [CreateInterconnect]

readPrec :: ReadPrec CreateInterconnect

readListPrec :: ReadPrec [CreateInterconnect]

Show CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Methods

showsPrec :: Int -> CreateInterconnect -> ShowS

show :: CreateInterconnect -> String

showList :: [CreateInterconnect] -> ShowS

NFData CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Methods

rnf :: CreateInterconnect -> ()

Eq CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Methods

(==) :: CreateInterconnect -> CreateInterconnect -> Bool

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

Hashable CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

Methods

hashWithSalt :: Int -> CreateInterconnect -> Int

hash :: CreateInterconnect -> Int

type AWSResponse CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

type AWSResponse CreateInterconnect = Interconnect

type Rep CreateInterconnect

Defined in Amazonka.DirectConnect.CreateInterconnect

type Rep CreateInterconnect = D1 ('MetaData "CreateInterconnect" "Amazonka.DirectConnect.CreateInterconnect" "amazonka-directconnect-2.0-L3DT8JGnMceEIS37MHoczF" 'False) (C1 ('MetaCons "CreateInterconnect'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lagId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "providerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))))) :*: (S1 ('MetaSel ('Just "interconnectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "bandwidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateInterconnect

Arguments

:: Text

CreateInterconnect

-> Text

CreateInterconnect

-> Text

CreateInterconnect

-> CreateInterconnect

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

CreateInterconnect, createInterconnect_lagId - The ID of the LAG.

CreateInterconnect, createInterconnect_providerName - The name of the service provider associated with the interconnect.

CreateInterconnect, createInterconnect_tags - The tags to associate with the interconnect.

CreateInterconnect, createInterconnect_interconnectName - The name of the interconnect.

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

CreateInterconnect, createInterconnect_location - The location of the interconnect.

Request Lenses

createInterconnect_lagId :: Lens' CreateInterconnect (Maybe Text)

The ID of the LAG.

createInterconnect_providerName :: Lens' CreateInterconnect (Maybe Text)

The name of the service provider associated with the interconnect.

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

The tags to associate with the interconnect.

createInterconnect_interconnectName :: Lens' CreateInterconnect Text

The name of the interconnect.

createInterconnect_bandwidth :: Lens' CreateInterconnect Text

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

createInterconnect_location :: Lens' CreateInterconnect Text

The location of the interconnect.

Destructuring the Response

data Interconnect

Information about an interconnect.

See: newInterconnect smart constructor.

Constructors

Interconnect'

Fields

• awsDevice :: Maybe Text

  The Direct Connect endpoint on which the physical connection terminates.

• awsDeviceV2 :: Maybe Text

  The Direct Connect endpoint that terminates the physical connection.

• awsLogicalDeviceId :: Maybe Text

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

• bandwidth :: Maybe Text

  The bandwidth of the connection.

• hasLogicalRedundancy :: Maybe HasLogicalRedundancy

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

• interconnectId :: Maybe Text

  The ID of the interconnect.

• interconnectName :: Maybe Text

  The name of the interconnect.

• interconnectState :: Maybe InterconnectState

  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.
• jumboFrameCapable :: Maybe Bool

  Indicates whether jumbo frames (9001 MTU) are supported.

• lagId :: Maybe Text

  The ID of the LAG.

• loaIssueTime :: Maybe POSIX

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

• location :: Maybe Text

  The location of the connection.

• providerName :: Maybe Text

  The name of the service provider associated with the interconnect.

• region :: Maybe Text

  The Amazon Web Services Region where the connection is located.

• tags :: Maybe (NonEmpty Tag)

  The tags associated with the interconnect.

Instances

FromJSON Interconnect

Defined in Amazonka.DirectConnect.Types.Interconnect

Methods

parseJSON :: Value -> Parser Interconnect

parseJSONList :: Value -> Parser [Interconnect]

Generic Interconnect

Defined in Amazonka.DirectConnect.Types.Interconnect

Associated Types

type Rep Interconnect :: Type -> Type

Methods

from :: Interconnect -> Rep Interconnect x

to :: Rep Interconnect x -> Interconnect

Read Interconnect

Defined in Amazonka.DirectConnect.Types.Interconnect

Methods

readsPrec :: Int -> ReadS Interconnect

readList :: ReadS [Interconnect]

readPrec :: ReadPrec Interconnect

readListPrec :: ReadPrec [Interconnect]

Show Interconnect

Defined in Amazonka.DirectConnect.Types.Interconnect

Methods

showsPrec :: Int -> Interconnect -> ShowS

show :: Interconnect -> String

showList :: [Interconnect] -> ShowS

NFData Interconnect

Defined in Amazonka.DirectConnect.Types.Interconnect

Methods

rnf :: Interconnect -> ()

Eq Interconnect

Defined in Amazonka.DirectConnect.Types.Interconnect

Methods

(==) :: Interconnect -> Interconnect -> Bool

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

Hashable Interconnect

Defined in Amazonka.DirectConnect.Types.Interconnect

Methods

hashWithSalt :: Int -> Interconnect -> Int

hash :: Interconnect -> Int

type Rep Interconnect

Defined in Amazonka.DirectConnect.Types.Interconnect

type Rep Interconnect = D1 ('MetaData "Interconnect" "Amazonka.DirectConnect.Types.Interconnect" "amazonka-directconnect-2.0-L3DT8JGnMceEIS37MHoczF" 'False) (C1 ('MetaCons "Interconnect'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "awsDevice") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "awsDeviceV2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "awsLogicalDeviceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "bandwidth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "hasLogicalRedundancy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HasLogicalRedundancy))) :*: (S1 ('MetaSel ('Just "interconnectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "interconnectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: (((S1 ('MetaSel ('Just "interconnectState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InterconnectState)) :*: S1 ('MetaSel ('Just "jumboFrameCapable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "lagId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "loaIssueTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "providerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))))))))

newInterconnect :: Interconnect

Create a value of Interconnect 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:awsDevice:Interconnect', interconnect_awsDevice - The Direct Connect endpoint on which the physical connection terminates.

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

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

$sel:bandwidth:Interconnect', interconnect_bandwidth - The bandwidth of the connection.

$sel:hasLogicalRedundancy:Interconnect', interconnect_hasLogicalRedundancy - Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

$sel:interconnectId:Interconnect', interconnect_interconnectId - The ID of the interconnect.

$sel:interconnectName:Interconnect', interconnect_interconnectName - The name of the interconnect.

$sel:interconnectState:Interconnect', interconnect_interconnectState - 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.

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

$sel:lagId:Interconnect', interconnect_lagId - The ID of the LAG.

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

$sel:location:Interconnect', interconnect_location - The location of the connection.

$sel:providerName:Interconnect', interconnect_providerName - The name of the service provider associated with the interconnect.

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

$sel:tags:Interconnect', interconnect_tags - The tags associated with the interconnect.

Response Lenses

interconnect_awsDevice :: Lens' Interconnect (Maybe Text)

The Direct Connect endpoint on which the physical connection terminates.

interconnect_awsDeviceV2 :: Lens' Interconnect (Maybe Text)

The Direct Connect endpoint that terminates the physical connection.

interconnect_awsLogicalDeviceId :: Lens' Interconnect (Maybe Text)

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

interconnect_bandwidth :: Lens' Interconnect (Maybe Text)

The bandwidth of the connection.

interconnect_hasLogicalRedundancy :: Lens' Interconnect (Maybe HasLogicalRedundancy)

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

interconnect_interconnectId :: Lens' Interconnect (Maybe Text)

The ID of the interconnect.

interconnect_interconnectName :: Lens' Interconnect (Maybe Text)

The name of the interconnect.

interconnect_interconnectState :: Lens' Interconnect (Maybe InterconnectState)

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

Indicates whether jumbo frames (9001 MTU) are supported.

interconnect_lagId :: Lens' Interconnect (Maybe Text)

The ID of the LAG.

interconnect_loaIssueTime :: Lens' Interconnect (Maybe UTCTime)

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

interconnect_location :: Lens' Interconnect (Maybe Text)

The location of the connection.

interconnect_providerName :: Lens' Interconnect (Maybe Text)

The name of the service provider associated with the interconnect.

interconnect_region :: Lens' Interconnect (Maybe Text)

The Amazon Web Services Region where the connection is located.

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

The tags associated with the interconnect.