aws-cdk-lib.aws_eks.KubernetesObjectValueProps

KubernetesObjectValueProps Struct

Properties for KubernetesObjectValue.

Source

aws-eks/lib/k8s-object-value.ts

Type last changed

v2.238.0 · 9 Feb 2026

Example

declare const cluster: eks.Cluster;
// query the load balancer address
const myServiceAddress = new eks.KubernetesObjectValue(this, 'LoadBalancerAttribute', {
  cluster: cluster,
  objectType: 'service',
  objectName: 'my-service',
  jsonPath: '.status.loadBalancer.ingress[0].hostname', // https://kubernetes.io/docs/reference/kubectl/jsonpath/
});

// pass the address to a lambda function
const proxyFunction = new lambda.Function(this, 'ProxyFunction', {
  handler: 'index.handler',
  code: lambda.Code.fromInline('my-code'),
  runtime: lambda.Runtime.NODEJS_LATEST,
  environment: {
    myServiceAddress: myServiceAddress.value,
  },
})

Properties

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#

The EKS cluster to fetch attributes from.

[disable-awslint:ref-via-interface]

jsonPathstringjson_pathstrjsonPathStringJsonPathstringJsonPath*stringrequired#

JSONPath to the specific value.

objectNamestringobject_namestrobjectNameStringObjectNamestringObjectName*stringrequired#

The name of the object to query.

objectNamespacestringobject_namespacestrobjectNamespaceStringObjectNamespacestringObjectNamespace*string= 'default'#

The namespace the object belongs to.

objectTypestringobject_typestrobjectTypeStringObjectTypestringObjectType*stringrequired#

The object type to query.

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

removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.DESTROY#

The removal policy applied to the custom resource that manages the Kubernetes object value.

notes

The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:

• The resource is removed from the template, so CloudFormation stops managing it
• A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it
• The stack is deleted, so CloudFormation stops managing all resources in it

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Duration.minutes(5)#

Timeout for waiting on a value.

Used as props by

• KubernetesObjectValue