AwsRegion

Hierarchy

• Region
  • AwsRegion

Index

Constructors

• constructor

Properties

• NODE_NAME
• NODE_TYPE
• awsRegionAZ
• awsRegionId
• filesystems
• regionId

Methods

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

Constructors

constructor

• new AwsRegion(regionId: RegionId): AwsRegion

• Overrides Region.constructor

  Parameters

  • regionId: RegionId

  Returns AwsRegion

Properties

readonlyNODE_NAME

NODE_NAME: string

Inherited from Region.NODE_NAME

readonlyNODE_TYPE

NODE_TYPE: NodeType

Inherited from Region.NODE_TYPE

readonlyawsRegionAZ

awsRegionAZ: string

readonlyawsRegionId

awsRegionId: string

readonlyfilesystems

filesystems: { filesystemAnchorName: string; filesystemName: string }[] = []

readonlyregionId

regionId: RegionId

Overrides Region.regionId

Methods

addAnchor

• addAnchor(anchor: AAnchor): void

• Inherited from Region.addAnchor

  Parameters

  • anchor: AAnchor

  Returns void

addChild

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

• Inherited from Region.addChild

  Parameters

  • onField: string

  • child: UnknownNode

  • toField: string

  Returns { childToParentDependency: Dependency; parentToChildDependency: Dependency }

  • childToParentDependency: Dependency

  • parentToChildDependency: Dependency

addEnvironment

• addEnvironment(environment: Environment): void

• Inherited from Region.addEnvironment

  To add an Environment.

  ---

  Parameters

  • environment: Environment

  Returns void

addFilesystem

• addFilesystem(filesystemName: string): Promise<void>

• Parameters

  • filesystemName: string

  Returns Promise<void>

addRelationship

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

• Inherited from Region.addRelationship

  Parameters

  • to: UnknownNode

  Returns { thatToThisDependency: Dependency; thisToThatDependency: Dependency }

  • thatToThisDependency: Dependency

  • thisToThatDependency: Dependency

addSubnet

• addSubnet(subnet: Subnet): void

• Inherited from Region.addSubnet

  To add a Subnet.

  ---

  Parameters

  • subnet: Subnet

  Returns void

diff

• diff(): Promise<Diff[]>

• Inherited from Region.diff

  Returns Promise<Diff[]>

diffProperties

• diffProperties(): Promise<Diff[]>

• Inherited from Region.diffProperties

  Returns Promise<Diff[]>

getAncestors

• getAncestors(): UnknownNode[]

• Inherited from Region.getAncestors

  Returns UnknownNode[]

getAnchor

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

• Inherited from Region.getAnchor

  Parameters

  • anchorId: string

  • optionalparent: UnknownModel

  Returns undefined | AAnchor

getAnchorIndex

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

• Inherited from Region.getAnchorIndex

  Parameters

  • anchorId: string

  • optionalparent: UnknownModel

  Returns number

getAnchors

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

• Inherited from Region.getAnchors

  Parameters

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

  Returns AAnchor[]

getBoundaryMembers

• getBoundaryMembers(): UnknownNode[]

• Inherited from Region.getBoundaryMembers

  Returns UnknownNode[]

getChild

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

• Inherited from Region.getChild

  Parameters

  • name: string

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

  Returns undefined | UnknownNode

getChildren

• getChildren(name?: string): {}

• Inherited from Region.getChildren

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

getContext

• getContext(): string

• Inherited from Region.getContext

  Returns string

getDependencies

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

• Inherited from Region.getDependencies

  Parameters

  • optionalto: UnknownNode

  Returns Dependency[]

getDependency

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

• Inherited from Region.getDependency

  Parameters

  • to: UnknownNode

  • relationship: DependencyRelationship

  Returns undefined | Dependency

getDependencyIndex

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

• Inherited from Region.getDependencyIndex

  Parameters

  • to: UnknownNode

  • relationship: DependencyRelationship

  Returns number

getParents

• getParents(name?: string): {}

• Inherited from Region.getParents

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

getSiblings

• getSiblings(name?: string): {}

• Inherited from Region.getSiblings

  Parameters

  • optionalname: string

  Returns {}

  • [key string]: Dependency[]

hasAncestor

• hasAncestor(node: UnknownNode): boolean

• Inherited from Region.hasAncestor

  Parameters

  • node: UnknownNode

  Returns boolean

removeAllAnchors

• removeAllAnchors(): void

• Inherited from Region.removeAllAnchors

  Returns void

removeAnchor

• removeAnchor(anchor: AAnchor): void

• Inherited from Region.removeAnchor

  Parameters

  • anchor: AAnchor

  Returns void

removeDependency

• removeDependency(dependencyIndex: number): void

• Inherited from Region.removeDependency

  Parameters

  • dependencyIndex: number

  Returns void

removeRelationship

• removeRelationship(node: UnknownNode): void

• Inherited from Region.removeRelationship

  Parameters

  • node: UnknownNode

  Returns void

setContext

• setContext(): string

• Inherited from Region.setContext

  Returns string

synth

• synth(): IAwsRegion

• Overrides Region.synth

  Returns IAwsRegion

staticgetRandomRegionIdFromAwsRegionId

• getRandomRegionIdFromAwsRegionId(awsRegionId: string): undefined | RegionId

• Parameters

  • awsRegionId: string

  Returns undefined | RegionId

staticgetRegionIdParts

• getRegionIdParts(regionId: RegionId): { awsRegionAZ: string; awsRegionId: string }

• Parameters

  • regionId: RegionId

  Returns { awsRegionAZ: string; awsRegionId: string }

  • awsRegionAZ: string

  • awsRegionId: string

staticunSynth

• unSynth(awsRegion: IAwsRegion): Promise<AwsRegion>

• Overrides Region.unSynth

  Parameters

  • awsRegion: IAwsRegion

  Returns Promise<AwsRegion>