Package org.cdk8s.plus24.k8s

Class ServicePort.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<ServicePort>
    Enclosing interface:
    ServicePort
    @Stability(Stable)
public static final class ServicePort.Builder
extends Object
implements software.amazon.jsii.Builder<ServicePort>
    A builder for ServicePort

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • appProtocol

        @Stability(Stable)
public ServicePort.Builder appProtocol​(String appProtocol)
        Sets the value of ServicePort.getAppProtocol()
        Parameters:
        appProtocol - The application protocol for this port. This field follows standard Kubernetes label syntax. Un-prefixed names are reserved for IANA standard service names (as per RFC-6335 and https://www.iana.org/assignments/service-names). Non-standard protocols should use prefixed names such as mycompany.com/my-custom-protocol.
        Returns:
        this

      • name

        @Stability(Stable)
public ServicePort.Builder name​(String name)
        Sets the value of ServicePort.getName()
        Parameters:
        name - The name of this port within the service. This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. When considering the endpoints for a Service, this must match the 'name' field in the EndpointPort. Optional if only one ServicePort is defined on this service.
        Returns:
        this

      • nodePort

        @Stability(Stable)
public ServicePort.Builder nodePort​(Number nodePort)
        Sets the value of ServicePort.getNodePort()
        Parameters:
        nodePort - The port on each node on which this service is exposed when type is NodePort or LoadBalancer. Usually assigned by the system. If a value is specified, in-range, and not in use it will be used, otherwise the operation will fail. If not specified, a port will be allocated if this Service requires one. If this field is specified when creating a Service which does not need it, creation will fail. This field will be wiped when updating a Service to no longer need it (e.g. changing type from NodePort to ClusterIP). More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
        Returns:
        this

      • protocol

        @Stability(Stable)
public ServicePort.Builder protocol​(String protocol)
        Sets the value of ServicePort.getProtocol()
        Parameters:
        protocol - The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". Default is TCP.
        Returns:
        this

      • targetPort

        @Stability(Stable)
public ServicePort.Builder targetPort​(IntOrString targetPort)
        Sets the value of ServicePort.getTargetPort()
        Parameters:
        targetPort - Number or name of the port to access on the pods targeted by the service. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. If this is a string, it will be looked up as a named port in the target Pod's container ports. If this is not specified, the value of the 'port' field is used (an identity map). This field is ignored for services with clusterIP=None, and should be omitted or set equal to the 'port' field. More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service
        Returns:
        this

      • build

        @Stability(Stable)
public ServicePort build()
        Builds the configured instance.
        Specified by:
        build in interface software.amazon.jsii.Builder<ServicePort>
        Returns:
        a new instance of ServicePort
        Throws:
        NullPointerException - if any required attribute was not provided