class KubernetesPatch (construct)

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

Implements IConstruct, IConstruct, IDependable

A CloudFormation resource which applies/restores a JSON patch into a Kubernetes resource.

Example

declare const cluster: eks.Cluster;
new eks.KubernetesPatch(this, 'hello-kub-deployment-label', {
  cluster,
  resourceName: "deployment/hello-kubernetes",
  applyPatch: { spec: { replicas: 5 } },
  restorePatch: { spec: { replicas: 3 } },
})

Initializer

new KubernetesPatch(scope: Construct, id: string, props: KubernetesPatchProps)

Parameters

scope Construct
id string
props KubernetesPatchProps

Construct Props

Name	Type	Description
applyPatch	`{ [string]: any }`	The JSON object to pass to `kubectl patch` when the resource is created/updated.
cluster	`ICluster`	The cluster to apply the patch to.
resourceName	`string`	The full name of the resource to patch (e.g. `deployment/coredns`).
restorePatch	`{ [string]: any }`	The JSON object to pass to `kubectl patch` when the resource is removed.
patchType?	`PatchType`	The patch type to pass to `kubectl patch`.
resourceNamespace?	`string`	The kubernetes API namespace.

applyPatch

Type: { [string]: any }

The JSON object to pass to kubectl patch when the resource is created/updated.

cluster

Type: ICluster

The cluster to apply the patch to.

[disable-awslint:ref-via-interface]

resourceName

Type: string

The full name of the resource to patch (e.g. deployment/coredns).

restorePatch

Type: { [string]: any }

The JSON object to pass to kubectl patch when the resource is removed.

patchType?

Type: PatchType (optional, default: PatchType.STRATEGIC)

The patch type to pass to kubectl patch.

The default type used by kubectl patch is "strategic".

resourceNamespace?

Type: string (optional, default: "default")

The kubernetes API namespace.

Properties

Name	Type	Description
node	`ConstructNode`	The construct tree node associated with this construct.

node

Type: ConstructNode

The construct tree node associated with this construct.

Methods

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

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.