2.240.0

interface KubernetesManifestProps ⚠️

LanguageType name
.NETAmazon.CDK.AWS.Eks.V2.Alpha.KubernetesManifestProps
Gogithub.com/aws/aws-cdk-go/awscdkeksv2alpha/v2#KubernetesManifestProps
Javasoftware.amazon.awscdk.services.eks.v2.alpha.KubernetesManifestProps
Pythonaws_cdk.aws_eks_v2_alpha.KubernetesManifestProps
TypeScript (source)@aws-cdk/aws-eks-v2-alpha » KubernetesManifestProps

⚠️ Deprecated: undefined

Implements KubernetesManifestOptions

Properties for KubernetesManifest.

Example

declare const cluster: eks.Cluster;
const appLabel = { app: "hello-kubernetes" };

const deployment = {
  apiVersion: "apps/v1",
  kind: "Deployment",
  metadata: { name: "hello-kubernetes" },
  spec: {
    replicas: 3,
    selector: { matchLabels: appLabel },
    template: {
      metadata: { labels: appLabel },
      spec: {
        containers: [
          {
            name: "hello-kubernetes",
            image: "paulbouwer/hello-kubernetes:1.5",
            ports: [ { containerPort: 8080 } ],
          },
        ],
      },
    },
  },
};

const service = {
  apiVersion: "v1",
  kind: "Service",
  metadata: { name: "hello-kubernetes" },
  spec: {
    type: "LoadBalancer",
    ports: [ { port: 80, targetPort: 8080 } ],
    selector: appLabel,
  }
};

// option 1: use a construct
new eks.KubernetesManifest(this, 'hello-kub', {
  cluster,
  manifest: [ deployment, service ],
});

// or, option2: use `addManifest`
cluster.addManifest('hello-kub', service, deployment);

Properties

NameTypeDescription
cluster⚠️IClusterThe EKS cluster to apply this manifest to.
manifest⚠️{ [string]: any }[]The manifest to apply.
ingressAlb?⚠️booleanAutomatically detect Ingress resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.
ingressAlbScheme?⚠️AlbSchemeSpecify the ALB scheme that should be applied to Ingress resources.
overwrite?⚠️booleanOverwrite any existing resources.
prune?⚠️booleanWhen 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.
removalPolicy?⚠️RemovalPolicyThe removal policy applied to the custom resource that manages the Kubernetes manifest.
skipValidation?⚠️booleanA flag to signify if the manifest validation should be skipped.

cluster⚠️

⚠️ Deprecated: undefined

Type: ICluster

The EKS cluster to apply this manifest to.

[disable-awslint:ref-via-interface]

manifest⚠️

⚠️ Deprecated: undefined

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?⚠️

⚠️ Deprecated: undefined

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?⚠️

⚠️ Deprecated: undefined

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?⚠️

⚠️ Deprecated: undefined

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?⚠️

⚠️ Deprecated: undefined

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

removalPolicy?⚠️

⚠️ Deprecated: undefined

Type: RemovalPolicy (optional, default: RemovalPolicy.DESTROY)

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

skipValidation?⚠️

⚠️ Deprecated: undefined

Type: boolean (optional, default: false)

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

← PreviousNext →