class KubernetesObjectValue (construct)

Language	Type name
.NET	Amazon.CDK.AWS.EKS.KubernetesObjectValue
Go	github.com/aws/aws-cdk-go/awscdk/v2/awseks#KubernetesObjectValue
Java	software.amazon.awscdk.services.eks.KubernetesObjectValue
Python	aws_cdk.aws_eks.KubernetesObjectValue
TypeScript (source)	aws-cdk-lib » aws_eks » KubernetesObjectValue

Implements IConstruct, IDependable

Represents a value of a specific object deployed in the cluster.

Use this to fetch any information available by the kubectl get command.

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,
  },
})

Initializer

new KubernetesObjectValue(scope: Construct, id: string, props: KubernetesObjectValueProps)

Parameters

• scope Construct
• id string
• props KubernetesObjectValueProps

Construct Props

Name	Type	Description
cluster	ICluster	The EKS cluster to fetch attributes from.
jsonPath	string	JSONPath to the specific value.
objectName	string	The name of the object to query.
objectType	string	The object type to query.
objectNamespace?	string	The namespace the object belongs to.
timeout?	Duration	Timeout for waiting on a value.

---

cluster

Type: ICluster

The EKS cluster to fetch attributes from.

[disable-awslint:ref-via-interface]

---

jsonPath

Type: string

JSONPath to the specific value.

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

---

objectName

Type: string

The name of the object to query.

---

objectType

Type: string

The object type to query.

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

---

objectNamespace?

Type: string (optional, default: 'default')

The namespace the object belongs to.

---

timeout?

Type: Duration (optional, default: Duration.minutes(5))

Timeout for waiting on a value.

Properties

Name	Type	Description
node	Node	The tree node.
value	string	The value as a string token.
static RESOURCE_TYPE	string	The CloudFormation resource type.

---

node

Type: Node

The tree node.

---

value

Type: string

The value as a string token.

---

static RESOURCE_TYPE

Type: string

The CloudFormation resource type.

Methods

Name	Description
toString()	Returns a string representation of this construct.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.