Class NetworkConfig

Network Configuration. Used to define a network configuration for the accelerator.

Hierarchy

NetworkConfig

Implements

TypeOf<typeof networkConfig>

Constructors

constructor

new NetworkConfig(values?: {
    centralNetworkServices: undefined | ({ delegatedAdminAccount: string; gatewayLoadBalancers: { name: string; endpoints: { name: string; account: string; subnet: string; vpc: string; }[]; subnets: string[]; vpc: string; crossZoneLoadBalancing: boolean | undefined; deletionProtection: boolean | undefined; targetGroup: string | undefined; tags: { ...; }[] ...);
    certificates: undefined | ({ name: string; type: "request" | "import"; privKey: string | undefined; cert: string | undefined; chain: string | undefined; validation: "EMAIL" | "DNS" | undefined; domain: string | undefined; san: string[] | undefined; deploymentTargets: { ...; }; })[];
    customerGateways: undefined | ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ipAddress: string; asn: number; tags: { ...; }[] | undefined; vpnConnections: { ...; }[] | undefined; })[];
    defaultVpc: { delete: boolean; excludeAccounts: string[] | undefined; excludeRegions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | ... 27 more ... | "ap-southeast-4")[] | undefined; };
    dhcpOptions: undefined | ({ name: string; accounts: string[]; regions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4")[]; ... 5 more ...; tags: { ...; }[] | undefined; })[];
    directConnectGateways: undefined | ({ name: string; account: string; asn: number; gatewayName: string; virtualInterfaces: { name: string; connectionId: string; customerAsn: number; interfaceName: string; ownerAccount: string; region: "af-south-1" | ... 32 more ... | "ap-southeast-4"; ... 7 more ...; tags: { ...; }[] | undefined; }[] | undefined; trans...)[];
    elbAccountIds: undefined | ({ region: string; accountId: string; })[];
    endpointPolicies: ({ name: string; document: string; })[];
    firewallManagerService: undefined | ({ delegatedAdminAccount: string; notificationChannels: { snsTopic: string; region: string; }[] | undefined; });
    prefixLists: undefined | ({ name: string; accounts: string[] | undefined; regions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | ... 26 more ... | "ap-southeast-4")[] | undefined; ... 4 more ...; tags: { ...; }[] | undefined; })[];
    transitGatewayPeering: undefined | ({ name: string; requester: { transitGatewayName: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | ... 27 more ... | "ap-southeast-4"; routeTableAssociations: string; tags: { ...; }[] | undefined; }; accepter: { ...; }; })[];
    transitGateways: ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ... 8 more ...; tags: { ...; }[] | undefined; })[];
    vpcFlowLogs: undefined | ({ trafficType: "ALL" | "ACCEPT" | "REJECT"; maxAggregationInterval: number; destinations: ("s3" | "cloud-watch-logs")[]; destinationsConfig: { s3: { lifecycleRules: { abortIncompleteMultipartUpload: number | undefined; ... 7 more ...; prefix: string | undefined; }[] | undefined; overrideS3LogPath: string | undefined...);
    vpcPeering: undefined | ({ name: string; vpcs: string[]; tags: { key: string; value: string; }[] | undefined; })[];
    vpcTemplates: undefined | ({ name: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | ... 24 more ... | "ap-southeast-4"; ... 25 more ...; targetGroups: { ...; }[] | undefined; })[];
    vpcs: ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ... 25 more ...; targetGroups: { ...; }[] | undefined; })[];
}): NetworkConfig
Parameters
- Optional values: {
      centralNetworkServices: undefined | ({ delegatedAdminAccount: string; gatewayLoadBalancers: { name: string; endpoints: { name: string; account: string; subnet: string; vpc: string; }[]; subnets: string[]; vpc: string; crossZoneLoadBalancing: boolean | undefined; deletionProtection: boolean | undefined; targetGroup: string | undefined; tags: { ...; }[] ...);
      certificates: undefined | ({ name: string; type: "request" | "import"; privKey: string | undefined; cert: string | undefined; chain: string | undefined; validation: "EMAIL" | "DNS" | undefined; domain: string | undefined; san: string[] | undefined; deploymentTargets: { ...; }; })[];
      customerGateways: undefined | ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ipAddress: string; asn: number; tags: { ...; }[] | undefined; vpnConnections: { ...; }[] | undefined; })[];
      defaultVpc: { delete: boolean; excludeAccounts: string[] | undefined; excludeRegions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | ... 27 more ... | "ap-southeast-4")[] | undefined; };
      dhcpOptions: undefined | ({ name: string; accounts: string[]; regions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4")[]; ... 5 more ...; tags: { ...; }[] | undefined; })[];
      directConnectGateways: undefined | ({ name: string; account: string; asn: number; gatewayName: string; virtualInterfaces: { name: string; connectionId: string; customerAsn: number; interfaceName: string; ownerAccount: string; region: "af-south-1" | ... 32 more ... | "ap-southeast-4"; ... 7 more ...; tags: { ...; }[] | undefined; }[] | undefined; trans...)[];
      elbAccountIds: undefined | ({ region: string; accountId: string; })[];
      endpointPolicies: ({ name: string; document: string; })[];
      firewallManagerService: undefined | ({ delegatedAdminAccount: string; notificationChannels: { snsTopic: string; region: string; }[] | undefined; });
      prefixLists: undefined | ({ name: string; accounts: string[] | undefined; regions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | ... 26 more ... | "ap-southeast-4")[] | undefined; ... 4 more ...; tags: { ...; }[] | undefined; })[];
      transitGatewayPeering: undefined | ({ name: string; requester: { transitGatewayName: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | ... 27 more ... | "ap-southeast-4"; routeTableAssociations: string; tags: { ...; }[] | undefined; }; accepter: { ...; }; })[];
      transitGateways: ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ... 8 more ...; tags: { ...; }[] | undefined; })[];
      vpcFlowLogs: undefined | ({ trafficType: "ALL" | "ACCEPT" | "REJECT"; maxAggregationInterval: number; destinations: ("s3" | "cloud-watch-logs")[]; destinationsConfig: { s3: { lifecycleRules: { abortIncompleteMultipartUpload: number | undefined; ... 7 more ...; prefix: string | undefined; }[] | undefined; overrideS3LogPath: string | undefined...);
      vpcPeering: undefined | ({ name: string; vpcs: string[]; tags: { key: string; value: string; }[] | undefined; })[];
      vpcTemplates: undefined | ({ name: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | ... 24 more ... | "ap-southeast-4"; ... 25 more ...; targetGroups: { ...; }[] | undefined; })[];
      vpcs: ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ... 25 more ...; targetGroups: { ...; }[] | undefined; })[];
  }
  - centralNetworkServices: undefined | ({ delegatedAdminAccount: string; gatewayLoadBalancers: { name: string; endpoints: { name: string; account: string; subnet: string; vpc: string; }[]; subnets: string[]; vpc: string; crossZoneLoadBalancing: boolean | undefined; deletionProtection: boolean | undefined; targetGroup: string | undefined; tags: { ...; }[] ...)
  - certificates: undefined | ({ name: string; type: "request" | "import"; privKey: string | undefined; cert: string | undefined; chain: string | undefined; validation: "EMAIL" | "DNS" | undefined; domain: string | undefined; san: string[] | undefined; deploymentTargets: { ...; }; })[]
  - customerGateways: undefined | ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ipAddress: string; asn: number; tags: { ...; }[] | undefined; vpnConnections: { ...; }[] | undefined; })[]
  - defaultVpc: { delete: boolean; excludeAccounts: string[] | undefined; excludeRegions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | ... 27 more ... | "ap-southeast-4")[] | undefined; }
  - dhcpOptions: undefined | ({ name: string; accounts: string[]; regions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4")[]; ... 5 more ...; tags: { ...; }[] | undefined; })[]
  - directConnectGateways: undefined | ({ name: string; account: string; asn: number; gatewayName: string; virtualInterfaces: { name: string; connectionId: string; customerAsn: number; interfaceName: string; ownerAccount: string; region: "af-south-1" | ... 32 more ... | "ap-southeast-4"; ... 7 more ...; tags: { ...; }[] | undefined; }[] | undefined; trans...)[]
  - elbAccountIds: undefined | ({ region: string; accountId: string; })[]
  - endpointPolicies: ({ name: string; document: string; })[]
  - firewallManagerService: undefined | ({ delegatedAdminAccount: string; notificationChannels: { snsTopic: string; region: string; }[] | undefined; })
  - prefixLists: undefined | ({ name: string; accounts: string[] | undefined; regions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | ... 26 more ... | "ap-southeast-4")[] | undefined; ... 4 more ...; tags: { ...; }[] | undefined; })[]
  - transitGatewayPeering: undefined | ({ name: string; requester: { transitGatewayName: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | ... 27 more ... | "ap-southeast-4"; routeTableAssociations: string; tags: { ...; }[] | undefined; }; accepter: { ...; }; })[]
  - transitGateways: ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ... 8 more ...; tags: { ...; }[] | undefined; })[]
  - vpcFlowLogs: undefined | ({ trafficType: "ALL" | "ACCEPT" | "REJECT"; maxAggregationInterval: number; destinations: ("s3" | "cloud-watch-logs")[]; destinationsConfig: { s3: { lifecycleRules: { abortIncompleteMultipartUpload: number | undefined; ... 7 more ...; prefix: string | undefined; }[] | undefined; overrideS3LogPath: string | undefined...)
  - vpcPeering: undefined | ({ name: string; vpcs: string[]; tags: { key: string; value: string; }[] | undefined; })[]
  - vpcTemplates: undefined | ({ name: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | ... 24 more ... | "ap-southeast-4"; ... 25 more ...; targetGroups: { ...; }[] | undefined; })[]
  - vpcs: ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ... 25 more ...; targetGroups: { ...; }[] | undefined; })[]
Returns NetworkConfig

Properties

`Readonly` centralNetworkServices

centralNetworkServices: undefined | CentralNetworkServicesConfig = undefined

An optional Central Network services configuration.

See

CentralNetworkServicesConfig

`Readonly` certificates

certificates: undefined | CertificateConfig[] = undefined

Certificate manager configuration

`Readonly` customerGateways

customerGateways: undefined | CustomerGatewayConfig[] = undefined

An array of Customer Gateway configurations.

See

CustomerGatewayConfig

`Readonly` defaultVpc

defaultVpc: DefaultVpcsConfig = ...

A default VPC configuration.

See

DefaultVpcsConfig

`Readonly` dhcpOptions

dhcpOptions: undefined | DhcpOptsConfig[] = undefined

An optional list of DHCP options set configurations.

See

DhcpOptsConfig

`Readonly` directConnectGateways

directConnectGateways: undefined | DxGatewayConfig[] = undefined

An optional array of Direct Connect Gateway configurations.

Example

directConnectGateways:
  - name: Accelerator-DXGW
    account: Network
    asn: 64512
    virtualInterfaces: []
    transitGatewayAssociations: []

See

DxGatewayConfig

`Readonly` elbAccountIds

elbAccountIds: undefined | ElbAccountIdsConfig[] = undefined

An optional ELB root account ID

`Readonly` endpointPolicies

endpointPolicies: EndpointPolicyConfig[] = []

A list of VPC configurations. An array of VPC endpoint policies.

See

EndpointPolicyConfig

`Readonly` firewallManagerService

firewallManagerService: undefined | FirewallManagerConfig = undefined

Firewall manager service configuration

`Readonly` prefixLists

prefixLists: undefined | PrefixListConfig[] = undefined

An optional list of prefix list set configurations.

`Readonly` transitGatewayPeering

transitGatewayPeering: undefined | TransitGatewayPeeringConfig[] = undefined

Transit Gateway peering configuration.

See

TransitGatewayPeeringConfig

`Readonly` transitGateways

transitGateways: TransitGatewayConfig[] = []

An array of Transit Gateway configurations.

See

TransitGatewayConfig

`Readonly` vpcFlowLogs

vpcFlowLogs: undefined | VpcFlowLogsConfig = undefined

A VPC flow logs configuration.

See

VpcFlowLogsConfig

`Readonly` vpcPeering

vpcPeering: undefined | VpcPeeringConfig[] = undefined

An optional list of VPC peering configurations

See

VpcPeeringConfig

`Readonly` vpcTemplates

vpcTemplates: undefined | VpcTemplatesConfig[] = undefined

An optional list of VPC template configurations

See

VpcTemplatesConfig

`Readonly` vpcs

vpcs: VpcConfig[] = []

An array of VPC configurations.

See

VpcConfig

`Static` `Readonly` FILENAME

FILENAME: "network-config.yaml" = 'network-config.yaml'

The name of the network configuration file.

Methods

getTgwPeeringRequesterAccepterConfig

getTgwPeeringRequesterAccepterConfig(peeringName: string, peerType: "requester" | "accepter"): undefined | TransitGatewayPeeringRequesterConfig | TransitGatewayPeeringAccepterConfig
Function to get requester or accepter config of tgw peering

Returns
Parameters
- peeringName: string
- peerType: "requester" | "accepter"
Returns undefined | TransitGatewayPeeringRequesterConfig | TransitGatewayPeeringAccepterConfig

getTgwRequestorAccountNames

getTgwRequestorAccountNames(accepterAccountName: string): string[]
Function to get list of account names which will be used as account principal for TGE peering role

Returns
Parameters
- accepterAccountName: string
Returns string[]

`Static` load

load(dir: string, replacementsConfig?: ReplacementsConfig): NetworkConfig
Returns
Parameters
- dir: string
- Optional replacementsConfig: ReplacementsConfig
Returns NetworkConfig

`Static` loadFromString

loadFromString(content: string): undefined | NetworkConfig
Load from string content
Parameters
- content: string
Returns undefined | NetworkConfig

Class NetworkConfig

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

certificates: undefined | ({ name: string; type: "request" | "import"; privKey: string | undefined; cert: string | undefined; chain: string | undefined; validation: "EMAIL" | "DNS" | undefined; domain: string | undefined; san: string[] | undefined; deploymentTargets: { ...; }; })[]

defaultVpc: { delete: boolean; excludeAccounts: string[] | undefined; excludeRegions: ("af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | ... 27 more ... | "ap-southeast-4")[] | undefined; }

elbAccountIds: undefined | ({ region: string; accountId: string; })[]

endpointPolicies: ({ name: string; document: string; })[]

firewallManagerService: undefined | ({ delegatedAdminAccount: string; notificationChannels: { snsTopic: string; region: string; }[] | undefined; })

transitGateways: ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ... 8 more ...; tags: { ...; }[] | undefined; })[]

vpcPeering: undefined | ({ name: string; vpcs: string[]; tags: { key: string; value: string; }[] | undefined; })[]

vpcs: ({ name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | "ap-southeast-3" | "ap-northeast-1" | "ap-northeast-2" | ... 25 more ... | "ap-southeast-4"; ... 25 more ...; targetGroups: { ...; }[] | undefined; })[]

Returns NetworkConfig

Properties

Readonly centralNetworkServices

See

Readonly certificates

Readonly customerGateways

See

Readonly defaultVpc

See

Readonly dhcpOptions

See

Readonly directConnectGateways

Example

See

Readonly elbAccountIds

Readonly endpointPolicies

See

Readonly firewallManagerService

Readonly prefixLists

Readonly transitGatewayPeering

See

Readonly transitGateways

See

Readonly vpcFlowLogs

See

Readonly vpcPeering

See

Readonly vpcTemplates

See

Readonly vpcs

See

Static Readonly FILENAME

Methods

getTgwPeeringRequesterAccepterConfig

Returns

Parameters

peeringName: string

peerType: "requester" | "accepter"

Returns undefined | TransitGatewayPeeringRequesterConfig | TransitGatewayPeeringAccepterConfig

getTgwRequestorAccountNames

Returns

Parameters

accepterAccountName: string

Returns string[]

Static load

Returns

Parameters

dir: string

Optional replacementsConfig: ReplacementsConfig

Returns NetworkConfig

Static loadFromString

Parameters

content: string

Returns undefined | NetworkConfig

Settings

Member Visibility

Theme

`Readonly` centralNetworkServices

`Readonly` certificates

`Readonly` customerGateways

`Readonly` defaultVpc

`Readonly` dhcpOptions

`Readonly` directConnectGateways

`Readonly` elbAccountIds

`Readonly` endpointPolicies

`Readonly` firewallManagerService

`Readonly` prefixLists

`Readonly` transitGatewayPeering

`Readonly` transitGateways

`Readonly` vpcFlowLogs

`Readonly` vpcPeering

`Readonly` vpcTemplates

`Readonly` vpcs

`Static` `Readonly` FILENAME

`Static` load

`Optional` replacementsConfig: ReplacementsConfig

`Static` loadFromString