AwsEcsExecutionModule

AwsEcsExecutionModule is an ECS-based AWS execution module that provides an implementation for the Execution model. This module creates executions that manage the runtime of containerized applications in ECS environments. It handles main and sidecar deployments, environment variables, security groups, filesystem mounts, and service orchestration.

@example

TypeScript

import { AwsEcsExecutionModule } from '@quadnix/octo-aws-cdk/modules/aws-ecs-execution';

octo.loadModule(AwsExecutionModule, 'my-execution-module', {
  deployments: {
    main: {
      containerProperties: {
        cpu: 512,
        image: {
          essential: true,
          name: 'main-app',
          ports: [{ containerPort: 3000, protocol: 'tcp' }]
        },
        memory: 1024,
      },
      deployment: myMainDeployment,
    },
    sidecars: []
  },
  desiredCount: 2,
  environment: myEnvironment,
  environmentVariables: {
    LOG_LEVEL: 'info'
  },
  executionId: 'my-app-execution',
  filesystems: [myFilesystem],
  securityGroupRules: [{
    CidrBlock: '0.0.0.0/0',
    Egress: false,
    FromPort: 3000,
    IpProtocol: 'tcp',
    ToPort: 3000,
  }],
  subnet: mySubnet,
});

@group

Modules/Execution/AwsEcsExecution

@see

• AwsEcsExecutionModuleSchema for the input schema.
• AModule to learn more about modules.
• Execution to learn more about the Execution model.

Hierarchy

• AModule<AwsEcsExecutionModuleSchema, Execution>
  • AwsEcsExecutionModule

Index

Constructors

• constructor

Properties

• moduleId
• MODULE_PACKAGE
• MODULE_SCHEMA

Methods

• onInit
• registerHooks
• registerMetadata

Resources

• EcsServiceSchema
• EcsTaskDefinitionSchema
• SecurityGroupSchema

Constructors

constructor

• AwsEcsExecutionModule(moduleId: string): AwsEcsExecutionModule

• Inherited from AModule<AwsEcsExecutionModuleSchema, Execution>.constructor

  Parameters

  • moduleId: string

  Returns AwsEcsExecutionModule

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: AwsEcsExecutionModuleSchema): Promise<(AwsEcsExecution | AwsEcsExecutionOverlay | AwsEcsExecutionServerSecurityGroupOverlay)[]>

• Overrides AModule.onInit

  Parameters

  • inputs: AwsEcsExecutionModuleSchema

  Returns Promise<(AwsEcsExecution | AwsEcsExecutionOverlay | AwsEcsExecutionServerSecurityGroupOverlay)[]>

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: AwsEcsExecutionModuleSchema): Promise<{ awsAccountId: string; awsRegionId: string; region: Region }>

• Overrides AModule.registerMetadata

  Parameters

  • inputs: AwsEcsExecutionModuleSchema

  Returns Promise<{ awsAccountId: string; awsRegionId: string; region: Region }>