Package org.cdk8s.plus20

Interface ServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ResourceProps

All Known Implementing Classes:

ServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.52.1 (build 5ccc8f6)",
           date="2022-01-14T19:05:22.155Z")
@Stability(Stable)
public interface ServiceProps
extends software.amazon.jsii.JsiiSerializable, ResourceProps

Properties for initialization of `Service`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ServiceProps.Builder	builder()
default String	getClusterIP()	The IP address of the service and is usually assigned randomly by the master.
default List<String>	getExternalIPs()	A list of IP addresses for which nodes in the cluster will also accept traffic for this service.
default String	getExternalName()	The externalName to be used when ServiceType.EXTERNAL_NAME is set.
default List<String>	getLoadBalancerSourceRanges()	A list of CIDR IP addresses, if specified and supported by the platform, will restrict traffic through the cloud-provider load-balancer to the specified client IPs.
default List<ServicePort>	getPorts()	The port exposed by this service.
default ServiceType	getType()	Determines how the Service is exposed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface org.cdk8s.plus20.ResourceProps

getMetadata

Method Detail

getClusterIP

@Stability(Stable)
@Nullable
default String getClusterIP()

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.

getExternalIPs

@Stability(Stable)
@Nullable
default List<String> getExternalIPs()

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.

getExternalName

@Stability(Stable)
@Nullable
default String getExternalName()

The externalName to be used when ServiceType.EXTERNAL_NAME is set.

Default: - No external name.

getLoadBalancerSourceRanges

@Stability(Stable)
@Nullable
default List<String> getLoadBalancerSourceRanges()

A list of CIDR IP addresses, if specified and supported by the platform, will restrict traffic through the cloud-provider load-balancer to the specified client IPs.

More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/

getPorts

@Stability(Stable)
@Nullable
default List<ServicePort> getPorts()

The port exposed by this service.

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

getType

@Stability(Stable)
@Nullable
default ServiceType getType()

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(Stable)
static ServiceProps.Builder builder()

Returns:

a ServiceProps.Builder of ServiceProps