KubernetesManifest¶
-
class
aws_cdk.aws_eks.
KubernetesManifest
(scope, id, *, cluster, manifest, overwrite=None, prune=None, skip_validation=None)¶ Bases:
aws_cdk.core.Construct
(experimental) 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
.- Stability
experimental
- Parameters
scope (
Construct
) –id (
str
) –cluster (
ICluster
) – (experimental) The EKS cluster to apply this manifest to. [disable-awslint:ref-via-interface]manifest (
List
[Mapping
[str
,Any
]]) – (experimental) 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 throughkubectl apply
and when the resources or the stack is deleted, the resources in the manifest will be deleted throughkubectl delete
.overwrite (
Optional
[bool
]) – (experimental) Overwrite any existing resources. If this is set, we will usekubectl apply
instead ofkubectl 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: falseprune (
Optional
[bool
]) – (experimental) 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
]) – (experimental) A flag to signify if the manifest validation should be skipped. Default: false
- Stability
experimental
Methods
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
RESOURCE_TYPE
= 'Custom::AWSCDK-EKS-KubernetesResource'¶
-
node
¶ The construct tree node associated with this construct.
- Return type
Static Methods
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool