AwsEcsDeploymentModule

AwsEcsDeploymentModule is an ECS-based AWS deployment module that provides an implementation for the Deployment model. This module creates deployments for ECS-based servers with container configurations for task definitions. It establishes the relationship between servers and their deployment configurations.

@example

TypeScript

import { AwsEcsDeploymentModule } from '@quadnix/octo-aws-cdk/modules/deployment/aws-ecs-deployment';

octo.loadModule(AwsEcsDeploymentModule, 'my-deployment-module', {
  deploymentContainerProperties: {
    cpu: 256,
    image: {
      command: 'npm start',
      ports: [{ containerPort: 3000, protocol: 'tcp' }],
      uri: 'my-app:latest',
    },
    memory: 512,
  },
  deploymentTag: 'v1.0.0',
  server: myServer,
});

@group

Modules/Deployment/AwsEcsDeployment

@see

AwsEcsDeploymentModuleSchema for the input schema.
AModule to learn more about modules.
Deployment to learn more about the Deployment model.

Hierarchy

AModule<AwsEcsDeploymentModuleSchema, Deployment>
- AwsEcsDeploymentModule

Index

Constructors

constructor

AwsEcsDeploymentModule(moduleId: string): AwsEcsDeploymentModule

Inherited from AModule<AwsEcsDeploymentModuleSchema, Deployment>.constructor
Parameters
- moduleId: string
Returns AwsEcsDeploymentModule

Properties

readonlyinheritedmoduleId

moduleId: string

staticreadonlyinheritedMODULE_PACKAGE

MODULE_PACKAGE: string

staticreadonlyinheritedMODULE_SCHEMA

MODULE_SCHEMA: any

Methods

onInit

onInit(inputs: AwsEcsDeploymentModuleSchema): Promise<AwsEcsDeployment>

Overrides AModule.onInit
Parameters
- inputs: AwsEcsDeploymentModuleSchema
Returns Promise<AwsEcsDeployment>

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[]

inheritedregisterMetadata

registerMetadata(inputs: AwsEcsDeploymentModuleSchema): Promise<Record<string, unknown>>

Inherited from AModule.registerMetadata
Parameters
- inputs: AwsEcsDeploymentModuleSchema
Returns Promise<Record<string, unknown>>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

moduleId: string

Returns AwsEcsDeploymentModule

Properties

readonlyinheritedmoduleId

staticreadonlyinheritedMODULE_PACKAGE

staticreadonlyinheritedMODULE_SCHEMA

Methods

onInit

Parameters

inputs: AwsEcsDeploymentModuleSchema

Returns Promise<AwsEcsDeployment>

inheritedregisterHooks

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[]

inheritedregisterMetadata

Parameters

inputs: AwsEcsDeploymentModuleSchema

Returns Promise<Record<string, unknown>>