Class ApiComponent<PropsT>`Abstract`

Type Parameters

PropsT extends ApiProps = ApiProps

Hierarchy (View Summary)

Component<PropsT>
- ApiComponent

Index

Constructors

Properties

config deployment id node props scaling? scope vpa? componentName

Accessors

Methods

addContainer addPdb createContainerProps createDeployment createDeploymentProps createHttpProbes getResources mountCsiSecrets supportsProbes

Constructors

`Protected`constructor

new ApiComponent<PropsT extends ApiProps = ApiProps>(
    scope: Construct,
    id: string,
    props: PropsT,
): ApiComponent<PropsT>
Type Parameters
- PropsT extends ApiProps = ApiProps
Parameters
- scope: Construct
- id: string
- props: PropsT
Returns ApiComponent<PropsT>
Overrides Component<PropsT>.constructor
- Defined in packages/k8s/construct/api/src/api.ts:93

Properties

`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>
Inherited from Component.containers
- Defined in packages/k8s/construct/component/dist/index.d.mts:233

Methods

addContainer

addContainer(props: ComponentContainerProps): Container
Parameters
- props: ComponentContainerProps
Returns Container
Inherited from Component.addContainer
- Defined in packages/k8s/construct/component/dist/index.d.mts:238

addPdb

addPdb(props: PodDisruptionBudgetProps): this
Parameters
- props: PodDisruptionBudgetProps
Returns this
Inherited from Component.addPdb
- Defined in packages/k8s/construct/component/dist/index.d.mts:239

`Protected`createContainerProps

createContainerProps(
source: Partial<kplus.ContainerProps>,
...props: Partial<ContainerProps>[],
): ContainerProps
Parameters
- source: Partial<kplus.ContainerProps>
- ...props: Partial<ContainerProps>[]
Returns ContainerProps
Inherited from Component.createContainerProps
- Defined in packages/k8s/construct/component/dist/index.d.mts:237

`Protected`createDeployment

createDeployment(props: DeploymentProps): Deployment
Parameters
- props: DeploymentProps
Returns Deployment
Inherited from Component.createDeployment
- Defined in packages/k8s/construct/component/dist/index.d.mts:236

`Protected`createDeploymentProps

createDeploymentProps(): DeploymentProps
Returns DeploymentProps
Inherited from Component.createDeploymentProps
- Defined in packages/k8s/construct/component/dist/index.d.mts:235

`Protected`createHttpProbes

createHttpProbes(
httpPath: string,
): Pick<kplus.ContainerProps, "readiness" | "liveness" | "startup">
Parameters
- httpPath: string
Returns Pick<kplus.ContainerProps, "readiness" | "liveness" | "startup">
- Defined in packages/k8s/construct/api/src/api.ts:143

`Protected`getResources

getResources(defaults?: ContainerResourceProps): ContainerResources
Parameters
- Optionaldefaults: ContainerResourceProps
Returns ContainerResources
Inherited from Component.getResources
- Defined in packages/k8s/construct/component/dist/index.d.mts:234

mountCsiSecrets

mountCsiSecrets(
csiVolume: Volume,
secretNames: [key: string, env_name: EnvValue][],
): void
Parameters
- csiVolume: Volume
- secretNames: [key: string, env_name: EnvValue][]
Returns void
- Defined in packages/k8s/construct/api/src/api.ts:171

`Static`supportsProbes

supportsProbes<T extends Construct>(
construct: T,
): construct is T & IHttpProbable
Type Parameters
- T extends Construct
Parameters
- construct: T
Returns construct is T & IHttpProbable
- Defined in packages/k8s/construct/api/src/api.ts:81