KubernetesPatchProps

class aws_cdk.aws_eks_v2.KubernetesPatchProps(*, apply_patch, cluster, resource_name, restore_patch, patch_type=None, removal_policy=None, resource_namespace=None)

Bases: object

Properties for KubernetesPatch.

Parameters:

  • apply_patch (Mapping[str, Any]) – The JSON object to pass to kubectl patch when the resource is created/updated.

  • cluster (ICluster) – The cluster to apply the patch to. [disable-awslint:ref-via-interface]

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

  • restore_patch (Mapping[str, Any]) – The JSON object to pass to kubectl patch when the resource is removed.

  • patch_type (Optional[PatchType]) – The patch type to pass to kubectl patch. The default type used by kubectl patch is “strategic”. Default: PatchType.STRATEGIC

  • removal_policy (Optional[RemovalPolicy]) – The removal policy applied to the custom resource that manages the Kubernetes patch. 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 Default: RemovalPolicy.DESTROY

  • resource_namespace (Optional[str]) – The kubernetes API namespace. Default: “default”

ExampleMetadata:

infused

Example:

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

Attributes

apply_patch

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

cluster

The cluster to apply the patch to.

[disable-awslint:ref-via-interface]

patch_type

The patch type to pass to kubectl patch.

The default type used by kubectl patch is “strategic”.

Default:

PatchType.STRATEGIC

removal_policy

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

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

Default:

RemovalPolicy.DESTROY

resource_name

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

resource_namespace

The kubernetes API namespace.

Default:

“default”

restore_patch

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