Struct EksPodProperties

#[non_exhaustive]
pub struct EksPodProperties {
    pub service_account_name: Option<String>,
    pub host_network: Option<bool>,
    pub dns_policy: Option<String>,
    pub image_pull_secrets: Option<Vec<ImagePullSecret>>,
    pub containers: Option<Vec<EksContainer>>,
    pub init_containers: Option<Vec<EksContainer>>,
    pub volumes: Option<Vec<EksVolume>>,
    pub metadata: Option<EksMetadata>,
    pub share_process_namespace: Option<bool>,
}

The properties for the pod.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

service_account_name: Option<String>

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.

host_network: Option<bool>

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 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.

dns_policy: Option<String>

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

image_pull_secrets: Option<Vec<ImagePullSecret>>

References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain access to pull an images from a private registry.

ImagePullSecret$name is required when this object is used.

containers: Option<Vec<EksContainer>>

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

This object is limited to 10 elements.

init_containers: Option<Vec<EksContainer>>

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.

volumes: Option<Vec<EksVolume>>

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

metadata: Option<EksMetadata>

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

share_process_namespace: Option<bool>

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.

Implementations

impl EksPodProperties

pub fn service_account_name(&self) -> Option<&str>

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.

pub fn host_network(&self) -> Option<bool>

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 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.

pub fn dns_policy(&self) -> Option<&str>

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

pub fn image_pull_secrets(&self) -> &[ImagePullSecret]

References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain access to pull an images from a private registry.

ImagePullSecret$name is required when this object is used.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .image_pull_secrets.is_none().

pub fn containers(&self) -> &[EksContainer]

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

This object is limited to 10 elements.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .containers.is_none().

pub fn init_containers(&self) -> &[EksContainer]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .init_containers.is_none().

pub fn volumes(&self) -> &[EksVolume]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .volumes.is_none().

pub fn metadata(&self) -> Option<&EksMetadata>

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

pub fn share_process_namespace(&self) -> Option<bool>

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.

impl EksPodProperties

pub fn builder() -> EksPodPropertiesBuilder

Creates a new builder-style object to manufacture EksPodProperties.

Trait Implementations

impl Clone for EksPodProperties

fn clone(&self) -> EksPodProperties

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EksPodProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for EksPodProperties

fn eq(&self, other: &EksPodProperties) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EksPodProperties