AwsEcsAlbServiceModule

AwsEcsAlbServiceModule is an ECS-based AWS ALB service module that provides an implementation for the Service model. This module creates Application Load Balancers (ALB) with comprehensive listener configurations, target groups, and routing rules. It manages load balancing for containerized applications running on ECS with support for complex routing scenarios.

@example

TypeScript

import { AwsEcsAlbServiceModule } from '@quadnix/octo-aws-cdk/modules/service/aws-ecs-alb-service';

octo.loadModule(AwsEcsAlbServiceModule, 'my-alb-module', {
  albName: 'my-load-balancer',
  listeners: [{
    DefaultActions: [{
      action: {
        targetGroups: [{ targetGroupName: 'my-target-group' }]
      },
      actionType: 'forward',
    }],
    Port: 443,
    rules: []
  }],
  region: myRegion,
  subnets: [
    { subnetCidrBlock: '10.0.1.0/24', subnetName: 'public-subnet-1' },
  ],
  targets: [{
    containerName: 'web',
    containerPort: 3000,
    execution: myExecution,
    healthCheck: { ... },
    Name: 'my-target-group',
  }]
});

@group

Modules/Service/AwsEcsAlbService

@see

• AwsEcsAlbServiceModuleSchema for the input schema.
• AModule to learn more about modules.
• Service to learn more about the Service model.

Hierarchy

• AModule<AwsEcsAlbServiceModuleSchema, AwsEcsAlbService>
  • AwsEcsAlbServiceModule

Index

Constructors

• constructor

Properties

• moduleId
• MODULE_PACKAGE
• MODULE_SCHEMA

Methods

• onInit
• registerHooks
• registerMetadata

Resources

• AlbListenerSchema
• AlbSchema
• AlbTargetGroupSchema
• EcsServiceSchema
• SecurityGroupSchema

Constructors

constructor

• AwsEcsAlbServiceModule(moduleId: string): AwsEcsAlbServiceModule

• Inherited from AModule<AwsEcsAlbServiceModuleSchema, AwsEcsAlbService>.constructor

  Parameters

  • moduleId: string

  Returns AwsEcsAlbServiceModule

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: AwsEcsAlbServiceModuleSchema): Promise<[AwsEcsAlbService, AwsEcsAlbServiceOverlay]>

• Overrides AModule.onInit

  Parameters

  • inputs: AwsEcsAlbServiceModuleSchema

  Returns Promise<[AwsEcsAlbService, AwsEcsAlbServiceOverlay]>

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: AwsEcsAlbServiceModuleSchema): Promise<{ app: App; awsAccountId: string; awsAvailabilityZones: string[]; awsRegionId: string; subnets: Subnet[] }>

• Overrides AModule.registerMetadata

  Parameters

  • inputs: AwsEcsAlbServiceModuleSchema

  Returns Promise<{ app: App; awsAccountId: string; awsAvailabilityZones: string[]; awsRegionId: string; subnets: Subnet[] }>