Aws/directconnect
@swamp/aws/directconnectv2026.09.15.1
01README
AWS DIRECTCONNECT infrastructure models
02Models
@swamp/aws/directconnect/connectionv2026.08.17.2connection.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ConnectionName | string | The name of the connection. |
| LagId? | string | The ID or ARN of the LAG to associate the connection with. |
| ProviderName? | string | The name of the service provider associated with the requested connection. |
| RequestMACSec? | boolean | Indicates whether you want the connection to support MAC Security (MACsec). |
| Bandwidth | string | The bandwidth of the connection. |
| Tags? | array | The tags associated with the connection. |
| Location | string | The location of the connection. |
fn create()
Create a DirectConnect Connection
fn get(identifier: string)
Get a DirectConnect Connection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect Connection |
fn update()
Update a DirectConnect Connection
fn delete(identifier: string)
Delete a DirectConnect Connection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect Connection |
fn sync()
Sync DirectConnect Connection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DirectConnect Connection resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DirectConnect Connection resource state
@swamp/aws/directconnect/direct-connect-gatewayv2026.08.17.2direct_connect_gateway.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Tags? | array | The tags associated with the Direct Connect gateway. |
| DirectConnectGatewayName | string | The name of the Direct Connect gateway. |
| AmazonSideAsn? | string | The autonomous system number (ASN) for the Amazon side of the connection. |
fn create()
Create a DirectConnect DirectConnectGateway
fn get(identifier: string)
Get a DirectConnect DirectConnectGateway
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect DirectConnectGateway |
fn update()
Update a DirectConnect DirectConnectGateway
fn delete(identifier: string)
Delete a DirectConnect DirectConnectGateway
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect DirectConnectGateway |
fn sync()
Sync DirectConnect DirectConnectGateway state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DirectConnect DirectConnectGateway resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DirectConnect DirectConnectGateway resource state
@swamp/aws/directconnect/direct-connect-gateway-associationv2026.08.17.2direct_connect_gateway_association.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| AcceptDirectConnectGatewayAssociationProposalRoleArn? | string | The Amazon Resource Name (ARN) of the role to accept the Direct Connect Gateway association proposal. Needs directconnect:AcceptDirectConnectGatewayAssociationProposal permissions. |
| DirectConnectGatewayId | string | The ID or ARN of the Direct Connect gateway. |
| AssociatedGatewayId | string | The ID or ARN of the virtual private gateway or transit gateway. |
| AllowedPrefixesToDirectConnectGateway? | array | The Amazon VPC prefixes to advertise to the Direct Connect gateway. This parameter is required when you create an association to a transit gateway. |
fn create()
Create a DirectConnect DirectConnectGatewayAssociation
fn get(identifier: string)
Get a DirectConnect DirectConnectGatewayAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect DirectConnectGatewayAssociation |
fn update()
Update a DirectConnect DirectConnectGatewayAssociation
fn delete(identifier: string)
Delete a DirectConnect DirectConnectGatewayAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect DirectConnectGatewayAssociation |
fn sync()
Sync DirectConnect DirectConnectGatewayAssociation state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DirectConnect DirectConnectGatewayAssociation resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DirectConnect DirectConnectGatewayAssociation resource state
@swamp/aws/directconnect/lagv2026.08.17.2lag.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| ProviderName? | string | The name of the service provider associated with the requested LAG. |
| RequestMACSec? | boolean | Indicates whether you want the LAG to support MAC Security (MACsec). |
| ConnectionsBandwidth | string | The bandwidth of the individual physical dedicated connections bundled by the LAG. |
| LagName | string | The name of the LAG. |
| MinimumLinks? | number | The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational. |
| Tags? | array | The tags associated with the LAG. |
| Location | string | The location for the LAG. |
fn create()
Create a DirectConnect Lag
fn get(identifier: string)
Get a DirectConnect Lag
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect Lag |
fn update()
Update a DirectConnect Lag
fn delete(identifier: string)
Delete a DirectConnect Lag
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect Lag |
fn sync()
Sync DirectConnect Lag state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DirectConnect Lag resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DirectConnect Lag resource state
@swamp/aws/directconnect/private-virtual-interfacev2026.08.17.2private_virtual_interface.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| BgpPeers | array | The BGP peers configured on this virtual interface. |
| DirectConnectGatewayId? | string | The ID or ARN of the Direct Connect gateway. |
| EnableSiteLink? | boolean | Indicates whether to enable or disable SiteLink. |
| Vlan | number | The ID of the VLAN. |
| Mtu? | number | The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. |
| RateLimit? | string | The rate limit (bandwidth allocation) for the virtual interface. The value must be one of the supported bandwidth values (e.g., 50Mbps, 1Gbps, 10Gbps) and cannot exceed the bandwidth of the parent connection or LAG. |
| ConnectionId | string | The ID or ARN of the connection or LAG. |
| AllocatePrivateVirtualInterfaceRoleArn? | string | The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable. |
| VirtualInterfaceName | string | 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 (-). |
| VirtualGatewayId? | string | The ID or ARN of the virtual private gateway. |
| Tags? | array | The tags associated with the private virtual interface. |
fn create()
Create a DirectConnect PrivateVirtualInterface
fn get(identifier: string)
Get a DirectConnect PrivateVirtualInterface
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect PrivateVirtualInterface |
fn update()
Update a DirectConnect PrivateVirtualInterface
fn delete(identifier: string)
Delete a DirectConnect PrivateVirtualInterface
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect PrivateVirtualInterface |
fn sync()
Sync DirectConnect PrivateVirtualInterface state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DirectConnect PrivateVirtualInterface resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DirectConnect PrivateVirtualInterface resource state
@swamp/aws/directconnect/public-virtual-interfacev2026.08.17.2public_virtual_interface.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| RateLimit? | string | The rate limit (bandwidth allocation) for the virtual interface. The value must be one of the supported bandwidth values (e.g., 50Mbps, 1Gbps, 10Gbps) and cannot exceed the bandwidth of the parent connection or LAG. |
| BgpPeers | array | The BGP peers configured on this virtual interface. |
| ConnectionId | string | The ID or ARN of the connection or LAG. |
| RouteFilterPrefixes? | array | The routes to be advertised to the AWS network in this region. |
| VirtualInterfaceName | string | 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 (-). |
| Vlan | number | The ID of the VLAN. |
| Tags? | array | The tags associated with the public virtual interface. |
| AllocatePublicVirtualInterfaceRoleArn? | string | The Amazon Resource Name (ARN) of the role to allocate the public virtual interface. Needs directconnect:AllocatePublicVirtualInterface permissions and tag permissions if applicable. |
fn create()
Create a DirectConnect PublicVirtualInterface
fn get(identifier: string)
Get a DirectConnect PublicVirtualInterface
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect PublicVirtualInterface |
fn update()
Update a DirectConnect PublicVirtualInterface
fn delete(identifier: string)
Delete a DirectConnect PublicVirtualInterface
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect PublicVirtualInterface |
fn sync()
Sync DirectConnect PublicVirtualInterface state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DirectConnect PublicVirtualInterface resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DirectConnect PublicVirtualInterface resource state
@swamp/aws/directconnect/transit-virtual-interfacev2026.08.17.2transit_virtual_interface.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| RateLimit? | string | The rate limit (bandwidth allocation) for the virtual interface. The value must be one of the supported bandwidth values (e.g., 50Mbps, 1Gbps, 10Gbps) and cannot exceed the bandwidth of the parent connection or LAG. |
| BgpPeers | array | The BGP peers configured on this virtual interface.. |
| ConnectionId | string | The ID or ARN of the connection or LAG. |
| DirectConnectGatewayId | string | The ID or ARN of the Direct Connect gateway. |
| EnableSiteLink? | boolean | Indicates whether to enable or disable SiteLink. |
| VirtualInterfaceName | string | 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 (-). |
| Vlan | number | The ID of the VLAN. |
| AllocateTransitVirtualInterfaceRoleArn? | string | The Amazon Resource Name (ARN) of the role to allocate the TransitVifAllocation. Needs directconnect:AllocateTransitVirtualInterface permissions and tag permissions if applicable. |
| Tags? | array | The tags associated with the private virtual interface. |
| Mtu? | number | The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500. |
fn create()
Create a DirectConnect TransitVirtualInterface
fn get(identifier: string)
Get a DirectConnect TransitVirtualInterface
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect TransitVirtualInterface |
fn update()
Update a DirectConnect TransitVirtualInterface
fn delete(identifier: string)
Delete a DirectConnect TransitVirtualInterface
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the DirectConnect TransitVirtualInterface |
fn sync()
Sync DirectConnect TransitVirtualInterface state from AWS
fn list(maxPages?: number, resourceModel?: string)
List DirectConnect TransitVirtualInterface resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— DirectConnect TransitVirtualInterface resource state
03Previous Versions
2026.09.14.1
2026.09.13.1
2026.09.12.1
2026.09.11.1
2026.09.10.1
2026.09.09.1
2026.09.08.1
2026.09.07.1
2026.09.06.3
2026.09.06.1
2026.09.05.1
2026.09.04.1
2026.09.03.1
2026.09.02.1
2026.09.01.1
2026.08.31.1
2026.08.30.1
2026.08.29.1
2026.08.28.1
04Stats
A
100 / 100
Downloads
0
Archive size
1.7 MB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
05Platforms
06Labels