Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Batch.Types.EksPodPropertiesDetail

Description

Synopsis

data EksPodPropertiesDetail = EksPodPropertiesDetail' {
- containers :: Maybe [EksContainerDetail]
- dnsPolicy :: Maybe Text
- hostNetwork :: Maybe Bool
- nodeName :: Maybe Text
- podName :: Maybe Text
- serviceAccountName :: Maybe Text
- volumes :: Maybe [EksVolume]
}
newEksPodPropertiesDetail :: EksPodPropertiesDetail
eksPodPropertiesDetail_containers :: Lens' EksPodPropertiesDetail (Maybe [EksContainerDetail])
eksPodPropertiesDetail_dnsPolicy :: Lens' EksPodPropertiesDetail (Maybe Text)
eksPodPropertiesDetail_hostNetwork :: Lens' EksPodPropertiesDetail (Maybe Bool)
eksPodPropertiesDetail_nodeName :: Lens' EksPodPropertiesDetail (Maybe Text)
eksPodPropertiesDetail_podName :: Lens' EksPodPropertiesDetail (Maybe Text)
eksPodPropertiesDetail_serviceAccountName :: Lens' EksPodPropertiesDetail (Maybe Text)
eksPodPropertiesDetail_volumes :: Lens' EksPodPropertiesDetail (Maybe [EksVolume])

Documentation

data EksPodPropertiesDetail Source #

The details for the pod.

See: newEksPodPropertiesDetail smart constructor.

Constructors

EksPodPropertiesDetail'

Fields

containers :: Maybe [EksContainerDetail]
The properties of the container that's used on the Amazon EKS pod.
dnsPolicy :: Maybe Text
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. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The pod spec setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending on the value of the hostNetwork parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst | ClusterFirstWithHostNet
hostNetwork :: Maybe 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.
nodeName :: Maybe Text
The name of the node for this job.
podName :: Maybe Text
The name of the pod for this job.
serviceAccountName :: Maybe Text
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.
volumes :: Maybe [EksVolume]
Specifies the volumes for a job definition using Amazon EKS resources.

Instances

Instances details

FromJSON EksPodPropertiesDetail Source #
Instance details Defined in Amazonka.Batch.Types.EksPodPropertiesDetail Methods parseJSON :: Value -> Parser EksPodPropertiesDetail # parseJSONList :: Value -> Parser [EksPodPropertiesDetail] #
Generic EksPodPropertiesDetail Source #
Instance details Defined in Amazonka.Batch.Types.EksPodPropertiesDetail Associated Types type Rep EksPodPropertiesDetail :: Type -> Type # Methods from :: EksPodPropertiesDetail -> Rep EksPodPropertiesDetail x # to :: Rep EksPodPropertiesDetail x -> EksPodPropertiesDetail #
Read EksPodPropertiesDetail Source #
Instance details Defined in Amazonka.Batch.Types.EksPodPropertiesDetail Methods readsPrec :: Int -> ReadS EksPodPropertiesDetail # readList :: ReadS [EksPodPropertiesDetail] # readPrec :: ReadPrec EksPodPropertiesDetail # readListPrec :: ReadPrec [EksPodPropertiesDetail] #
Show EksPodPropertiesDetail Source #
Instance details Defined in Amazonka.Batch.Types.EksPodPropertiesDetail Methods showsPrec :: Int -> EksPodPropertiesDetail -> ShowS # show :: EksPodPropertiesDetail -> String # showList :: [EksPodPropertiesDetail] -> ShowS #
NFData EksPodPropertiesDetail Source #
Instance details Defined in Amazonka.Batch.Types.EksPodPropertiesDetail Methods rnf :: EksPodPropertiesDetail -> () #
Eq EksPodPropertiesDetail Source #
Instance details Defined in Amazonka.Batch.Types.EksPodPropertiesDetail Methods (==) :: EksPodPropertiesDetail -> EksPodPropertiesDetail -> Bool # (/=) :: EksPodPropertiesDetail -> EksPodPropertiesDetail -> Bool #
Hashable EksPodPropertiesDetail Source #
Instance details Defined in Amazonka.Batch.Types.EksPodPropertiesDetail Methods hashWithSalt :: Int -> EksPodPropertiesDetail -> Int # hash :: EksPodPropertiesDetail -> Int #
type Rep EksPodPropertiesDetail Source #
Instance details Defined in Amazonka.Batch.Types.EksPodPropertiesDetail type Rep EksPodPropertiesDetail = D1 ('MetaData "EksPodPropertiesDetail" "Amazonka.Batch.Types.EksPodPropertiesDetail" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "EksPodPropertiesDetail'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "containers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksContainerDetail])) :: (S1 ('MetaSel ('Just "dnsPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "hostNetwork") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "nodeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "podName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "serviceAccountName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "volumes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EksVolume]))))))

newEksPodPropertiesDetail :: EksPodPropertiesDetail Source #

Create a value of EksPodPropertiesDetail with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containers:EksPodPropertiesDetail', eksPodPropertiesDetail_containers - The properties of the container that's used on the Amazon EKS pod.

$sel:dnsPolicy:EksPodPropertiesDetail', eksPodPropertiesDetail_dnsPolicy - 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. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The pod spec setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending on the value of the hostNetwork parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

$sel:hostNetwork:EksPodPropertiesDetail', eksPodPropertiesDetail_hostNetwork - 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.

$sel:nodeName:EksPodPropertiesDetail', eksPodPropertiesDetail_nodeName - The name of the node for this job.

$sel:podName:EksPodPropertiesDetail', eksPodPropertiesDetail_podName - The name of the pod for this job.

$sel:serviceAccountName:EksPodPropertiesDetail', eksPodPropertiesDetail_serviceAccountName - 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.

$sel:volumes:EksPodPropertiesDetail', eksPodPropertiesDetail_volumes - Specifies the volumes for a job definition using Amazon EKS resources.

eksPodPropertiesDetail_containers :: Lens' EksPodPropertiesDetail (Maybe [EksContainerDetail]) Source #

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

eksPodPropertiesDetail_dnsPolicy :: Lens' EksPodPropertiesDetail (Maybe Text) Source #

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. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The pod spec setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending on the value of the hostNetwork parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

eksPodPropertiesDetail_hostNetwork :: Lens' EksPodPropertiesDetail (Maybe Bool) Source #

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.

eksPodPropertiesDetail_nodeName :: Lens' EksPodPropertiesDetail (Maybe Text) Source #

The name of the node for this job.

eksPodPropertiesDetail_podName :: Lens' EksPodPropertiesDetail (Maybe Text) Source #

The name of the pod for this job.

eksPodPropertiesDetail_serviceAccountName :: Lens' EksPodPropertiesDetail (Maybe Text) Source #

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.

eksPodPropertiesDetail_volumes :: Lens' EksPodPropertiesDetail (Maybe [EksVolume]) Source #

Specifies the volumes for a job definition using Amazon EKS resources.