org.cdk8s.plus20

Interface ExposeOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ExposeOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.34.0 (build 9b72778)",
           date="2021-09-24T22:49:58.409Z")
 @Stability(value=Stable)
public interface ExposeOptions
extends software.amazon.jsii.JsiiSerializable

Options for exposing a deployment via a service.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ExposeOptions.Builder	builder()
default String	getName() The name of the service to expose.
default Protocol	getProtocol() The IP protocol for this port.
default ServiceType	getServiceType() The type of the exposed service.
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 the service to expose.

This will be set on the Service.metadata and must be a DNS_LABEL

Default: undefined Uses the system generated name.

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

getServiceType

@Stability(value=Stable)
 @Nullable
default ServiceType getServiceType()

The type of the exposed service.

Default: - ClusterIP.

getTargetPort

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

The port number the service will redirect to.

Default: - The port of the first container in the deployment (ie. containers[0].port)

builder

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

Returns:

a ExposeOptions.Builder of ExposeOptions