@aws-accelerator/config
    Preparing search index...

    Interface IDxGatewayConfig

    NetworkConfig / DxGatewayConfig

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

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

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

    Properties

    name account asn gatewayName virtualInterfaces? transitGatewayAssociations?

    Properties

    name: string

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

    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.

    account: string

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

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

    asn: number

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

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

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

    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.

    This name can be changed without replacing the physical resource.

    virtualInterfaces?: IDxVirtualInterfaceConfig[]

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

    DxVirtualInterfaceConfig

    transitGatewayAssociations?: IDxTransitGatewayAssociationConfig[]

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

    DxTransitGatewayAssociationConfig

    Settings

    Member Visibility

    On This Page

    Properties