Struct aws_sdk_batch::types::EksPodProperties
source · #[non_exhaustive]pub struct EksPodProperties {
pub service_account_name: Option<String>,
pub host_network: Option<bool>,
pub dns_policy: Option<String>,
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>,
}
Expand description
The properties for the pod.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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
containers: Option<Vec<EksContainer>>
The properties of the container that's used on the Amazon EKS pod.
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.
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§
source§impl EksPodProperties
impl EksPodProperties
sourcepub fn service_account_name(&self) -> Option<&str>
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.
sourcepub fn host_network(&self) -> Option<bool>
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.
sourcepub fn dns_policy(&self) -> Option<&str>
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
sourcepub fn containers(&self) -> &[EksContainer]
pub fn containers(&self) -> &[EksContainer]
The properties of the container that's used on the Amazon EKS pod.
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()
.
sourcepub fn init_containers(&self) -> &[EksContainer]
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()
.
sourcepub fn volumes(&self) -> &[EksVolume]
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()
.
sourcepub fn metadata(&self) -> Option<&EksMetadata>
pub fn metadata(&self) -> Option<&EksMetadata>
Metadata about the Kubernetes pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.
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.
source§impl EksPodProperties
impl EksPodProperties
sourcepub fn builder() -> EksPodPropertiesBuilder
pub fn builder() -> EksPodPropertiesBuilder
Creates a new builder-style object to manufacture EksPodProperties
.
Trait Implementations§
source§impl Clone for EksPodProperties
impl Clone for EksPodProperties
source§fn clone(&self) -> EksPodProperties
fn clone(&self) -> EksPodProperties
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for EksPodProperties
impl Debug for EksPodProperties
source§impl PartialEq for EksPodProperties
impl PartialEq for EksPodProperties
source§fn eq(&self, other: &EksPodProperties) -> bool
fn eq(&self, other: &EksPodProperties) -> bool
self
and other
values to be equal, and is used
by ==
.