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

Description

Documentation

data EksPodProperties Source #

The properties for the pod.

See: newEksPodProperties smart constructor.

Constructors

EksPodProperties'

Fields

containers :: Maybe [EksContainer]
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. 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.
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 that uses Amazon EKS resources.

Instances

Instances details

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

newEksPodProperties :: EksPodProperties Source #

Create a value of EksPodProperties 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:EksPodProperties', eksPodProperties_containers - The properties of the container that's used on the Amazon EKS pod.

$sel:dnsPolicy:EksPodProperties', eksPodProperties_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. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

$sel:hostNetwork:EksPodProperties', eksPodProperties_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:serviceAccountName:EksPodProperties', eksPodProperties_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:EksPodProperties', eksPodProperties_volumes - Specifies the volumes for a job definition that uses Amazon EKS resources.

eksPodProperties_containers :: Lens' EksPodProperties (Maybe [EksContainer]) Source #

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

eksPodProperties_dnsPolicy :: Lens' EksPodProperties (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. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

eksPodProperties_hostNetwork :: Lens' EksPodProperties (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.

eksPodProperties_serviceAccountName :: Lens' EksPodProperties (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.

eksPodProperties_volumes :: Lens' EksPodProperties (Maybe [EksVolume]) Source #

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