KubernetesPatch

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

Source: aws-eks/lib/k8s-patch.ts

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

python

# cluster: eks.Cluster

eks.KubernetesPatch(self, "hello-kub-deployment-label",
    cluster=cluster,
    resource_name="deployment/hello-kubernetes",
    apply_patch={"spec": {"replicas": 5}},
    restore_patch={"spec": {"replicas": 3}}
)

java

Cluster cluster;

KubernetesPatch.Builder.create(this, "hello-kub-deployment-label")
        .cluster(cluster)
        .resourceName("deployment/hello-kubernetes")
        .applyPatch(Map.of("spec", Map.of("replicas", 5)))
        .restorePatch(Map.of("spec", Map.of("replicas", 3)))
        .build();

csharp

// Install: dotnet add package Amazon.CDK.Lib
Cluster cluster;

new KubernetesPatch(this, "hello-kub-deployment-label", new KubernetesPatchProps {
    Cluster = cluster,
    ResourceName = "deployment/hello-kubernetes",
    ApplyPatch = new Dictionary<string, object> { { "spec", new Dictionary<string, int> { { "replicas", 5 } } } },
    RestorePatch = new Dictionary<string, object> { { "spec", new Dictionary<string, int> { { "replicas", 3 } } } }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var cluster Cluster

eks.NewKubernetesPatch(this, jsii.String("hello-kub-deployment-label"), &KubernetesPatchProps{
	Cluster: Cluster,
	ResourceName: jsii.String("deployment/hello-kubernetes"),
	ApplyPatch: map[string]interface{}{
		"spec": map[string]*f64{
			"replicas": jsii.Number(5),
		},
	},
	RestorePatch: map[string]interface{}{
		"spec": map[string]*f64{
			"replicas": jsii.Number(3),
		},
	},
})

Initializer

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

python

KubernetesPatch(scope: Construct, id: str, props: KubernetesPatchProps)

java

new KubernetesPatch(Construct scope, String id, KubernetesPatchProps props)

csharp

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

NewKubernetesPatch(Scope Construct, Id *string, Props KubernetesPatchProps)

Construct Props

applyPatch{ [key: string]: any }apply_patchtyping.Mapping[str, Any]applyPatchMap<String, Object>ApplyPatchIDictionary<string, object>ApplyPatch*map[string]interface{}required#

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

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#

The cluster to apply the patch to.

[disable-awslint:ref-via-interface]

patchTypeoptionalPatchTypepatch_typeoptionalPatchTypepatchTypeoptionalPatchTypePatchTypeoptionalPatchTypePatchTypeoptionalPatchType= PatchType.STRATEGIC#

The patch type to pass to `kubectl patch`.

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

removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= RemovalPolicy.DESTROY#

The removal policy applied to the custom resource that manages the Kubernetes patch.

notes

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

resourceNamestringresource_namestrresourceNameStringResourceNamestringResourceName*stringrequired#

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

resourceNamespaceoptionalstringresource_namespaceoptionalstrresourceNamespaceoptionalStringResourceNamespaceoptionalstringResourceNamespaceoptional*string= "default"#

The kubernetes API namespace.

restorePatch{ [key: string]: any }restore_patchtyping.Mapping[str, Any]restorePatchMap<String, Object>RestorePatchIDictionary<string, object>RestorePatch*map[string]interface{}required#

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

Properties

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

Methods

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining

KubernetesPatch ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​