Class Component<PropsT>

Type Parameters

PropsT extends DeploymentProps = DeploymentProps

Hierarchy

Component

Index

Constructors

Properties

#containers deployment id node props scaling? scope vpa? componentName

Accessors

Methods

addContainer addPdb createContainerProps createDeployment createDeploymentProps getResources

Constructors

constructor

new Component<PropsT>(scope, id, props): Component<PropsT>
Type Parameters
- PropsT extends DeploymentProps = DeploymentProps
Parameters
- scope: Construct
- id: string
- props: PropsT
Returns Component<PropsT>
- Defined in packages/k8s/construct/component/src/component.ts:115

Properties

`Private` #containers

#containers: Map<string, Container> = ...

`Readonly` deployment

deployment: Deployment

`Readonly` id

id: string

`Readonly` node

node: Node

`Readonly` props

props: PropsT

`Optional` `Readonly` scaling

scaling?: ComponentScaling = undefined

`Readonly` scope

scope: Construct

`Optional` `Readonly` vpa

vpa?: VerticalPodAutoscaler = undefined

`Static` componentName

componentName: string = ''

Accessors

containers

get containers(): Map<string, Container>
Returns Map<string, Container>
- Defined in packages/k8s/construct/component/src/component.ts:169

Methods

addContainer

addContainer(props): Container
Parameters
- props: ComponentContainerProps
Returns Container
- Defined in packages/k8s/construct/component/src/component.ts:268

addPdb

addPdb(props): Component<PropsT>
Parameters
- props: PodDisruptionBudgetProps
Returns Component<PropsT>
- Defined in packages/k8s/construct/component/src/component.ts:289

`Protected` createContainerProps

createContainerProps(source, ...props): ContainerProps
Parameters
- source: Partial<ContainerProps>
- Rest ...props: Partial<ContainerProps>[]
Returns ContainerProps
- Defined in packages/k8s/construct/component/src/component.ts:220

`Protected` createDeployment

createDeployment(props): Deployment
Parameters
- props: DeploymentProps
Returns Deployment
- Defined in packages/k8s/construct/component/src/component.ts:216

`Protected` createDeploymentProps

createDeploymentProps(): DeploymentProps
Returns DeploymentProps
- Defined in packages/k8s/construct/component/src/component.ts:212

`Protected` getResources

getResources(defaults?): ContainerResources
Parameters
- Optional defaults: ContainerResourceProps
Returns ContainerResources
- Defined in packages/k8s/construct/component/src/component.ts:173

Generated using TypeDoc