software.amazon.awscdk.services.eks

Interface KubernetesObjectValueProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

KubernetesObjectValueProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.954Z")
 @Stability(value=Stable)
public interface KubernetesObjectValueProps
extends software.amazon.jsii.JsiiSerializable

Properties for KubernetesObjectValue.

Example:

 Cluster cluster;
 // query the load balancer address
 KubernetesObjectValue myServiceAddress = KubernetesObjectValue.Builder.create(this, "LoadBalancerAttribute")
         .cluster(cluster)
         .objectType("service")
         .objectName("my-service")
         .jsonPath(".status.loadBalancer.ingress[0].hostname")
         .build();
 // pass the address to a lambda function
 Function proxyFunction = Function.Builder.create(this, "ProxyFunction")
         .handler("index.handler")
         .code(Code.fromInline("my-code"))
         .runtime(Runtime.NODEJS_14_X)
         .environment(Map.of(
                 "myServiceAddress", myServiceAddress.getValue()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	KubernetesObjectValueProps.Builder A builder for KubernetesObjectValueProps
static class	KubernetesObjectValueProps.Jsii$Proxy An implementation for KubernetesObjectValueProps

Method Summary

Modifier and Type	Method and Description
static KubernetesObjectValueProps.Builder	builder()
ICluster	getCluster() The EKS cluster to fetch attributes from.
String	getJsonPath() JSONPath to the specific value.
String	getObjectName() The name of the object to query.
default String	getObjectNamespace() The namespace the object belongs to.
String	getObjectType() The object type to query.
default Duration	getTimeout() Timeout for waiting on a value.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCluster

@Stability(value=Stable)
 @NotNull
ICluster getCluster()

The EKS cluster to fetch attributes from.

[disable-awslint:ref-via-interface]

getJsonPath

@Stability(value=Stable)
 @NotNull
String getJsonPath()

JSONPath to the specific value.

See Also:

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

getObjectName

@Stability(value=Stable)
 @NotNull
String getObjectName()

The name of the object to query.

getObjectType

@Stability(value=Stable)
 @NotNull
String getObjectType()

The object type to query.

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

getObjectNamespace

@Stability(value=Stable)
 @Nullable
default String getObjectNamespace()

The namespace the object belongs to.

Default: 'default'

getTimeout

@Stability(value=Stable)
 @Nullable
default Duration getTimeout()

Timeout for waiting on a value.

Default: Duration.minutes(5)

builder

@Stability(value=Stable)
static KubernetesObjectValueProps.Builder builder()

Returns:

a KubernetesObjectValueProps.Builder of KubernetesObjectValueProps