software.amazon.awscdk.services.eks

Class KubernetesManifest.Builder

java.lang.Object

software.amazon.awscdk.services.eks.KubernetesManifest.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KubernetesManifest>

Enclosing class:

KubernetesManifest

@Stability(value=Stable)
public static final class KubernetesManifest.Builder
extends Object
implements software.amazon.jsii.Builder<KubernetesManifest>

A fluent builder for KubernetesManifest.

Method Summary

Modifier and Type	Method and Description
KubernetesManifest	build()
KubernetesManifest.Builder	cluster(ICluster cluster) The EKS cluster to apply this manifest to.
static KubernetesManifest.Builder	create(software.constructs.Construct scope, String id)
KubernetesManifest.Builder	manifest(List<? extends Map<String,? extends Object>> manifest) The manifest to apply.
KubernetesManifest.Builder	overwrite(Boolean overwrite) Overwrite any existing resources.
KubernetesManifest.Builder	prune(Boolean prune) 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.
KubernetesManifest.Builder	skipValidation(Boolean skipValidation) A flag to signify if the manifest validation should be skipped.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static KubernetesManifest.Builder create(software.constructs.Construct scope,
                                                                         String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of KubernetesManifest.Builder.

prune

@Stability(value=Stable)
public KubernetesManifest.Builder prune(Boolean prune)

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.

Parameters:

prune - 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. This parameter is required.

Returns:

this

See Also:

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

skipValidation

@Stability(value=Stable)
public KubernetesManifest.Builder skipValidation(Boolean skipValidation)

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

Default: false

Parameters:

skipValidation - A flag to signify if the manifest validation should be skipped. This parameter is required.

Returns:

this

cluster

@Stability(value=Stable)
public KubernetesManifest.Builder cluster(ICluster cluster)

The EKS cluster to apply this manifest to.

[disable-awslint:ref-via-interface]

Parameters:

cluster - The EKS cluster to apply this manifest to. This parameter is required.

Returns:

this

manifest

@Stability(value=Stable)
public KubernetesManifest.Builder manifest(List<? extends Map<String,? extends Object>> manifest)

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.

Example:

 // Example automatically generated. See https://github.com/aws/jsii/issues/826
 asList(Map.of(
         "apiVersion", "v1",
         "kind", "Pod",
         "metadata", Map.of("name", "mypod"),
         "spec", Map.of(
                 "containers", asList(Map.of("name", "hello", "image", "paulbouwer/hello-kubernetes:1.5", "ports", asList(Map.of("containerPort", 8080)))))));

Parameters:

manifest - The manifest to apply. This parameter is required.

Returns:

this

overwrite

@Stability(value=Stable)
public KubernetesManifest.Builder overwrite(Boolean overwrite)

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.

Default: false

Parameters:

overwrite - Overwrite any existing resources. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public KubernetesManifest build()

Specified by:

build in interface software.amazon.jsii.Builder<KubernetesManifest>