Interface IDxGatewayConfig

NetworkConfig / DxGatewayConfig

Direct Connect Gateway (DXGW) configuration. Use this configuration to define DXGWs, virtual interfaces, and DXGW associations.

Description

A DXGW is a globally-available resource than can be used to connect your VPCs to your on-premise infrastructure.

Example

directConnectGateways:
  - name: Accelerator-DXGW
    account: Network
    asn: 64512
    gatewayName: Accelerator-DXGW
    virtualInterfaces: []
    transitGatewayAssociations: []
interface IDxGatewayConfig {
    account: string;
    asn: number;
    gatewayName: string;
    name: string;
    transitGatewayAssociations?: IDxTransitGatewayAssociationConfig[];
    virtualInterfaces?: IDxVirtualInterfaceConfig[];
}

Properties

account asn gatewayName name transitGatewayAssociations? virtualInterfaces?

Properties

Readonlyaccount

account: string

The friendly name of the account to deploy the DX Gateway.

Remarks

This is the logical name property of the account as defined in accounts-config.yaml.

Readonlyasn

asn: number

A Border Gateway Protocol (BGP) Autonomous System Number (ASN).

Remarks

The range is 64512 to 65534 for 16-bit ASNs.

The range is 4200000000 to 4294967294 for 32-bit ASNs.

ReadonlygatewayName

gatewayName: string

The name of the Direct Connect Gateway. This name will show as the name of the resource in the AWS console and API.

Remarks

This name can be changed without replacing the physical resource.

Readonlyname

name: string

A friendly name for the DX Gateway. This name is used as a logical reference for the resource in the accelerator.

Remarks

CAUTION: Changing this value after initial deployment will cause the DXGW to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

Optional ReadonlytransitGatewayAssociations

transitGatewayAssociations?: IDxTransitGatewayAssociationConfig[]

(OPTIONAL) An array of transit gateway association configurations. Creates transit gateway attachments for this DX gateway.

See

DxTransitGatewayAssociationConfig

Optional ReadonlyvirtualInterfaces

virtualInterfaces?: IDxVirtualInterfaceConfig[]

(OPTIONAL) An array of virtual interface configurations. Creates virtual interfaces on the DX gateway.

See

DxVirtualInterfaceConfig

Settings

Member Visibility

On This Page

Properties