Class ApiComponent<PropsT>Abstract

Type Parameters

Hierarchy

Constructors

constructor

Properties

#private config deployment id node props scaling? scope vpa? componentName

Accessors

containers

Methods

addContainer addPdb createContainerProps createDeployment createDeploymentProps createHttpProbes getResources mountCsiSecrets supportsProbes

Constructors

Protected constructor

Properties

Private #private

#private: any

Readonly config

config: IApiConfig

Readonly deployment

deployment: Deployment

Readonly id

id: string

Readonly node

node: Node

Readonly props

props: PropsT

Optional Readonly scaling

scaling?: ComponentScaling

Readonly scope

scope: Construct

Optional Readonly vpa

vpa?: VerticalPodAutoscaler

Static componentName

componentName: string

Accessors

containers

  • get containers(): Map<string, Container>

  • Returns Map<string, Container>

Methods

addContainer

  • Parameters

    • props: ComponentContainerProps

    Returns Container

addPdb

  • Parameters

    • props: PodDisruptionBudgetProps

    Returns ApiComponent<PropsT>

Protected createContainerProps

  • Parameters

    • source: Partial<ContainerProps>
    • Rest ...props: Partial<ContainerProps>[]

    Returns ContainerProps

Protected createDeployment

  • Parameters

    • props: DeploymentProps

    Returns Deployment

Protected createDeploymentProps

  • Returns DeploymentProps

Protected createHttpProbes

  • Parameters

    • httpPath: string

    Returns Pick<ContainerProps, "readiness" | "liveness" | "startup">

Protected getResources

  • Parameters

    • Optional defaults: ContainerResourceProps

    Returns ContainerResources

mountCsiSecrets

Static supportsProbes

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc