AwsEcrImageModule

AwsEcrImageModule is an ECR-based AWS image module that provides an implementation for the Image model. This module creates AWS ECR (Elastic Container Registry) repositories for storing and managing container images. It provides functionality to manage Docker images across multiple AWS regions and generate ECR authentication commands.

@example

TypeScript

import { AwsEcrImageModule } from '@quadnix/octo-aws-cdk/modules/image/aws-ecr-image';

octo.loadModule(AwsEcrImageModule, 'my-image-module', {
  imageFamily: 'quadnix',
  imageName: 'nginx',
  regions: [myRegion1, myRegion2]
});

@group

Modules/Image/AwsEcrImage

@see

• AwsEcrImageModuleSchema for the input schema.
• AModule to learn more about modules.
• Image to learn more about the Image model.

Hierarchy

• AModule<AwsEcrImageModuleSchema, AwsEcrImage>
  • AwsEcrImageModule

Index

Constructors

• constructor

Properties

• moduleId
• MODULE_PACKAGE
• MODULE_SCHEMA

Methods

• getEcrRepositoryCommands
• onInit
• registerHooks
• registerMetadata

Resources

• EcrImageSchema

Constructors

constructor

• AwsEcrImageModule(moduleId: string): AwsEcrImageModule

• Inherited from AModule<AwsEcrImageModuleSchema, AwsEcrImage>.constructor

  Parameters

  • moduleId: string

  Returns AwsEcrImageModule

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

getEcrRepositoryCommands

• getEcrRepositoryCommands(imageFamily: string, imageName: string, imageTag: string, properties: { awsAccountId: string; awsRegionId: string; dockerExec?: string }): Promise<{ login: string; push: string; tag: string }>

• Parameters

  • imageFamily: string

  • imageName: string

  • imageTag: string

  • properties: { awsAccountId: string; awsRegionId: string; dockerExec?: string }

  • awsAccountId: string

  • awsRegionId: string

  • optionaldockerExec: string

  Returns Promise<{ login: string; push: string; tag: string }>

onInit

• onInit(inputs: AwsEcrImageModuleSchema): Promise<AwsEcrImage>

• Overrides AModule.onInit

  Parameters

  • inputs: AwsEcrImageModuleSchema

  Returns Promise<AwsEcrImage>

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: AwsEcrImageModuleSchema): Promise<{ app: App; uniqueImageRepositories: { awsAccountId: string; awsRegionId: string }[] }>

• Overrides AModule.registerMetadata

  Parameters

  • inputs: AwsEcrImageModuleSchema

  Returns Promise<{ app: App; uniqueImageRepositories: { awsAccountId: string; awsRegionId: string }[] }>