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`.
Import
import { KubernetesManifest } from 'aws-cdk-lib/aws-eks';Or use the module namespace:
import * as eks from 'aws-cdk-lib/aws-eks';
// eks.KubernetesManifestProperties
Configuration passed to the constructor as KubernetesManifestProps.
clusterRequiredIClusterThe EKS cluster to apply this manifest to. [disable-awslint:ref-via-interface]
manifestRequired{ [key: string]: any }[]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`.
overwriteOptionalbooleanOverwrite 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.
Default: false
5 properties inherited from KubernetesManifestOptions
ingressAlbOptionalinherited from KubernetesManifestOptionsbooleanAutomatically detect `Ingress` resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.
Default: false
ingressAlbSchemeOptionalinherited from KubernetesManifestOptionsAlbSchemeSpecify the ALB scheme that should be applied to `Ingress` resources. Only applicable if `ingressAlb` is set to `true`.
Default: AlbScheme.INTERNAL
pruneOptionalinherited from KubernetesManifestOptionsbooleanWhen 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. 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.
Default: - based on the prune option of the cluster, which is `true` unless
otherwise specified.
removalPolicyOptionalinherited from KubernetesManifestOptionsRemovalPolicyThe 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
Default: RemovalPolicy.DESTROY
skipValidationOptionalinherited from KubernetesManifestOptionsbooleanA flag to signify if the manifest validation should be skipped.
Default: false
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-eks