org.cdk8s.plus20

Interface ServicePortOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AddDeploymentOptions, ServicePort

All Known Implementing Classes:

AddDeploymentOptions.Jsii$Proxy, ServicePort.Jsii$Proxy, ServicePortOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.41.0 (build a274beb)",
           date="2021-10-30T01:04:46.510Z")
 @Stability(value=Stable)
public interface ServicePortOptions
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ServicePortOptions.Builder A builder for ServicePortOptions
static class	ServicePortOptions.Jsii$Proxy An implementation for ServicePortOptions

Method Summary

Modifier and Type	Method and Description
static ServicePortOptions.Builder	builder()
default String	getName() The name of this port within the service.
default Number	getNodePort() The port on each node on which this service is exposed when type=NodePort or LoadBalancer.
default Protocol	getProtocol() The IP protocol for this port.
default Number	getTargetPort() The port number the service will redirect to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @Nullable
default String getName()

The name of this port within the service.

This must be a DNS_LABEL. All ports within a ServiceSpec must have unique names. This maps to the 'Name' field in EndpointPort objects. Optional if only one ServicePort is defined on this service.

getNodePort

@Stability(value=Stable)
 @Nullable
default Number getNodePort()

The port on each node on which this service is exposed when type=NodePort or LoadBalancer.

Usually assigned by the system. If specified, it will be allocated to the service if unused or else creation of the service will fail. Default is to auto-allocate a port if the ServiceType of this Service requires one.

Default: - auto-allocate a port if the ServiceType of this Service requires one.

See Also:

https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport

getProtocol

@Stability(value=Stable)
 @Nullable
default Protocol getProtocol()

The IP protocol for this port.

Supports "TCP", "UDP", and "SCTP". Default is TCP.

Default: Protocol.TCP

getTargetPort

@Stability(value=Stable)
 @Nullable
default Number getTargetPort()

The port number the service will redirect to.

Default: - The value of `port` will be used.

builder

@Stability(value=Stable)
static ServicePortOptions.Builder builder()

Returns:

a ServicePortOptions.Builder of ServicePortOptions