Skip to main content

AwsImage

Hierarchy

  • Image
    • AwsImage

Index

Constructors

constructor

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

    • imageName: string
    • imageTag: string
    • options: IImageDockerOptions

    Returns AwsImage

Properties

readonlyNODE_NAME

NODE_NAME: string

readonlyNODE_TYPE

NODE_TYPE: NodeType

readonlydockerOptions

dockerOptions: IImageDockerOptions

readonlyimageId

imageId: string

An imageId is the unique identifier for this image.

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

readonlyimageName

imageName: string

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

readonlyimageTag

imageTag: string

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

  • Unlike Docker, imageTag is mandatory in Octo.

Methods

addAnchor

  • addAnchor(anchor: AAnchor): void
  • Parameters

    • anchor: AAnchor

    Returns void

addChild

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

    • onField: string
    • child: UnknownNode
    • toField: string

    Returns { childToParentDependency: Dependency; parentToChildDependency: Dependency }

    • childToParentDependency: Dependency
    • parentToChildDependency: Dependency

addRelationship

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

    • to: UnknownNode

    Returns { thatToThisDependency: Dependency; thisToThatDependency: Dependency }

    • thatToThisDependency: Dependency
    • thisToThatDependency: Dependency

diff

  • diff(): Promise<Diff[]>
  • Returns Promise<Diff[]>

diffProperties

  • diffProperties(): Promise<Diff[]>
  • Returns Promise<Diff[]>

getAncestors

  • getAncestors(): UnknownNode[]
  • Returns UnknownNode[]

getAnchor

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

    • anchorId: string
    • optionalparent: UnknownModel

    Returns undefined | AAnchor

getAnchorIndex

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

    • anchorId: string
    • optionalparent: UnknownModel

    Returns number

getAnchors

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

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

    Returns AAnchor[]

getBoundaryMembers

  • getBoundaryMembers(): UnknownNode[]
  • Returns UnknownNode[]

getChild

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

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

    Returns undefined | UnknownNode

getChildren

  • getChildren(name?: string): {}
  • Parameters

    • optionalname: string

    Returns {}

    • [key string]: Dependency[]

getContext

  • getContext(): string
  • Returns string

getDependencies

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

    • optionalto: UnknownNode

    Returns Dependency[]

getDependency

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

    • to: UnknownNode
    • relationship: DependencyRelationship

    Returns undefined | Dependency

getDependencyIndex

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

    • to: UnknownNode
    • relationship: DependencyRelationship

    Returns number

getParents

  • getParents(name?: string): {}
  • Parameters

    • optionalname: string

    Returns {}

    • [key string]: Dependency[]

getSiblings

  • getSiblings(name?: string): {}
  • Parameters

    • optionalname: string

    Returns {}

    • [key string]: Dependency[]

hasAncestor

  • hasAncestor(node: UnknownNode): boolean
  • Parameters

    • node: UnknownNode

    Returns boolean

removeAllAnchors

  • removeAllAnchors(): void
  • Returns void

removeAnchor

  • removeAnchor(anchor: AAnchor): void
  • Parameters

    • anchor: AAnchor

    Returns void

removeDependency

  • removeDependency(dependencyIndex: number): void
  • Parameters

    • dependencyIndex: number

    Returns void

removeRelationship

  • removeRelationship(node: UnknownNode): void
  • Parameters

    • node: UnknownNode

    Returns void

setContext

  • setContext(): string
  • Returns string

synth

  • synth(): IImage
  • Returns IImage

staticunSynth

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

    • image: IAwsImage

    Returns Promise<AwsImage>