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

• AwsEcsServerModuleSchema for the input schema.
• AModule to learn more about modules.
• Server to learn more about the Server model.

Hierarchy

• unknown<AwsEcsServerModuleSchema, AwsEcsServer>
  • AwsEcsServerModule

Index

Constructors

• constructor

Methods

• onInit
• registerMetadata

Resources

• IamRoleSchema
• S3StorageSchema

Constructors

constructor

• AwsEcsServerModule(): AwsEcsServerModule

• Inherited from AModule<AwsEcsServerModuleSchema, AwsEcsServer>.constructor

  Returns AwsEcsServerModule

Methods

onInit

• onInit(inputs: AwsEcsServerModuleSchema): Promise<(AwsEcsServer | AwsEcsServerS3AccessOverlay)[]>

• Parameters

  • inputs: AwsEcsServerModuleSchema

  Returns Promise<(AwsEcsServer | AwsEcsServerS3AccessOverlay)[]>

registerMetadata

• registerMetadata(inputs: AwsEcsServerModuleSchema): Promise<{ account: Account; app: App; iamRoleName: string }>

• Parameters

  • inputs: AwsEcsServerModuleSchema

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