Specification

EKS Auto Mode users

If you are using EKS Auto Mode, please see the EKS Auto Mode documentation for key differences between the load balancing capability of EKS Auto Mode and the open source load balancer controller.

Packages:

elbv2.k8s.aws/v1beta1

Package v1beta1 contains API Schema definitions for the elbv2 v1beta1 API group

Resource Types:

TargetGroupBinding

TargetGroupBinding is the Schema for the TargetGroupBinding API

Field Description
apiVersion
string		 elbv2.k8s.aws/v1beta1
kind
string 		TargetGroupBinding
metadata
Kubernetes meta/v1.ObjectMeta
annotations
Refer to the Kubernetes API documentation for the other fields of the metadata field.
spec
TargetGroupBindingSpec

targetGroupARN
string

targetGroupARN is the Amazon Resource Name (ARN) for the TargetGroup.
targetType
TargetType 		(Optional)

targetType is the TargetType of TargetGroup. If unspecified, it will be automatically inferred.
serviceRef
ServiceReference

serviceRef is a reference to a Kubernetes Service and ServicePort.
networking
TargetGroupBindingNetworking 		(Optional)

networking defines the networking rules to allow ELBV2 LoadBalancer to access targets in TargetGroup.
status
TargetGroupBindingStatus

IPBlock

(Appears on: NetworkingPeer)

IPBlock defines source/destination IPBlock in networking rules.

Field Description
cidr
string

CIDR is the network CIDR. Both IPV4 or IPV6 CIDR are accepted.

NetworkingIngressRule

(Appears on: TargetGroupBindingNetworking)

NetworkingIngressRule defines a particular set of traffic that is allowed to access TargetGroup’s targets.

Field Description
from
[]NetworkingPeer

List of peers which should be able to access the targets in TargetGroup. At least one NetworkingPeer should be specified.
ports
[]NetworkingPort

List of ports which should be made accessible on the targets in TargetGroup. If ports is empty or unspecified, it defaults to all ports with TCP.

NetworkingPeer

(Appears on: NetworkingIngressRule)

NetworkingPeer defines the source/destination peer for networking rules.

Field Description
ipBlock
IPBlock 		(Optional)

IPBlock defines an IPBlock peer. If specified, none of the other fields can be set.
securityGroup
SecurityGroup 		(Optional)

SecurityGroup defines a SecurityGroup peer. If specified, none of the other fields can be set.

NetworkingPort

(Appears on: NetworkingIngressRule)

NetworkingPort defines the port and protocol for networking rules.

Field Description
protocol
NetworkingProtocol

The protocol which traffic must match. If protocol is unspecified, it defaults to TCP.
port
k8s.io/apimachinery/pkg/util/intstr.IntOrString 		(Optional)

The port which traffic must match. When NodePort endpoints(instance TargetType) is used, this must be a numerical port. When Port endpoints(ip TargetType) is used, this can be either numerical or named port on pods. if port is unspecified, it defaults to all ports.

NetworkingProtocol (string alias)

(Appears on: NetworkingPort)

NetworkingProtocol defines the protocol for networking rules.

SecurityGroup

(Appears on: NetworkingPeer)

SecurityGroup defines reference to an AWS EC2 SecurityGroup.

Field Description
groupID
string

GroupID is the EC2 SecurityGroupID.

ServiceReference

(Appears on: TargetGroupBindingSpec)

ServiceReference defines reference to a Kubernetes Service and its ServicePort.

Field Description
name
string

Name is the name of the Service.
port
k8s.io/apimachinery/pkg/util/intstr.IntOrString

Port is the port of the ServicePort.

TargetGroupBindingNetworking

(Appears on: TargetGroupBindingSpec)

TargetGroupBindingNetworking defines the networking rules to allow ELBV2 LoadBalancer to access targets in TargetGroup.

Field Description
ingress
[]NetworkingIngressRule 		(Optional)

List of ingress rules to allow ELBV2 LoadBalancer to access targets in TargetGroup.

TargetGroupBindingSpec

(Appears on: TargetGroupBinding)

TargetGroupBindingSpec defines the desired state of TargetGroupBinding

Field Description
targetGroupARN
string

targetGroupARN is the Amazon Resource Name (ARN) for the TargetGroup.
targetType
TargetType 		(Optional)

targetType is the TargetType of TargetGroup. If unspecified, it will be automatically inferred.
serviceRef
ServiceReference

serviceRef is a reference to a Kubernetes Service and ServicePort.
networking
TargetGroupBindingNetworking 		(Optional)

networking defines the networking rules to allow ELBV2 LoadBalancer to access targets in TargetGroup.

TargetGroupBindingStatus

(Appears on: TargetGroupBinding)

TargetGroupBindingStatus defines the observed state of TargetGroupBinding

Field Description
observedGeneration
int64 		(Optional)

The generation observed by the TargetGroupBinding controller.

TargetType (string alias)

(Appears on: TargetGroupBindingSpec)

TargetType is the targetType of your ELBV2 TargetGroup.

  • with instance TargetType, nodes with nodePort for your service will be registered as targets
  • with ip TargetType, Pods with containerPort for your service will be registered as targets

Generated with gen-crd-api-reference-docs on git commit 21418f44.