Skip to content

Latest commit

 

History

History
127 lines (69 loc) · 4.58 KB

API.md

File metadata and controls

127 lines (69 loc) · 4.58 KB

API Reference

Classes

Name Description
SimpleNAT Simple NAT instaces construct.

Structs

Name Description
SimpleNATProps Properties for NAT instances.

class SimpleNAT

Simple NAT instaces construct.

Implements: IConstruct, IConstruct, IConstruct, IDependable, IResource, IConstruct, IDependable, IConstruct Extends: Resource

Initializer

new SimpleNAT(scope: Construct, id: string, props: SimpleNATProps)
  • scope (Construct) No description
  • id (string) No description
  • props (SimpleNATProps) No description
    • vpc (IVpc) The VPC the NAT instances will reside.
    • customScripts (string) The custom script when provisioning the NAT instances. Default: no custom script.
    • instanceType (InstanceType) The instance type of NAT instances. Default: t3.MICRO.
    • keyName (string) The key name of ssh key of NAT instances. Default: No SSH access will be possible.
    • natSubnetsSelection (SubnetSelection) The subnet selection for NAT instances, one NAT instance will be placed in the selected subnets. Default: subnetType is SubnetType.PUBLIC and onePerAZ is true.
    • privateSubnetsSelection (SubnetSelection) The subnet selection for updating route tables for selected subnets. Default: subnetType is SubnetType.PRIVATE_WITH_NAT.
    • role (IRole) The IAM role attached to NAT instances. Default: an IAM role is created.

Properties

Name Type Description
static Ipv6Regex string

Methods

addV4Route(v4CIDR) 

addV4Route(v4CIDR: string): SimpleNAT
  • v4CIDR (string) No description

Returns:

addV6Route(v6CIDR) 

addV6Route(v6CIDR: string): SimpleNAT
  • v6CIDR (string) No description

Returns:

withGithubRoute() 

withGithubRoute(): SimpleNAT

Returns:

withGoogleRoute() 

withGoogleRoute(): SimpleNAT

Returns:

struct SimpleNATProps

Properties for NAT instances.

Name Type Description
vpc IVpc The VPC the NAT instances will reside.
customScripts? string The custom script when provisioning the NAT instances.
Default: no custom script.
instanceType? InstanceType The instance type of NAT instances.
Default: t3.MICRO.
keyName? string The key name of ssh key of NAT instances.
Default: No SSH access will be possible.
natSubnetsSelection? SubnetSelection The subnet selection for NAT instances, one NAT instance will be placed in the selected subnets.
Default: subnetType is SubnetType.PUBLIC and onePerAZ is true.
privateSubnetsSelection? SubnetSelection The subnet selection for updating route tables for selected subnets.
Default: subnetType is SubnetType.PRIVATE_WITH_NAT.
role? IRole The IAM role attached to NAT instances.
Default: an IAM role is created.