Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • NetworkConfig

Implements

Index

Constructors

  • new NetworkConfig(values?: { centralNetworkServices: undefined | { delegatedAdminAccount: string; ipams: { name: string; region: "af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | ... 20 more ... | "us-isob-east-1"; ... 4 more ...; tags: { ...; }[] | undefined; }[] | undefined; route53Resolver: { ...; } | undefi...; defaultVpc: { delete: boolean; excludeAccounts: string[] | undefined; }; dhcpOptions: undefined | { name: string; accounts: string[]; regions: ("af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | ... 19 more ... | "us-isob-east-1")[]; ... 5 more ...; tags: { ...; }[] | undefined; }[]; endpointPolicies: { name: string; document: string; }[]; transitGateways: { name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | ... 19 more ... | "us-isob-east-1"; ... 8 more ...; tags: { ...; }[] | undefined; }[]; vpcFlowLogs: { trafficType: "ALL" | "ACCEPT" | "REJECT"; maxAggregationInterval: number; destinations: ("s3" | "cloud-watch-logs")[]; defaultFormat: boolean; customFields: string[] | 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-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | ... 19 more ... | "us-isob-east-1"; ... 20 more ...; tags: { ...; }[] | undefined; }[] }, configDir?: string): NetworkConfig
  • Parameters

    • Optional values: { centralNetworkServices: undefined | { delegatedAdminAccount: string; ipams: { name: string; region: "af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | ... 20 more ... | "us-isob-east-1"; ... 4 more ...; tags: { ...; }[] | undefined; }[] | undefined; route53Resolver: { ...; } | undefi...; defaultVpc: { delete: boolean; excludeAccounts: string[] | undefined; }; dhcpOptions: undefined | { name: string; accounts: string[]; regions: ("af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | ... 19 more ... | "us-isob-east-1")[]; ... 5 more ...; tags: { ...; }[] | undefined; }[]; endpointPolicies: { name: string; document: string; }[]; transitGateways: { name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | ... 19 more ... | "us-isob-east-1"; ... 8 more ...; tags: { ...; }[] | undefined; }[]; vpcFlowLogs: { trafficType: "ALL" | "ACCEPT" | "REJECT"; maxAggregationInterval: number; destinations: ("s3" | "cloud-watch-logs")[]; defaultFormat: boolean; customFields: string[] | 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-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | ... 19 more ... | "us-isob-east-1"; ... 20 more ...; tags: { ...; }[] | undefined; }[] }
      • centralNetworkServices: undefined | { delegatedAdminAccount: string; ipams: { name: string; region: "af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | ... 20 more ... | "us-isob-east-1"; ... 4 more ...; tags: { ...; }[] | undefined; }[] | undefined; route53Resolver: { ...; } | undefi...
      • defaultVpc: { delete: boolean; excludeAccounts: string[] | undefined; }
      • dhcpOptions: undefined | { name: string; accounts: string[]; regions: ("af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | ... 19 more ... | "us-isob-east-1")[]; ... 5 more ...; tags: { ...; }[] | undefined; }[]
      • endpointPolicies: { name: string; document: string; }[]
      • transitGateways: { name: string; account: string; region: "af-south-1" | "ap-east-1" | "ap-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | ... 19 more ... | "us-isob-east-1"; ... 8 more ...; tags: { ...; }[] | undefined; }[]
      • vpcFlowLogs: { trafficType: "ALL" | "ACCEPT" | "REJECT"; maxAggregationInterval: number; destinations: ("s3" | "cloud-watch-logs")[]; defaultFormat: boolean; customFields: string[] | 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-northeast-1" | "ap-northeast-2" | "ap-northeast-3" | "ap-south-1" | "ap-southeast-1" | "ap-southeast-2" | ... 19 more ... | "us-isob-east-1"; ... 20 more ...; tags: { ...; }[] | undefined; }[]
    • Optional configDir: string

    Returns NetworkConfig

Properties

centralNetworkServices: undefined | CentralNetworkServicesConfig = undefined

An optional Central Network services configuration.

see

CentralNetworkServicesConfig

defaultVpc: DefaultVpcsConfig = ...

A default VPC configuration.

see

DefaultVpcsConfig

dhcpOptions: undefined | DhcpOptsConfig[] = undefined

An optional list of DHCP options set configurations.

see

DhcpOptsConfig

endpointPolicies: EndpointPolicyConfig[] = []

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

see

EndpointPolicyConfig

prefixLists: undefined | PrefixListConfig[] = undefined

An optional list of prefix list set configurations.

transitGateways: TransitGatewayConfig[] = []

An array of Transit Gateway configurations.

see

TransitGatewayConfig

vpcFlowLogs: VpcFlowLogsConfig = ...

A VPC flow logs configuration.

see

VpcFlowLogsConfig

vpcPeering: undefined | VpcPeeringConfig[] = undefined

An optional list of VPC peering configurations

see

VpcPeeringConfig

vpcs: VpcConfig[] = []

An array of VPC configurations.

see

VpcConfig

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

The name of the network configuration file.

Methods

  • Load from string content

    Parameters

    • content: string

    Returns undefined | NetworkConfig

Generated using TypeDoc