Package software.amazon.awscdk.services.batch

Interface CfnJobDefinition.PodPropertiesProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJobDefinition.PodPropertiesProperty.Jsii$Proxy

Enclosing class:

CfnJobDefinition

@Stability(Stable)
public static interface CfnJobDefinition.PodPropertiesProperty
extends software.amazon.jsii.JsiiSerializable

The properties for the pod.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 Object labels;
 Object limits;
 Object requests;
 PodPropertiesProperty podPropertiesProperty = PodPropertiesProperty.builder()
         .containers(List.of(EksContainerProperty.builder()
                 .image("image")
                 // the properties below are optional
                 .args(List.of("args"))
                 .command(List.of("command"))
                 .env(List.of(EksContainerEnvironmentVariableProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .value("value")
                         .build()))
                 .imagePullPolicy("imagePullPolicy")
                 .name("name")
                 .resources(ResourcesProperty.builder()
                         .limits(limits)
                         .requests(requests)
                         .build())
                 .securityContext(SecurityContextProperty.builder()
                         .allowPrivilegeEscalation(false)
                         .privileged(false)
                         .readOnlyRootFilesystem(false)
                         .runAsGroup(123)
                         .runAsNonRoot(false)
                         .runAsUser(123)
                         .build())
                 .volumeMounts(List.of(EksContainerVolumeMountProperty.builder()
                         .mountPath("mountPath")
                         .name("name")
                         .readOnly(false)
                         .build()))
                 .build()))
         .dnsPolicy("dnsPolicy")
         .hostNetwork(false)
         .imagePullSecrets(List.of(ImagePullSecretProperty.builder()
                 .name("name")
                 .build()))
         .initContainers(List.of(EksContainerProperty.builder()
                 .image("image")
                 // the properties below are optional
                 .args(List.of("args"))
                 .command(List.of("command"))
                 .env(List.of(EksContainerEnvironmentVariableProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .value("value")
                         .build()))
                 .imagePullPolicy("imagePullPolicy")
                 .name("name")
                 .resources(ResourcesProperty.builder()
                         .limits(limits)
                         .requests(requests)
                         .build())
                 .securityContext(SecurityContextProperty.builder()
                         .allowPrivilegeEscalation(false)
                         .privileged(false)
                         .readOnlyRootFilesystem(false)
                         .runAsGroup(123)
                         .runAsNonRoot(false)
                         .runAsUser(123)
                         .build())
                 .volumeMounts(List.of(EksContainerVolumeMountProperty.builder()
                         .mountPath("mountPath")
                         .name("name")
                         .readOnly(false)
                         .build()))
                 .build()))
         .metadata(MetadataProperty.builder()
                 .labels(labels)
                 .build())
         .serviceAccountName("serviceAccountName")
         .shareProcessNamespace(false)
         .volumes(List.of(EksVolumeProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .emptyDir(EmptyDirProperty.builder()
                         .medium("medium")
                         .sizeLimit("sizeLimit")
                         .build())
                 .hostPath(HostPathProperty.builder()
                         .path("path")
                         .build())
                 .secret(EksSecretProperty.builder()
                         .secretName("secretName")
                         // the properties below are optional
                         .optional(false)
                         .build())
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJobDefinition.PodPropertiesProperty.Builder	builder()
default Object	getContainers()	The properties of the container that's used on the Amazon EKS pod.
default String	getDnsPolicy()	The DNS policy for the pod.
default Object	getHostNetwork()	Indicates if the pod uses the hosts' network IP address.
default Object	getImagePullSecrets()
default Object	getInitContainers()	These containers run before application containers, always runs to completion, and must complete successfully before the next container starts.
default Object	getMetadata()	Metadata about the Kubernetes pod.
default String	getServiceAccountName()	The name of the service account that's used to run the pod.
default Object	getShareProcessNamespace()	Indicates if the processes in a container are shared, or visible, to other containers in the same pod.
default Object	getVolumes()	Specifies the volumes for a job definition that uses Amazon EKS resources.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContainers

@Stability(Stable)
@Nullable
default Object getContainers()

The properties of the container that's used on the Amazon EKS pod.

This object is limited to 10 elements.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-containers

getDnsPolicy

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

The DNS policy for the pod.

The default value is ClusterFirst . If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet . ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation .

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-dnspolicy

getHostNetwork

@Stability(Stable)
@Nullable
default Object getHostNetwork()

Indicates if the pod uses the hosts' network IP address.

The default value is true . Setting this to false enables the Kubernetes pod networking model. Most AWS Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-hostnetwork

getImagePullSecrets

@Stability(Stable)
@Nullable
default Object getImagePullSecrets()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-imagepullsecrets

getInitContainers

@Stability(Stable)
@Nullable
default Object getInitContainers()

These containers run before application containers, always runs to completion, and must complete successfully before the next container starts.

These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init Containers in the Kubernetes documentation .

This object is limited to 10 elements.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-initcontainers

getMetadata

@Stability(Stable)
@Nullable
default Object getMetadata()

Metadata about the Kubernetes pod.

For more information, see Understanding Kubernetes Objects in the Kubernetes documentation .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-metadata

getServiceAccountName

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

The name of the service account that's used to run the pod.

For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-serviceaccountname

getShareProcessNamespace

@Stability(Stable)
@Nullable
default Object getShareProcessNamespace()

Indicates if the processes in a container are shared, or visible, to other containers in the same pod.

For more information, see Share Process Namespace between Containers in a Pod .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-shareprocessnamespace

getVolumes

@Stability(Stable)
@Nullable
default Object getVolumes()

Specifies the volumes for a job definition that uses Amazon EKS resources.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-podproperties.html#cfn-batch-jobdefinition-podproperties-volumes

builder

@Stability(Stable)
static CfnJobDefinition.PodPropertiesProperty.Builder builder()

Returns:

a CfnJobDefinition.PodPropertiesProperty.Builder of CfnJobDefinition.PodPropertiesProperty