AwsMultiAzRegionModule

AwsMultiAzRegionModule is a multi-AZ AWS region module that provides an implementation for the Region model. This module creates AWS regions within multiple availability zones. It establishes the regional foundation for deploying AWS resources within multiple availability zones.

@example

TypeScript

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

octo.loadModule(AwsMultiAzRegionModule, 'my-region-module', {
  account: myAccount,
  regionIds: [AwsMultiAzRegionId.AWS_US_EAST_1A, AwsMultiAzRegionId.AWS_US_EAST_1B],
  vpcCidrBlock: '10.0.0.0/16'
});

@group

Modules/Region/AwsMultiAzRegion

@see

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

Hierarchy

• AModule<AwsMultiAzRegionModuleSchema, AwsMultiAzRegion>
  • AwsMultiAzRegionModule

Index

Constructors

• constructor

Properties

• moduleId
• MODULE_PACKAGE
• MODULE_SCHEMA

Methods

• onInit
• registerHooks
• registerMetadata

Resources

• InternetGatewaySchema
• VpcSchema

Constructors

constructor

• AwsMultiAzRegionModule(moduleId: string): AwsMultiAzRegionModule

• Inherited from AModule<AwsMultiAzRegionModuleSchema, AwsMultiAzRegion>.constructor

  Parameters

  • moduleId: string

  Returns AwsMultiAzRegionModule

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: AwsMultiAzRegionModuleSchema): Promise<AwsMultiAzRegion>

• Overrides AModule.onInit

  Parameters

  • inputs: AwsMultiAzRegionModuleSchema

  Returns Promise<AwsMultiAzRegion>

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: AwsMultiAzRegionModuleSchema): Promise<Record<string, unknown>>

• Inherited from AModule.registerMetadata

  Parameters

  • inputs: AwsMultiAzRegionModuleSchema

  Returns Promise<Record<string, unknown>>