org.cdk8s.plus

Interface ServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ResourceProps

All Known Implementing Classes:

ServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.13.0 (build 385c325)",
           date="2020-10-21T06:58:44.700Z")
 @Stability(value=Experimental)
public interface ServiceProps
extends software.amazon.jsii.JsiiSerializable, ResourceProps

(experimental) Properties for initialization of `Service`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ServiceProps.Builder	builder()
default String	getClusterIp() (experimental) The IP address of the service and is usually assigned randomly by the master.
default List<String>	getExternalIPs() (experimental) A list of IP addresses for which nodes in the cluster will also accept traffic for this service.
default List<ServicePort>	getPorts() (experimental) The port exposed by this service.
default ServiceType	getType() (experimental) Determines how the Service is exposed.

Methods inherited from interface org.cdk8s.plus.ResourceProps

getMetadata

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClusterIp

@Stability(value=Experimental)
 @Nullable
default String getClusterIp()

(experimental) The IP address of the service and is usually assigned randomly by the master.

If an address is specified manually and is not in use by others, it will be allocated to the service; otherwise, creation of the service will fail. This field can not be changed through updates. Valid values are "None", empty string (""), or a valid IP address. "None" can be specified for headless services when proxying is not required. Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if type is ExternalName.

Default: - Automatically assigned.

See Also:

https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

getExternalIPs

@Stability(value=Experimental)
 @Nullable
default List<String> getExternalIPs()

(experimental) A list of IP addresses for which nodes in the cluster will also accept traffic for this service.

These IPs are not managed by Kubernetes. The user is responsible for ensuring that traffic arrives at a node with this IP. A common example is external load-balancers that are not part of the Kubernetes system.

Default: - No external IPs.

getPorts

@Stability(value=Experimental)
 @Nullable
default List<ServicePort> getPorts()

(experimental) The port exposed by this service.

More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies

getType

@Stability(value=Experimental)
 @Nullable
default ServiceType getType()

(experimental) Determines how the Service is exposed.

More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types

Default: ServiceType.ClusterIP

builder

@Stability(value=Experimental)
static ServiceProps.Builder builder()

Specified by:

builder in interface ResourceProps

Returns:

a ServiceProps.Builder of ServiceProps