software.amazon.awscdk.services.eks

Class KubernetesManifestProps.Builder

java.lang.Object

software.amazon.awscdk.services.eks.KubernetesManifestProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KubernetesManifestProps>

Enclosing interface:

KubernetesManifestProps

@Stability(value=Stable)
public static final class KubernetesManifestProps.Builder
extends Object
implements software.amazon.jsii.Builder<KubernetesManifestProps>

A builder for KubernetesManifestProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
KubernetesManifestProps	build() Builds the configured instance.
KubernetesManifestProps.Builder	cluster(ICluster cluster) Sets the value of KubernetesManifestProps.getCluster()
KubernetesManifestProps.Builder	ingressAlb(Boolean ingressAlb) Sets the value of KubernetesManifestOptions.getIngressAlb()
KubernetesManifestProps.Builder	ingressAlbScheme(AlbScheme ingressAlbScheme) Sets the value of KubernetesManifestOptions.getIngressAlbScheme()
KubernetesManifestProps.Builder	manifest(List<? extends Map<String,? extends Object>> manifest) Sets the value of KubernetesManifestProps.getManifest()
KubernetesManifestProps.Builder	overwrite(Boolean overwrite) Sets the value of KubernetesManifestProps.getOverwrite()
KubernetesManifestProps.Builder	prune(Boolean prune) Sets the value of KubernetesManifestOptions.getPrune()
KubernetesManifestProps.Builder	skipValidation(Boolean skipValidation) Sets the value of KubernetesManifestOptions.getSkipValidation()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

cluster

@Stability(value=Stable)
public KubernetesManifestProps.Builder cluster(ICluster cluster)

Sets the value of KubernetesManifestProps.getCluster()

Parameters:

cluster - The EKS cluster to apply this manifest to. This parameter is required. [disable-awslint:ref-via-interface]

Returns:

this

manifest

@Stability(value=Stable)
public KubernetesManifestProps.Builder manifest(List<? extends Map<String,? extends Object>> manifest)

Sets the value of KubernetesManifestProps.getManifest()

Parameters:

manifest - The manifest to apply. This parameter is required. 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.

Returns:

this

overwrite

@Stability(value=Stable)
public KubernetesManifestProps.Builder overwrite(Boolean overwrite)

Sets the value of KubernetesManifestProps.getOverwrite()

Parameters:

overwrite - 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.

Returns:

this

ingressAlb

@Stability(value=Stable)
public KubernetesManifestProps.Builder ingressAlb(Boolean ingressAlb)

Sets the value of KubernetesManifestOptions.getIngressAlb()

Parameters:

ingressAlb - Automatically detect `Ingress` resources in the manifest and annotate them so they are picked up by an ALB Ingress Controller.

Returns:

this

ingressAlbScheme

@Stability(value=Stable)
public KubernetesManifestProps.Builder ingressAlbScheme(AlbScheme ingressAlbScheme)

Sets the value of KubernetesManifestOptions.getIngressAlbScheme()

Parameters:

ingressAlbScheme - Specify the ALB scheme that should be applied to `Ingress` resources. Only applicable if ingressAlb is set to true.

Returns:

this

prune

@Stability(value=Stable)
public KubernetesManifestProps.Builder prune(Boolean prune)

Sets the value of KubernetesManifestOptions.getPrune()

Parameters:

prune - 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.

Returns:

this

skipValidation

@Stability(value=Stable)
public KubernetesManifestProps.Builder skipValidation(Boolean skipValidation)

Sets the value of KubernetesManifestOptions.getSkipValidation()

Parameters:

skipValidation - A flag to signify if the manifest validation should be skipped.

Returns:

this

build

@Stability(value=Stable)
public KubernetesManifestProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<KubernetesManifestProps>

Returns:

a new instance of KubernetesManifestProps

Throws:

NullPointerException - if any required attribute was not provided