1.204.0

interface KubernetesManifestOptions

LanguageType name
.NETAmazon.CDK.AWS.EKS.KubernetesManifestOptions
Javasoftware.amazon.awscdk.services.eks.KubernetesManifestOptions
Pythonaws_cdk.aws_eks.KubernetesManifestOptions
TypeScript (source)@aws-cdk/aws-eks » KubernetesManifestOptions

Options for KubernetesManifest.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as eks from '@aws-cdk/aws-eks';
const kubernetesManifestOptions: eks.KubernetesManifestOptions = {
  ingressAlb: false,
  ingressAlbScheme: eks.AlbScheme.INTERNAL,
  prune: false,
  skipValidation: false,
};

Properties

NameTypeDescription
ingressAlb?booleanAutomatically detect Ingress resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.
ingressAlbScheme?AlbSchemeSpecify the ALB scheme that should be applied to Ingress resources.
prune?booleanWhen 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.
skipValidation?booleanA flag to signify if the manifest validation should be skipped.

ingressAlb?

Type: boolean (optional, default: false)

Automatically detect Ingress resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.

ingressAlbScheme?

Type: AlbScheme (optional, default: AlbScheme.INTERNAL)

Specify the ALB scheme that should be applied to Ingress resources.

Only applicable if ingressAlb is set to true.

prune?

Type: boolean (optional, default: based on the prune option of the cluster, which is true unless otherwise specified.)

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.

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.

See also: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label

skipValidation?

Type: boolean (optional, default: false)

A flag to signify if the manifest validation should be skipped.

← PreviousNext →