Header menu logo FsCDK

VpcBuilder Type

Constructors

Constructor Description

VpcBuilder(name)

Full Usage: VpcBuilder(name)

Parameters:
    name : string

Returns: VpcBuilder
name : string
Returns: VpcBuilder

Instance members

Instance member Description

cidr cidr

Full Usage: cidr cidr

Parameters:
    cidr : string - The CIDR block (e.g., "10.0.0.0/16").

Returns: VpcConfig

Sets the CIDR block for the VPC.

cidr : string

The CIDR block (e.g., "10.0.0.0/16").

Returns: VpcConfig

this.Combine

Full Usage: this.Combine

Parameters:
Returns: VpcConfig
a : VpcConfig
b : VpcConfig
Returns: VpcConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string - The construct ID.

Returns: VpcConfig

Sets the construct ID for the VPC.

id : string

The construct ID.

Returns: VpcConfig

defaultInstanceTenancy tenancy

Full Usage: defaultInstanceTenancy tenancy

Parameters:
Returns: VpcConfig

Sets the default instance tenancy.

tenancy : DefaultInstanceTenancy

The instance tenancy.

Returns: VpcConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: VpcConfig
Modifiers: inline
f : unit -> VpcConfig
Returns: VpcConfig

enableDnsHostnames enabled

Full Usage: enableDnsHostnames enabled

Parameters:
    enabled : bool - Whether DNS hostnames are enabled (default: true).

Returns: VpcConfig

Sets whether to enable DNS hostnames.

enabled : bool

Whether DNS hostnames are enabled (default: true).

Returns: VpcConfig

enableDnsSupport enabled

Full Usage: enableDnsSupport enabled

Parameters:
    enabled : bool - Whether DNS support is enabled (default: true).

Returns: VpcConfig

Sets whether to enable DNS support.

enabled : bool

Whether DNS support is enabled (default: true).

Returns: VpcConfig

enableFlowLogs enabled

Full Usage: enableFlowLogs enabled

Parameters:
    enabled : bool - Whether to enable flow logs (default: true).

Returns: VpcConfig

Enables or disables VPC Flow Logs for network traffic monitoring. **Security Best Practice:** Flow logs are enabled by default for security monitoring and compliance. Flow logs capture information about IP traffic going to and from network interfaces in your VPC.

enabled : bool

Whether to enable flow logs (default: true).

Returns: VpcConfig

flowLogRetention retention

Full Usage: flowLogRetention retention

Parameters:
    retention : RetentionDays - The retention period (default: ONE_WEEK for cost optimization).

Returns: VpcConfig

Sets the retention period for VPC Flow Logs in CloudWatch.

retention : RetentionDays

The retention period (default: ONE_WEEK for cost optimization).

Returns: VpcConfig

this.For

Full Usage: this.For

Parameters:
Returns: VpcConfig
Modifiers: inline
config : VpcConfig
f : unit -> VpcConfig
Returns: VpcConfig

ipAddresses ipAddresses

Full Usage: ipAddresses ipAddresses

Parameters:
    ipAddresses : IIpAddresses - The IP addresses configuration.

Returns: VpcConfig

Sets the IP address configuration.

ipAddresses : IIpAddresses

The IP addresses configuration.

Returns: VpcConfig

maxAzs maxAzs

Full Usage: maxAzs maxAzs

Parameters:
    maxAzs : int - The maximum number of AZs (default: 2 for HA).

Returns: VpcConfig

Sets the maximum number of Availability Zones to use.

maxAzs : int

The maximum number of AZs (default: 2 for HA).

Returns: VpcConfig

natGateways natGateways

Full Usage: natGateways natGateways

Parameters:
    natGateways : int - The number of NAT gateways (default: 1 for cost optimization).

Returns: VpcConfig

Sets the number of NAT Gateways.

natGateways : int

The number of NAT gateways (default: 1 for cost optimization).

Returns: VpcConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: VpcSpec
config : VpcConfig
Returns: VpcSpec

subnet subnetConfig

Full Usage: subnet subnetConfig

Parameters:
Returns: VpcConfig

Adds a subnet configuration.

subnetConfig : SubnetConfiguration

The subnet configuration.

Returns: VpcConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: VpcConfig
() : unit
Returns: VpcConfig

this.Zero

Full Usage: this.Zero

Returns: VpcConfig
Returns: VpcConfig

Type something to start searching.