# KubernetesManifest

Represents a manifest within the Kubernetes system.

Alternatively, you can use `cluster.addManifest(resource[, resource, ...])`
to define resources on this cluster.

Applies/deletes the manifest using `kubectl`.

Extends: Construct › KubernetesManifest
Implements: IConstruct, IDependable

- Source: [`aws-eks/lib/k8s-manifest.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-eks/lib/k8s-manifest.ts#L133)
- Type last changed: v2.196.0 · 16 May 2025

## Example

```ts
declare const cluster: eks.Cluster;
const namespace = cluster.addManifest('my-namespace', {
  apiVersion: 'v1',
  kind: 'Namespace',
  metadata: { name: 'my-app' },
});

const service = cluster.addManifest('my-service', {
  metadata: {
    name: 'myservice',
    namespace: 'my-app',
  },
  spec: { }, // ...
});

service.node.addDependency(namespace); // will apply `my-namespace` before `my-service`.
```

## Initializer

```ts
new KubernetesManifest(scope: Construct, id: string, props: KubernetesManifestProps)
```

## Construct Props

- `cluster`: [ICluster](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.ICluster.html) (required) — The EKS cluster to apply this manifest to.

  [disable-awslint:ref-via-interface]

- `ingressAlb`: boolean = false — Automatically detect `Ingress` resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.

- `ingressAlbScheme`: [AlbScheme](/cdk/api/v2/docs/aws-cdk-lib.aws_eks.AlbScheme.html) = AlbScheme.INTERNAL — Specify the ALB scheme that should be applied to `Ingress` resources.

  Only applicable if `ingressAlb` is set to `true`.

- `manifest`: { [key: string]: any }[] (required) — The manifest to apply.

  Consists of any number of child resources.

  When the resources are created/updated, this manifest will be applied to the
  cluster through `kubectl apply` and when the resources or the stack is
  deleted, the resources in the manifest will be deleted through `kubectl delete`.

  ```ts
  [{
    apiVersion: 'v1',
    kind: 'Pod',
    metadata: { name: 'mypod' },
    spec: {
      containers: [ { name: 'hello', image: 'paulbouwer/hello-kubernetes:1.5', ports: [ { containerPort: 8080 } ] } ]
    }
  }]
  ```

- `overwrite`: boolean = false — Overwrite any existing resources.

  If this is set, we will use `kubectl apply` instead of `kubectl create`
  when the resource is created. Otherwise, if there is already a resource
  in the cluster with the same name, the operation will fail.

- `prune`: boolean — When a resource is removed from a Kubernetes manifest, it no longer appears in the manifest, and there is no way to know that this resource needs to be deleted.

  **Default:** based on the prune option of the cluster, which is `true` unless otherwise specified.

  To address this, `kubectl apply` has a `--prune` option which will
  query the cluster for all resources with a specific label and will remove
  all the labeld resources that are not part of the applied manifest. If this
  option is disabled and a resource is removed, it will become "orphaned" and
  will not be deleted from the cluster.

  When this option is enabled (default), the construct will inject a label to
  all Kubernetes resources included in this manifest which will be used to
  prune resources when the manifest changes via `kubectl apply --prune`.

  The label name will be `aws.cdk.eks/prune-<ADDR>` where `<ADDR>` is the
  42-char unique address of this construct in the construct tree. Value is
  empty.

- `removalPolicy`: [RemovalPolicy](/cdk/api/v2/docs/aws-cdk-lib.RemovalPolicy.html) = RemovalPolicy.DESTROY — The removal policy applied to the custom resource that manages the Kubernetes manifest.

  The removal policy controls what happens to the resource if it stops being managed by CloudFormation.
  This can happen in one of three situations:

  - The resource is removed from the template, so CloudFormation stops managing it
  - A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it
  - The stack is deleted, so CloudFormation stops managing all resources in it

- `skipValidation`: boolean = false — A flag to signify if the manifest validation should be skipped.

## Properties

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `RESOURCE_TYPE`: string (static) — The CloudFormation resource type.

## Methods

- `isConstruct(x: any): boolean` (static) — 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 object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining