Skip to content

Latest commit

 

History

History
150 lines (82 loc) · 6.12 KB

API.md

File metadata and controls

150 lines (82 loc) · 6.12 KB
Raw

API Reference

Classes

Name Description
VpcPortable No description

class VpcPortable

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct, IVpc, IConstruct, IDependable, IConstruct, IResource Extends: Vpc

Initializer

new VpcPortable(scope: Construct, id: string, props?: VpcProps)
  • scope (Construct) No description
  • id (string) No description
  • props (VpcProps) No description
    • cidr (string) The CIDR range to use for the VPC, e.g. '10.0.0.0/16'. Default: Vpc.DEFAULT_CIDR_RANGE
    • defaultInstanceTenancy (DefaultInstanceTenancy) The default tenancy of instances launched into the VPC. Default: DefaultInstanceTenancy.Default (shared) tenancy
    • enableDnsHostnames (boolean) Indicates whether the instances launched in the VPC get public DNS hostnames. Default: true
    • enableDnsSupport (boolean) Indicates whether the DNS resolution is supported for the VPC. Default: true
    • flowLogs (Map<string, FlowLogOptions>) Flow logs to add to this VPC. Default: No flow logs.
    • gatewayEndpoints (Map<string, GatewayVpcEndpointOptions>) Gateway endpoints to add to this VPC. Default: None.
    • maxAzs (number) Define the maximum number of AZs to use in this region. Default: 3
    • natGatewayProvider (NatProvider) What type of NAT provider to use. Default: NatProvider.gateway()
    • natGateways (number) The number of NAT Gateways/Instances to create. Default: One NAT gateway/instance per Availability Zone
    • natGatewaySubnets (SubnetSelection) Configures the subnets which will have NAT Gateways/Instances. Default: All public subnets.
    • subnetConfiguration (Array<SubnetConfiguration>) Configure the subnets to build for each AZ. Default: The VPC CIDR will be evenly divided between 1 public and 1 private subnet per AZ.
    • vpnConnections (Map<string, VpnConnectionOptions>) VPN connections to this VPC. Default: No connections.
    • vpnGateway (boolean) Indicates whether a VPN gateway should be created and attached to this VPC. Default: true when vpnGatewayAsn or vpnConnections is specified
    • vpnGatewayAsn (number) The private Autonomous System Number (ASN) for the VPN gateway. Default: Amazon default ASN.
    • vpnRoutePropagation (Array<SubnetSelection>) Where to propagate VPN routes. Default: On the route tables associated with private subnets. If no private subnets exists, isolated subnets are used. If no isolated subnets exists, public subnets are used.

Methods

exportToStackOutput() 

exportToStackOutput(): void

publishStackOutput(key, value) 

publishStackOutput(key: string, value: string): void
  • key (string) No description
  • value (string) No description

publishStackOutputList(key, values) 

publishStackOutputList(key: string, values: Array<string>): void
  • key (string) No description
  • values (Array) No description

static getOtherStackOutput(key, otherStackName, otherStackNodeId) 

static getOtherStackOutput(key: string, otherStackName: string, otherStackNodeId: string): string
  • key (string) No description
  • otherStackName (string) No description
  • otherStackNodeId (string) No description

Returns:

  • string

static getOtherStackOutputList(key, otherStackName, otherStackNodeId) 

static getOtherStackOutputList(key: string, otherStackName: string, otherStackNodeId: string): Array<string>
  • key (string) No description
  • otherStackName (string) No description
  • otherStackNodeId (string) No description

Returns:

  • Array

static importFromStackOutput(scope, id, otherStackName, otherStackNodeId) 

static importFromStackOutput(scope: Construct, id: string, otherStackName: string, otherStackNodeId: string): VpcPortable
  • scope (Construct) No description
  • id (string) No description
  • otherStackName (string) No description
  • otherStackNodeId (string) No description

Returns:

static mangleStackName(name) 

static mangleStackName(name: string): string
  • name (string) No description

Returns:

  • string