KubernetesManifestOptions¶
-
class
aws_cdk.aws_eks.
KubernetesManifestOptions
(*, prune=None, skip_validation=None)¶ Bases:
object
Options for
KubernetesManifest
.- Parameters
prune (
Optional
[bool
]) – 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 viakubectl apply --prune
. The label name will beaws.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 istrue
unless otherwise specified.skip_validation (
Optional
[bool
]) – A flag to signify if the manifest validation should be skipped. Default: false
Attributes
-
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.
-
skip_validation
¶ A flag to signify if the manifest validation should be skipped.
- Default
false
- Return type
Optional
[bool
]