Class: Aws::Batch::Types::EksPodProperties

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-batch/types.rb

Overview

The properties for the pod.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#containers ⇒ Array<Types::EksContainer>

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

<note markdown=“1”> This object is limited to 10 elements.

</note>

Returns:



4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
 
# File 'lib/aws-sdk-batch/types.rb', line 4207

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#dns_policy ⇒ 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`

[1]: kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy

Returns:

  • (String) 


4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
 
# File 'lib/aws-sdk-batch/types.rb', line 4207

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#host_network ⇒ Boolean

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

[1]: kubernetes.io/docs/concepts/security/pod-security-policy/#host-namespaces [2]: kubernetes.io/docs/concepts/workloads/pods/#pod-networking

Returns:

  • (Boolean) 


4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
 
# File 'lib/aws-sdk-batch/types.rb', line 4207

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#image_pull_secrets ⇒ Array<Types::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.

Returns:



4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
 
# File 'lib/aws-sdk-batch/types.rb', line 4207

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#init_containers ⇒ Array<Types::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*.

<note markdown=“1”> This object is limited to 10 elements.

</note>

[1]: kubernetes.io/docs/concepts/workloads/pods/init-containers/

Returns:



4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
 
# File 'lib/aws-sdk-batch/types.rb', line 4207

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#metadata ⇒ Types::EksMetadata

Metadata about the Kubernetes pod. For more information, see

Understanding Kubernetes Objects][1

in the *Kubernetes

documentation*.

[1]: kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/

Returns:



4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
 
# File 'lib/aws-sdk-batch/types.rb', line 4207

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#service_account_name ⇒ 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][2

in

the *Amazon EKS User Guide* and [Configure service accounts for pods] in the *Kubernetes documentation*.

[1]: docs.aws.amazon.com/eks/latest/userguide/service-accounts.html [2]: docs.aws.amazon.com/eks/latest/userguide/associate-service-account-role.html [3]: kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

Returns:

  • (String) 


4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
 
# File 'lib/aws-sdk-batch/types.rb', line 4207

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#share_process_namespace ⇒ Boolean

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

[1]: kubernetes.io/docs/tasks/configure-pod-container/share-process-namespace/

Returns:

  • (Boolean) 


4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
 
# File 'lib/aws-sdk-batch/types.rb', line 4207

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#volumes ⇒ Array<Types::EksVolume>

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

Returns:



4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
 
# File 'lib/aws-sdk-batch/types.rb', line 4207

class EksPodProperties < Struct.new(
  :service_account_name,
  :host_network,
  :dns_policy,
  :image_pull_secrets,
  :containers,
  :init_containers,
  :volumes,
  :metadata,
  :share_process_namespace)
  SENSITIVE = []
  include Aws::Structure
end