Package software.amazon.awscdk.services.eks

Class KubernetesObjectValue.Builder

java.lang.Object

software.amazon.awscdk.services.eks.KubernetesObjectValue.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<KubernetesObjectValue>

Enclosing class:

KubernetesObjectValue

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

A fluent builder for KubernetesObjectValue.

Method Summary

Modifier and Type	Method	Description
KubernetesObjectValue	build()
KubernetesObjectValue.Builder	cluster(ICluster cluster)	The EKS cluster to fetch attributes from.
static KubernetesObjectValue.Builder	create(software.constructs.Construct scope, String id)
KubernetesObjectValue.Builder	jsonPath(String jsonPath)	JSONPath to the specific value.
KubernetesObjectValue.Builder	objectName(String objectName)	The name of the object to query.
KubernetesObjectValue.Builder	objectNamespace(String objectNamespace)	The namespace the object belongs to.
KubernetesObjectValue.Builder	objectType(String objectType)	The object type to query.
KubernetesObjectValue.Builder	timeout(Duration timeout)	Timeout for waiting on a value.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static KubernetesObjectValue.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of KubernetesObjectValue.Builder.

cluster

@Stability(Stable)
public KubernetesObjectValue.Builder cluster(ICluster cluster)

The EKS cluster to fetch attributes from.

[disable-awslint:ref-via-interface]

Parameters:

cluster - The EKS cluster to fetch attributes from. This parameter is required.

Returns:

this

jsonPath

@Stability(Stable)
public KubernetesObjectValue.Builder jsonPath(String jsonPath)

JSONPath to the specific value.

Parameters:

jsonPath - JSONPath to the specific value. This parameter is required.

Returns:

this

See Also:

• https://kubernetes.io/docs/reference/kubectl/jsonpath/

objectName

@Stability(Stable)
public KubernetesObjectValue.Builder objectName(String objectName)

The name of the object to query.

Parameters:

objectName - The name of the object to query. This parameter is required.

Returns:

this

objectType

@Stability(Stable)
public KubernetesObjectValue.Builder objectType(String objectType)

The object type to query.

(e.g 'service', 'pod'...)

Parameters:

objectType - The object type to query. This parameter is required.

Returns:

this

objectNamespace

@Stability(Stable)
public KubernetesObjectValue.Builder objectNamespace(String objectNamespace)

The namespace the object belongs to.

Default: 'default'

Parameters:

objectNamespace - The namespace the object belongs to. This parameter is required.

Returns:

this

timeout

@Stability(Stable)
public KubernetesObjectValue.Builder timeout(Duration timeout)

Timeout for waiting on a value.

Default: Duration.minutes(5)

Parameters:

timeout - Timeout for waiting on a value. This parameter is required.

Returns:

this

build

@Stability(Stable)
public KubernetesObjectValue build()

Specified by:

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

Returns:

a newly built instance of KubernetesObjectValue.