AwsEcsEnvironmentModule

AwsEcsEnvironmentModule is an ECS-based AWS environment module that provides an implementation for the Environment model. This module creates environments within AWS regions, establishing ECS clusters and managing environment variables. It serves as the foundation for deploying containerized applications in specific environments.

@example

TypeScript

import { AwsEcsEnvironmentModule } from '@quadnix/octo-aws-cdk/modules/environment/aws-ecs-environment';

octo.loadModule(AwsEcsEnvironmentModule, 'my-environment-module', {
  environmentName: 'production',
  environmentVariables: {
    NODE_ENV: 'production',
    API_URL: 'https://api.example.com'
  },
  region: myRegion,
});

@group

Modules/Environment/AwsEcsEnvironment

@see

• AwsEcsEnvironmentModuleSchema for the input schema.
• AModule to learn more about modules.
• Environment to learn more about the Environment model.

Hierarchy

• AModule<AwsEcsEnvironmentModuleSchema, Environment>
  • AwsEcsEnvironmentModule

Index

Constructors

• constructor

Properties

• moduleId
• MODULE_PACKAGE
• MODULE_SCHEMA

Methods

• onInit
• registerHooks
• registerMetadata

Resources

• EcsClusterSchema

Constructors

constructor

• AwsEcsEnvironmentModule(moduleId: string): AwsEcsEnvironmentModule

• Inherited from AModule<AwsEcsEnvironmentModuleSchema, Environment>.constructor

  Parameters

  • moduleId: string

  Returns AwsEcsEnvironmentModule

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: AwsEcsEnvironmentModuleSchema): Promise<AwsEcsEnvironment>

• Overrides AModule.onInit

  Parameters

  • inputs: AwsEcsEnvironmentModuleSchema

  Returns Promise<AwsEcsEnvironment>

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: AwsEcsEnvironmentModuleSchema): Promise<{ awsAccountId: string; awsRegionId: string; clusterName: string }>

• Overrides AModule.registerMetadata

  Parameters

  • inputs: AwsEcsEnvironmentModuleSchema

  Returns Promise<{ awsAccountId: string; awsRegionId: string; clusterName: string }>