AwsImage

Hierarchy

• Image
  • AwsImage

Index

Constructors

• constructor

Properties

• NODE_NAME
• NODE_TYPE
• dockerOptions
• imageId
• imageName
• imageTag

Methods

• addAnchor
• addChild
• addRelationship
• diff
• diffProperties
• getAncestors
• getAnchor
• getAnchorIndex
• getAnchors
• getBoundaryMembers
• getChild
• getChildren
• getContext
• getDependencies
• getDependency
• getDependencyIndex
• getParents
• getSiblings
• hasAncestor
• removeAllAnchors
• removeAnchor
• removeDependency
• removeRelationship
• setContext
• synth
• unSynth

Constructors

constructor

• new AwsImage(imageName: string, imageTag: string, options: IImageDockerOptions): AwsImage

• Overrides Image.constructor

  Parameters

  • imageName: string

  • imageTag: string

  • options: IImageDockerOptions

  Returns AwsImage

Properties

readonlyNODE_NAME

NODE_NAME: string

Inherited from Image.NODE_NAME

readonlyNODE_TYPE

NODE_TYPE: NodeType

Inherited from Image.NODE_TYPE

readonlydockerOptions

dockerOptions: IImageDockerOptions

Inherited from Image.dockerOptions

readonlyimageId

imageId: string

Inherited from Image.imageId

An imageId is the unique identifier for this image.

• Format of imageId is {imageName}:{imageTag}

readonlyimageName

imageName: string

Inherited from Image.imageName

The name of the image, same as namespace in Docker.

readonlyimageTag

imageTag: string

Inherited from Image.imageTag

The tag of the image, same as tag in Docker.

• Unlike Docker, imageTag is mandatory in Octo.

Methods

addAnchor

• addAnchor(anchor: AAnchor): void

• Inherited from Image.addAnchor

  Parameters

  • anchor: AAnchor

  Returns void

addChild

• addChild(onField: string, child: UnknownNode, toField: string): { childToParentDependency: Dependency; parentToChildDependency: Dependency }

• Inherited from Image.addChild

  Parameters

  • onField: string

  • child: UnknownNode

  • toField: string

  Returns { childToParentDependency: Dependency; parentToChildDependency: Dependency }

  • childToParentDependency: Dependency

  • parentToChildDependency: Dependency

addRelationship

• addRelationship(to: UnknownNode): { thatToThisDependency: Dependency; thisToThatDependency: Dependency }

• Inherited from Image.addRelationship

  Parameters

  • to: UnknownNode

  Returns { thatToThisDependency: Dependency; thisToThatDependency: Dependency }

  • thatToThisDependency: Dependency

  • thisToThatDependency: Dependency

diff

• diff(): Promise<Diff[]>

• Inherited from Image.diff

  Returns Promise<Diff[]>

diffProperties

• diffProperties(): Promise<Diff[]>

• Inherited from Image.diffProperties

  Returns Promise<Diff[]>

getAncestors

• getAncestors(): UnknownNode[]

• Inherited from Image.getAncestors

  Returns UnknownNode[]

getAnchor

• getAnchor(anchorId: string, parent?: UnknownModel): undefined | AAnchor

• Inherited from Image.getAnchor

  Parameters

  • anchorId: string

  • optionalparent: UnknownModel

  Returns undefined | AAnchor

getAnchorIndex

• getAnchorIndex(anchorId: string, parent?: UnknownModel): number

• Inherited from Image.getAnchorIndex

  Parameters

  • anchorId: string

  • optionalparent: UnknownModel

  Returns number

getAnchors

• getAnchors(filters?: { key: string; value: any }[]): AAnchor[]

• Inherited from Image.getAnchors

  Parameters

  • optionalfilters: { key: string; value: any }[]

  Returns AAnchor[]

getBoundaryMembers

• getBoundaryMembers(): UnknownNode[]

• Inherited from Image.getBoundaryMembers

  Returns UnknownNode[]

getChild

• getChild(name: string, filters?: { key: string; value: any }[]): undefined | UnknownNode

• Inherited from Image.getChild

  Parameters

  • name: string

  • optionalfilters: { key: string; value: any }[]

  Returns undefined | UnknownNode

getChildren

• getChildren(name?: string): {}

• Inherited from Image.getChildren

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

getContext

• getContext(): string

• Inherited from Image.getContext

  Returns string

getDependencies

• getDependencies(to?: UnknownNode): Dependency[]

• Inherited from Image.getDependencies

  Parameters

  • optionalto: UnknownNode

  Returns Dependency[]

getDependency

• getDependency(to: UnknownNode, relationship: DependencyRelationship): undefined | Dependency

• Inherited from Image.getDependency

  Parameters

  • to: UnknownNode

  • relationship: DependencyRelationship

  Returns undefined | Dependency

getDependencyIndex

• getDependencyIndex(to: UnknownNode, relationship: DependencyRelationship): number

• Inherited from Image.getDependencyIndex

  Parameters

  • to: UnknownNode

  • relationship: DependencyRelationship

  Returns number

getParents

• getParents(name?: string): {}

• Inherited from Image.getParents

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

getSiblings

• getSiblings(name?: string): {}

• Inherited from Image.getSiblings

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

hasAncestor

• hasAncestor(node: UnknownNode): boolean

• Inherited from Image.hasAncestor

  Parameters

  • node: UnknownNode

  Returns boolean

removeAllAnchors

• removeAllAnchors(): void

• Inherited from Image.removeAllAnchors

  Returns void

removeAnchor

• removeAnchor(anchor: AAnchor): void

• Inherited from Image.removeAnchor

  Parameters

  • anchor: AAnchor

  Returns void

removeDependency

• removeDependency(dependencyIndex: number): void

• Inherited from Image.removeDependency

  Parameters

  • dependencyIndex: number

  Returns void

removeRelationship

• removeRelationship(node: UnknownNode): void

• Inherited from Image.removeRelationship

  Parameters

  • node: UnknownNode

  Returns void

setContext

• setContext(): string

• Inherited from Image.setContext

  Returns string

synth

• synth(): IImage

• Inherited from Image.synth

  Returns IImage

staticunSynth

• unSynth(image: IAwsImage): Promise<AwsImage>

• Overrides Image.unSynth

  Parameters

  • image: IAwsImage

  Returns Promise<AwsImage>