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

• unknown<AwsEcsAlbServiceModuleSchema, AwsEcsAlbService>
  • AwsEcsAlbServiceModule

Index

Constructors

• constructor

Methods

• onInit
• registerMetadata

Resources

• AlbListenerSchema
• AlbSchema
• AlbTargetGroupSchema
• EcsServiceSchema
• SecurityGroupSchema

Constructors

constructor

• AwsEcsAlbServiceModule(): AwsEcsAlbServiceModule

• Inherited from AModule<AwsEcsAlbServiceModuleSchema, AwsEcsAlbService>.constructor

  Returns AwsEcsAlbServiceModule

Methods

onInit

• onInit(inputs: AwsEcsAlbServiceModuleSchema): Promise<[AwsEcsAlbService, AwsEcsAlbServiceOverlay]>

• Parameters

  • inputs: AwsEcsAlbServiceModuleSchema

  Returns Promise<[AwsEcsAlbService, AwsEcsAlbServiceOverlay]>

registerMetadata

• registerMetadata(inputs: AwsEcsAlbServiceModuleSchema): Promise<{ app: App; awsAccountId: string; awsAvailabilityZones: string[]; awsRegionId: string; subnets: Subnet[] }>

• Parameters

  • inputs: AwsEcsAlbServiceModuleSchema

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