class KubernetesResource (construct) ⚠️

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

⚠️ Deprecated: undefined

Implements IConstruct, IConstruct, IDependable

Represents a resource within the Kubernetes system.

Alternatively, you can use cluster.addResource(resource[, resource, ...]) to define resources on this cluster.

Applies/deletes the resources using kubectl in sync with the resource.

Example

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,
  },
};

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

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

Initializer

new KubernetesResource(scope: Construct, id: string, props: KubernetesResourceProps)

⚠️ Deprecated: undefined

Parameters

• scope Construct
• id string
• props KubernetesResourceProps

Construct Props

Name	Type	Description
cluster⚠️	Cluster	The EKS cluster to apply this configuration to.
manifest⚠️	any[]	The resource manifest.

---

cluster⚠️

⚠️ Deprecated: undefined

Type: Cluster

The EKS cluster to apply this configuration to.

[disable-awslint:ref-via-interface]

---

manifest⚠️

⚠️ Deprecated: undefined

Type: any[]

The resource manifest.

Consists of any number of child resources.

When the resource is created/updated, this manifest will be applied to the cluster through kubectl apply and when the resource or the stack is deleted, the manifest will be deleted through kubectl delete.

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

Properties

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

---

node⚠️

⚠️ Deprecated: undefined

Type: ConstructNode

The construct tree node associated with this construct.

---

static RESOURCE_TYPE⚠️

⚠️ Deprecated: undefined

Type: string

The CloudFormation reosurce type.

Methods

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

---

toString()⚠️

public toString(): string

⚠️ Deprecated: undefined

Returns

• string

Returns a string representation of this construct.