Skip to main content

AwsEcsServerModule

AwsEcsServerModule is an ECS-based AWS server module that provides an implementation for the Server model. This module creates servers with ECS deployment capabilities, IAM roles, security groups, and optional S3 storage access. It manages the infrastructure foundation for hosting containerized applications.

@example

TypeScript

import { AwsEcsServerModule } from '@quadnix/octo-aws-cdk/modules/server/aws-ecs-server';

octo.loadModule(AwsEcsServerModule, 'my-server-module', {
  account: myAccount,
  s3: [{
    directories: [{
      access: S3StorageAccess.READ_WRITE,
      remoteDirectoryPath: 'uploads',
    }],
    service: myS3Service,
  }],
  securityGroupRules: [{
    CidrBlock: '0.0.0.0/0',
    Egress: false,
    FromPort: 443,
    ToPort: 443,
    IpProtocol: 'tcp'
  }],
  serverKey: 'backend-server',
});
@group

Modules/Server/AwsEcsServer

@see

Hierarchy

Index

Constructors

Properties

Methods

Resources

Constructors

constructor

  • Parameters

    • moduleId: string

    Returns AwsEcsServerModule

Properties

readonlyinheritedmoduleId

moduleId: string

staticreadonlyinheritedMODULE_PACKAGE

MODULE_PACKAGE: string

staticreadonlyinheritedMODULE_SCHEMA

MODULE_SCHEMA: any

Methods

onInit

  • Parameters

    Returns Promise<(AwsEcsServer | AwsEcsServerS3AccessOverlay)[]>

inheritedregisterHooks

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

  • 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

  • Parameters

    Returns Promise<{ account: Account; app: App; iamRoleName: string }>

Page Options