Documentation - v0.0.0
    Preparing search index...

    Represents a Vertical Pod Autoscaler (VPA) resource in Kubernetes.

    The VerticalPodAutoscaler automatically adjusts the resources requested by a pod's containers based on historical CPU and memory usage.

    Depends on availability of the Vertical Pod Autoscaler API in the cluster.

    Hierarchy

    • Resource
      • VerticalPodAutoscaler
    Index

    Constructors

    Properties

    apiObject: ApiObject

    base.Resource.apiObject

    containerPolicies: ContainerPolicy[]

    Container policies for the VPA.

    node: Node

    The tree node.

    permissions: ResourcePermissions
    resourceType: "VerticalPodAutoscaler" = 'VerticalPodAutoscaler'
    target: IScalable

    The workload to scale up or down.

    updateMode: "Off" | "Initial" | "Auto"

    The update mode for the VPA.

    Accessors

    • get apiGroup(): string

      The group portion of the API version (e.g. "authorization.k8s.io").

      Returns string

    • get apiVersion(): string

      The object's API version (e.g. "authorization.k8s.io/v1")

      Returns string

    • get kind(): string

      The object kind (e.g. "Deployment").

      Returns string

    • get metadata(): ApiObjectMetadataDefinition

      Returns ApiObjectMetadataDefinition

    • get name(): string

      The name of this API object.

      Returns string

    • get resourceName(): undefined | string

      The unique, namespace-global, name of an object inside the Kubernetes cluster.

      If this is omitted, the ApiResource should represent all objects of the given type.

      Returns undefined | string

    Methods

    • Return the IApiResource this object represents.

      Returns undefined | IApiResource

    • Return the non resource url this object represents.

      Returns undefined | string

    • Returns a string representation of this construct.

      Returns string

    • Checks if x is a construct.

      Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

      Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

      Parameters

      • x: any

        Any object

      Returns x is Construct

      true if x is an object created from a class which extends Construct.