Package software.amazon.awscdk.services.eks

Interface KubernetesManifestOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
KubernetesManifestProps
All Known Implementing Classes:
KubernetesManifestOptions.Jsii$Proxy, KubernetesManifestProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-09T14:39:10.761Z") @Stability(Stable) public interface KubernetesManifestOptions extends software.amazon.jsii.JsiiSerializable
Options for KubernetesManifest.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.eks.*;
 KubernetesManifestOptions kubernetesManifestOptions = KubernetesManifestOptions.builder()
         .ingressAlb(false)
         .ingressAlbScheme(AlbScheme.INTERNAL)
         .prune(false)
         .removalPolicy(RemovalPolicy.DESTROY)
         .skipValidation(false)
         .build();

  • Method Details

    • getIngressAlb

      @Stability(Stable) @Nullable default Boolean getIngressAlb()
      Automatically detect Ingress resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.

      Default: false

    • getIngressAlbScheme

      @Stability(Stable) @Nullable default AlbScheme getIngressAlbScheme()
      Specify the ALB scheme that should be applied to Ingress resources.

      Only applicable if ingressAlb is set to true.

      Default: AlbScheme.INTERNAL

    • getPrune

      @Stability(Stable) @Nullable default Boolean getPrune()
      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.

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

      See Also:

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      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

      Default: RemovalPolicy.DESTROY

    • getSkipValidation

      @Stability(Stable) @Nullable default Boolean getSkipValidation()
      A flag to signify if the manifest validation should be skipped.

      Default: false

    • builder

      @Stability(Stable) static KubernetesManifestOptions.Builder builder()
      Returns:
      a KubernetesManifestOptions.Builder of KubernetesManifestOptions