Skip to main content

AwsSubnet

Hierarchy

  • Subnet
    • AwsSubnet

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

readonlyNODE_NAME

NODE_NAME: string

readonlyNODE_TYPE

NODE_TYPE: NodeType

readonlyfilesystemMounts

filesystemMounts: { filesystemMountAnchorName: string; filesystemName: string }[] = []

readonlysubnetId

subnetId: string

The ID of the subnet.

  • Format is {regionId}-{subnetName}

readonlysubnetName

subnetName: string

The name of the subnet.

Accessors

disableSubnetIntraNetwork

  • get disableSubnetIntraNetwork(): boolean
  • set disableSubnetIntraNetwork(disableSubnetIntraNetwork: boolean): void
  • experimental

    To block/disable intra-network communication within self. When this is set to true, any execution within this subnet will not be able to communicate with other executions within the same subnet.

    @defaultValue

    false

    Returns boolean

  • Parameters

    • disableSubnetIntraNetwork: boolean

    Returns void

subnetType

  • get subnetType(): SubnetType
  • set subnetType(subnetType: SubnetType): void

  • Returns SubnetType

  • Parameters

    • subnetType: SubnetType

    Returns void

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

addFilesystemMount

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

  • Parameters

    • filesystemName: string

    Returns Promise<void>

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(): IAwsSubnet

  • Returns IAwsSubnet

updateNetworkingRules

  • updateNetworkingRules(subnet: Subnet, allowConnections: boolean): void

  • To update the networking rules of this subnet to allow or deny connectivity from another subnet. The networking rules are bi-directional, i.e. if subnet A can connect to subnet B, then subnet B can also connect to subnet A.

    Parameters

    • subnet: Subnet

      The other subnet.

    • allowConnections: boolean

      Set to true to allow this and the other subnet to connect. Set to false to block this and the other subnet from connecting.

    Returns void

staticunSynth

  • unSynth(subnet: IAwsSubnet, deReferenceContext: (context: string) => Promise<UnknownModel>): Promise<AwsSubnet>

  • Parameters

    • subnet: IAwsSubnet
    • deReferenceContext: (context: string) => Promise<UnknownModel>

    Returns Promise<AwsSubnet>