software.amazon.awscdk.services.eks

Class KubernetesManifestProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.eks.KubernetesManifestProps.Jsii$Proxy

All Implemented Interfaces:

KubernetesManifestOptions, KubernetesManifestProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

KubernetesManifestProps

@Stability(value=Experimental)
 @Internal
public static final class KubernetesManifestProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements KubernetesManifestProps

An implementation for KubernetesManifestProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.eks.KubernetesManifestProps

KubernetesManifestProps.Builder, KubernetesManifestProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(ICluster cluster, List<? extends Map<String,? extends Object>> manifest, Boolean overwrite, Boolean prune, Boolean skipValidation) Constructor that initializes the object based on literal property values passed by the KubernetesManifestProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
ICluster	getCluster() (experimental) The EKS cluster to apply this manifest to.
List<Map<String,Object>>	getManifest() (experimental) The manifest to apply.
Boolean	getOverwrite() (experimental) Overwrite any existing resources.
Boolean	getPrune() (experimental) 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.
Boolean	getSkipValidation() (experimental) A flag to signify if the manifest validation should be skipped.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.eks.KubernetesManifestProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(ICluster cluster,
                     List<? extends Map<String,? extends Object>> manifest,
                     Boolean overwrite,
                     Boolean prune,
                     Boolean skipValidation)

Constructor that initializes the object based on literal property values passed by the KubernetesManifestProps.Builder.

Method Detail

getCluster

public final ICluster getCluster()

Description copied from interface: KubernetesManifestProps

(experimental) The EKS cluster to apply this manifest to.

[disable-awslint:ref-via-interface]

Specified by:

getCluster in interface KubernetesManifestProps

getManifest

public final List<Map<String,Object>> getManifest()

Description copied from interface: KubernetesManifestProps

(experimental) 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:

 // Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
 asList(Map.of(
         "apiVersion", "v1",
         "kind", "Pod",
         "metadata", Map.of("name", "mypod"),
         "spec", Map.of(
                 "containers", asList(Map.of("name", "hello", "image", "paulbouwer/hello-kubernetes:1.5", "ports", asList(Map.of("containerPort", 8080)))))));

Specified by:

getManifest in interface KubernetesManifestProps

getOverwrite

public final Boolean getOverwrite()

Description copied from interface: KubernetesManifestProps

(experimental) 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.

Default: false

Specified by:

getOverwrite in interface KubernetesManifestProps

getPrune

public final Boolean getPrune()

Description copied from interface: KubernetesManifestOptions

(experimental) 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.

Default: - based on the prune option of the cluster, which is `true` unless otherwise specified.

Specified by:

getPrune in interface KubernetesManifestOptions

See Also:

https://kubernetes.io/docs/tasks/manage-kubernetes-objects/declarative-config/#alternative-kubectl-apply-f-directory-prune-l-your-label

getSkipValidation

public final Boolean getSkipValidation()

Description copied from interface: KubernetesManifestOptions

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

Default: false

Specified by:

getSkipValidation in interface KubernetesManifestOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object