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

• AModule<AwsSimpleSubnetModuleSchema, AwsSimpleSubnet>
  • AwsSimpleSubnetModule

Index

Constructors

• constructor

Properties

• moduleId
• MODULE_PACKAGE
• MODULE_SCHEMA

Methods

• onInit
• registerHooks
• registerMetadata

Resources

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

Constructors

constructor

• AwsSimpleSubnetModule(moduleId: string): AwsSimpleSubnetModule

• Inherited from AModule<AwsSimpleSubnetModuleSchema, AwsSimpleSubnet>.constructor

  Parameters

  • moduleId: string

  Returns AwsSimpleSubnetModule

Properties

readonlyinheritedmoduleId

moduleId: string

Inherited from AModule.moduleId

staticreadonlyinheritedMODULE_PACKAGE

MODULE_PACKAGE: string

Inherited from AModule.MODULE_PACKAGE

staticreadonlyinheritedMODULE_SCHEMA

MODULE_SCHEMA: any

Inherited from AModule.MODULE_SCHEMA

Methods

onInit

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

• Overrides AModule.onInit

  Parameters

  • inputs: AwsSimpleSubnetModuleSchema

  Returns Promise<(AwsSimpleSubnet | AwsSimpleSubnetLocalFilesystemMountOverlay)[]>

inheritedregisterHooks

• registerHooks(): { postCommitHooks?: PostHookSignature[]; postModelActionHooks?: PostHookSignature[]; postResourceActionHooks?: PostHookSignature[]; preCommitHooks?: PreHookSignature[]; preModelActionHooks?: PreHookSignature[]; preResourceActionHooks?: PreHookSignature[] }

• Inherited from AModule.registerHooks

  Returns { postCommitHooks?: PostHookSignature[]; postModelActionHooks?: PostHookSignature[]; postResourceActionHooks?: PostHookSignature[]; preCommitHooks?: PreHookSignature[]; preModelActionHooks?: PreHookSignature[]; preResourceActionHooks?: PreHookSignature[] }

  • optionalpostCommitHooks?: PostHookSignature[]

  • optionalpostModelActionHooks?: PostHookSignature[]

  • optionalpostResourceActionHooks?: PostHookSignature[]

  • optionalpreCommitHooks?: PreHookSignature[]

  • optionalpreModelActionHooks?: PreHookSignature[]

  • optionalpreResourceActionHooks?: PreHookSignature[]

registerMetadata

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

• Overrides AModule.registerMetadata

  Parameters

  • inputs: AwsSimpleSubnetModuleSchema

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