AwsSingleAzRegionModule

AwsSingleAzRegionModule is a per-AZ AWS region module that provides an implementation for the Region model. This module creates AWS regions within a single availability zone. It establishes the regional foundation for deploying AWS resources within this single availability zone.

@example

TypeScript

import { AwsSingleAzRegionModule } from '@quadnix/octo-aws-cdk/modules/region/aws-single-az-region';

octo.loadModule(AwsSingleAzRegionModule, 'my-region-module', {
  account: myAccount,
  regionId: AwsSingleAzRegionId.AWS_US_EAST_1A,
  vpcCidrBlock: '10.0.0.0/16'
});

@group

Modules/Region/AwsSingleAzRegion

@see

• AwsSingleAzRegionModuleSchema for the input schema.
• AModule to learn more about modules.
• Region to learn more about the Region model.

Hierarchy

• AModule<AwsSingleAzRegionModuleSchema, AwsSingleAzRegion>
  • AwsSingleAzRegionModule

Index

Constructors

• constructor

Properties

• moduleId
• MODULE_PACKAGE
• MODULE_SCHEMA

Methods

• onInit
• registerHooks
• registerMetadata

Resources

• InternetGatewaySchema
• VpcSchema

Constructors

constructor

• AwsSingleAzRegionModule(moduleId: string): AwsSingleAzRegionModule

• Inherited from AModule<AwsSingleAzRegionModuleSchema, AwsSingleAzRegion>.constructor

  Parameters

  • moduleId: string

  Returns AwsSingleAzRegionModule

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: AwsSingleAzRegionModuleSchema): Promise<AwsSingleAzRegion>

• Overrides AModule.onInit

  Parameters

  • inputs: AwsSingleAzRegionModuleSchema

  Returns Promise<AwsSingleAzRegion>

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[]

inheritedregisterMetadata

• registerMetadata(inputs: AwsSingleAzRegionModuleSchema): Promise<Record<string, unknown>>

• Inherited from AModule.registerMetadata

  Parameters

  • inputs: AwsSingleAzRegionModuleSchema

  Returns Promise<Record<string, unknown>>