KubernetesObjectValueProps¶

class aws_cdk.aws_eks.KubernetesObjectValueProps(*, cluster, json_path, object_name, object_type, object_namespace=None, timeout=None)¶

Bases: object

Properties for KubernetesObjectValue.

Parameters

cluster (ICluster) – The EKS cluster to fetch attributes from. [disable-awslint:ref-via-interface]
json_path (str) – JSONPath to the specific value.
object_name (str) – The name of the object to query.
object_type (str) – The object type to query. (e.g ‘service’, ‘pod’…)
object_namespace (Optional[str]) – The namespace the object belongs to. Default: ‘default’
timeout (Optional[Duration]) – Timeout for waiting on a value. Default: Duration.minutes(5)

ExampleMetadata

infused

Example:

# cluster is of type Cluster

# query the load balancer address
my_service_address = eks.KubernetesObjectValue(self, "LoadBalancerAttribute",
    cluster=cluster,
    object_type="service",
    object_name="my-service",
    json_path=".status.loadBalancer.ingress[0].hostname"
)

# pass the address to a lambda function
proxy_function = lambda_.Function(self, "ProxyFunction",
    handler="index.handler",
    code=lambda_.Code.from_inline("my-code"),
    runtime=lambda_.Runtime.NODEJS_14_X,
    environment={
        "my_service_address": my_service_address.value
    }
)

Attributes

cluster¶

The EKS cluster to fetch attributes from.

[disable-awslint:ref-via-interface]

Return type: ICluster

json_path¶

JSONPath to the specific value.

See: https://kubernetes.io/docs/reference/kubectl/jsonpath/
Return type: str

object_name¶

The name of the object to query.

Return type: str

object_namespace¶

The namespace the object belongs to.

Default: ‘default’
Return type: Optional[str]

object_type¶

The object type to query.

(e.g ‘service’, ‘pod’…)

Return type: str

timeout¶

Timeout for waiting on a value.

Default: Duration.minutes(5)
Return type: Optional[Duration]