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

• unknown<AwsEcsEnvironmentModuleSchema, Environment>
  • AwsEcsEnvironmentModule

Index

Constructors

• constructor

Methods

• onInit
• registerMetadata

Resources

• EcsClusterSchema

Constructors

constructor

• AwsEcsEnvironmentModule(): AwsEcsEnvironmentModule

• Inherited from AModule<AwsEcsEnvironmentModuleSchema, Environment>.constructor

  Returns AwsEcsEnvironmentModule

Methods

onInit

• onInit(inputs: AwsEcsEnvironmentModuleSchema): Promise<AwsEcsEnvironment>

• Parameters

  • inputs: AwsEcsEnvironmentModuleSchema

  Returns Promise<AwsEcsEnvironment>

registerMetadata

• registerMetadata(inputs: AwsEcsEnvironmentModuleSchema): Promise<{ awsAccountId: string; awsRegionId: string; clusterName: string }>

• Parameters

  • inputs: AwsEcsEnvironmentModuleSchema

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