Package org.cdk8s.plus20

Class Pod

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

org.cdk8s.plus20.Resource

org.cdk8s.plus20.Pod

All Implemented Interfaces:

IPodSpec, IResource, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-26T09:02:10.529Z")
@Stability(Stable)
public class Pod
extends Resource
implements IPodSpec

Pod is a collection of containers that can run on a host.

This resource is created by clients and scheduled onto hosts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Pod.Builder	A fluent builder for Pod.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface org.cdk8s.plus20.IPodSpec

IPodSpec.Jsii$Default, IPodSpec.Jsii$Proxy

Nested classes/interfaces inherited from interface org.cdk8s.plus20.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Pod(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Pod(software.amazon.jsii.JsiiObjectRef objRef)
	Pod(software.constructs.Construct scope, String id)
	Pod(software.constructs.Construct scope, String id, PodProps props)

Method Summary

Modifier and Type	Method	Description
Container	addContainer(ContainerProps cont)	Add a container to the pod.
void	addHostAlias(HostAlias hostAlias)
Container	addInitContainer(ContainerProps cont)	Add an init container to the pod.
void	addVolume(Volume vol)	Add a volume to the pod.
protected org.cdk8s.ApiObject	getApiObject()	The underlying cdk8s API object.
List<Container>	getContainers()	The containers belonging to the pod.
PodDns	getDns()	The pod's DNS settings.
List<HostAlias>	getHostAliases()	An optional list of hosts and IPs that will be injected into the pod's hosts file if specified.
List<Container>	getInitContainers()	The init containers belonging to the pod.
RestartPolicy	getRestartPolicy()	Restart policy for all containers within the pod.
PodSecurityContext	getSecurityContext()	The pod's security context.
IServiceAccount	getServiceAccount()	The service account used to run this pod.
List<Volume>	getVolumes()	The volumes associated with this pod.

Methods inherited from class org.cdk8s.plus20.Resource

getMetadata, getName

Methods inherited from class software.constructs.Construct

onPrepare, onSynthesize, onValidate, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Pod

protected Pod(software.amazon.jsii.JsiiObjectRef objRef)

Pod

protected Pod(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Pod

@Stability(Stable)
public Pod(@NotNull
           software.constructs.Construct scope,
           @NotNull
           String id,
           @Nullable
           PodProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

Pod

@Stability(Stable)
public Pod(@NotNull
           software.constructs.Construct scope,
           @NotNull
           String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Detail

addContainer

@Stability(Stable)
@NotNull
public Container addContainer(@NotNull
                              ContainerProps cont)

Add a container to the pod.

Specified by:

addContainer in interface IPodSpec

Parameters:

cont - This parameter is required.

addHostAlias

@Stability(Stable)
public void addHostAlias(@NotNull
                         HostAlias hostAlias)

Parameters:

hostAlias - This parameter is required.

addInitContainer

@Stability(Stable)
@NotNull
public Container addInitContainer(@NotNull
                                  ContainerProps cont)

Add an init container to the pod.

Specified by:

addInitContainer in interface IPodSpec

Parameters:

cont - This parameter is required.

addVolume

@Stability(Stable)
public void addVolume(@NotNull
                      Volume vol)

Add a volume to the pod.

Specified by:

addVolume in interface IPodSpec

Parameters:

vol - This parameter is required.

getApiObject

@Stability(Stable)
@NotNull
protected org.cdk8s.ApiObject getApiObject()

The underlying cdk8s API object.

Specified by:

getApiObject in class Resource

See Also:

base.Resource.apiObject

getContainers

@Stability(Stable)
@NotNull
public List<Container> getContainers()

The containers belonging to the pod.

Use addContainer to add containers.

Specified by:

getContainers in interface IPodSpec

getDns

@Stability(Stable)
@NotNull
public PodDns getDns()

The pod's DNS settings.

Specified by:

getDns in interface IPodSpec

getHostAliases

@Stability(Stable)
@NotNull
public List<HostAlias> getHostAliases()

An optional list of hosts and IPs that will be injected into the pod's hosts file if specified.

This is only valid for non-hostNetwork pods.

Specified by:

getHostAliases in interface IPodSpec

getInitContainers

@Stability(Stable)
@NotNull
public List<Container> getInitContainers()

The init containers belonging to the pod.

Use addInitContainer to add init containers.

Specified by:

getInitContainers in interface IPodSpec

getSecurityContext

@Stability(Stable)
@NotNull
public PodSecurityContext getSecurityContext()

The pod's security context.

Specified by:

getSecurityContext in interface IPodSpec

getVolumes

@Stability(Stable)
@NotNull
public List<Volume> getVolumes()

The volumes associated with this pod.

Use addVolume to add volumes.

Specified by:

getVolumes in interface IPodSpec

getRestartPolicy

@Stability(Stable)
@Nullable
public RestartPolicy getRestartPolicy()

Restart policy for all containers within the pod.

Specified by:

getRestartPolicy in interface IPodSpec

getServiceAccount

@Stability(Stable)
@Nullable
public IServiceAccount getServiceAccount()

The service account used to run this pod.

Specified by:

getServiceAccount in interface IPodSpec