AwsSimpleSubnetModule

AwsSimpleSubnetModule is a simple AWS subnet module that provides an implementation for the Subnet model. This module creates VPC subnets with configurable network settings, NAT gateway support, and filesystem mounting capabilities. It manages network isolation and connectivity for containerized applications within AWS regions.

@example

TypeScript

import { AwsSimpleSubnetModule } from '@quadnix/octo-aws-cdk/modules/subnet/aws-simple-subnet';

octo.loadModule(AwsSimpleSubnetModule, 'my-subnet-module', {
  localFilesystems: [myEfsFilesystem],
  region: myRegion,
  subnetAvailabilityZone: 'us-east-1a',
  subnetCidrBlock: '10.0.1.0/24',
  subnetName: 'private-subnet-1',
  subnetOptions: {
    createNatGateway: false,
    disableSubnetIntraNetwork: false,
    subnetType: SubnetType.PRIVATE,
  },
  subnetSiblings: [{
    attachToNatGateway: true,
    subnet: mySiblingSubnet,
  }],
});

@group

Modules/Subnet/AwsSimpleSubnet

@see

• AwsSimpleSubnetModuleSchema for the input schema.
• AModule to learn more about modules.
• Subnet to learn more about the Subnet model.

Hierarchy

• unknown<AwsSimpleSubnetModuleSchema, AwsSimpleSubnet>
  • AwsSimpleSubnetModule

Index

Constructors

• constructor

Methods

• onInit
• registerMetadata

Resources

• EfsMountTargetSchema
• NatGatewaySchema
• NetworkAclSchema
• RouteTableSchema
• SecurityGroupSchema
• SubnetSchema

Constructors

constructor

• AwsSimpleSubnetModule(): AwsSimpleSubnetModule

• Inherited from AModule<AwsSimpleSubnetModuleSchema, AwsSimpleSubnet>.constructor

  Returns AwsSimpleSubnetModule

Methods

onInit

• onInit(inputs: AwsSimpleSubnetModuleSchema): Promise<(AwsSimpleSubnet | AwsSimpleSubnetLocalFilesystemMountOverlay)[]>

• Parameters

  • inputs: AwsSimpleSubnetModuleSchema

  Returns Promise<(AwsSimpleSubnet | AwsSimpleSubnetLocalFilesystemMountOverlay)[]>

registerMetadata

• registerMetadata(inputs: AwsSimpleSubnetModuleSchema): Promise<{ awsAccountId: string; awsAvailabilityZones: string[]; awsRegionId: string; awsRegionVpcCidrBlock: string }>

• Parameters

  • inputs: AwsSimpleSubnetModuleSchema

  Returns Promise<{ awsAccountId: string; awsAvailabilityZones: string[]; awsRegionId: string; awsRegionVpcCidrBlock: string }>