aws-cdk-lib.aws_eks.KubernetesObjectValueProps

interface KubernetesObjectValueProps

LanguageType name
.NETAmazon.CDK.AWS.EKS.KubernetesObjectValueProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseks#KubernetesObjectValueProps
Javasoftware.amazon.awscdk.services.eks.KubernetesObjectValueProps
Pythonaws_cdk.aws_eks.KubernetesObjectValueProps
TypeScript (source)aws-cdk-lib » aws_eks » KubernetesObjectValueProps

Properties for KubernetesObjectValue.

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_14_X,
  environment: {
    myServiceAddress: myServiceAddress.value,
  },
})

Properties

NameTypeDescription
clusterIClusterThe EKS cluster to fetch attributes from.
jsonPathstringJSONPath to the specific value.
objectNamestringThe name of the object to query.
objectTypestringThe object type to query.
objectNamespace?stringThe namespace the object belongs to.
timeout?DurationTimeout 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.