class KubernetesManifest (construct)

Language	Type name
.NET	Amazon.CDK.AWS.EKS.KubernetesManifest
Java	software.amazon.awscdk.services.eks.KubernetesManifest
Python	aws_cdk.aws_eks.KubernetesManifest
TypeScript (source)	@aws-cdk/aws-eks » KubernetesManifest

Implements IConstruct, IConstruct, IDependable

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.

Example

declare const cluster: eks.Cluster;
const namespace = cluster.addManifest('my-namespace', {
  apiVersion: 'v1',
  kind: 'Namespace',
  metadata: { name: 'my-app' },
});

const service = cluster.addManifest('my-service', {
  metadata: {
    name: 'myservice',
    namespace: 'my-app',
  },
  spec: { }, // ...
});

service.node.addDependency(namespace); // will apply `my-namespace` before `my-service`.

Initializer

new KubernetesManifest(scope: Construct, id: string, props: KubernetesManifestProps)

Parameters

• scope Construct
• id string
• props KubernetesManifestProps

Construct Props

Name	Type	Description
cluster	ICluster	The EKS cluster to apply this manifest to.
manifest	{ [string]: any }[]	The manifest to apply.
ingressAlb?	boolean	Automatically detect Ingress resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.
ingressAlbScheme?	AlbScheme	Specify the ALB scheme that should be applied to Ingress resources.
overwrite?	boolean	Overwrite any existing resources.
prune?	boolean	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.
skipValidation?	boolean	A flag to signify if the manifest validation should be skipped.

---

cluster

Type: ICluster

The EKS cluster to apply this manifest to.

[disable-awslint:ref-via-interface]

---

manifest

Type: { [string]: any }[]

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

[{
  apiVersion: 'v1',
  kind: 'Pod',
  metadata: { name: 'mypod' },
  spec: {
    containers: [ { name: 'hello', image: 'paulbouwer/hello-kubernetes:1.5', ports: [ { containerPort: 8080 } ] } ]
  }
}]

---

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.

---

overwrite?

Type: boolean (optional, default: false)

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.

---

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.

Properties

Name	Type	Description
node	ConstructNode	The construct tree node associated with this construct.
static RESOURCE_TYPE	string	The CloudFormation reosurce type.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

static RESOURCE_TYPE

Type: string

The CloudFormation reosurce type.

Methods

Name	Description
toString()	Returns a string representation of this construct.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.